{"templateId":"markdown","versions":[{"version":"v1","label":"v1","link":"/api-reference/v1/components/docs/payment-links","default":true,"active":false,"folderId":"1b9c9f54"},{"version":"v2","label":"v2 (Beta)","link":"/api-reference/v2/components/docs/payment-links","default":false,"active":true,"folderId":"1b9c9f54"}],"sharedDataIds":{},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Flute Developer","siteUrl":"https://developer.flute.com","description":"Documentation and API reference for integrating Flute payment processing.","lang":"en-US"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"id":"payment-links-overview"},"children":[]}," ","A payment link is a URL or QR code that opens a secure checkout page."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This checkout page is where customers complete the payment."," ","A payment link can be shared with a customer by texting or emailing the link URL directly."," ","This  hands the customer to the hosted checkout page."," ","That means the link itself never processes a payment directly."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This page is created by Flute automatically."," ","When a customer opens it, Flute auto-generates a short-lived payment session from the link's stored configuration."," ","The merchant themselves do not need to build the checkout page, the user interface, its dialog, or embed any checkout flow."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["No POS terminal or custom integration are required."," ","However, the checkout page may be customized by the client to match their branding  look and feel."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["It may be set up as a one-time payment or as a standing \"pay us\" page for repeat use."," ","Merchants choose between:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SingleUse"]},", a link tied to a specific invoice or order, which closes itself out after that one payment."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MultiUse"]},", a link that keeps accepting payments from the same or different customers indefinitely."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Every link moves through statuses."," ","A payment link may be:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Active"]},", able to accept new a new payment."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Completed"]}," a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SingleUse"]}," payment link having already successfully accepted a payment."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A payment link may be:"," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Inactive"]},", a payment link that has been explicitly deactivated, and so, not capable to accepting new payments."," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Expired"]},", a payment link that has expired because of a time limitation imposed on it during its creation."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Flute tracks how many payments it's received and the total collected."," ","This allows the merchant to always knows how any specified link is performing."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following endpoints are available."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Endpoint"},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Explanation"},"children":["Explanation"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/payment-links"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Creates a new payment link. Accepts amount, currency, link type, customer, reference ID, name, description, and expiration; returns the full link record including its ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shortUrl"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/payment-links"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Lists payment links for the authenticated merchant. Returns a paginated set, filterable by search string, link type, and status, and sortable via ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sortBy"]},"/",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sortOrder"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/payment-links/{paymentLinkId}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Retrieves a single payment link by its identifier."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["PATCH"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/payment-links/{paymentLinkId}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Partially updates a payment link (JSON Merge Patch-style). Only the fields sent are changed; an omitted field is left as-is, and a field explicitly set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["null"]}," clears it. Returns the full updated link."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["DELETE"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/payment-links/{paymentLinkId}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Deletes (soft-deletes) a payment link. Returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["204 No Content"]}," on success."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/payment-links/{paymentLinkId}/share"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Shares an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Active"]}," payment link with a customer by SMS or email, sending the link's URL to the given recipient. Requires the customer's consent to receive the message."]}]}]}]}]}]},"headings":[],"frontmatter":{"seo":{"title":""}},"lastModified":"2026-09-06T00:26:58.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/api-reference/v2/components/docs/payment-links","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}