Skip to content

A payment link is a Flute-hosted, shareable checkout page.

This payment link directs customers to a checkout page where they complete the payment. The merchant does not need to build the checkout user interface, its dialog, or embed any checkout flow. No POS terminal and no custom integration are required. A payment link can be texted or emailed to a customer directly.

It may be set up as a one-time payment or as a standing "pay us" page for repeat use. Merchants choose between:

  • SingleUse, a link tied to a specific invoice or order, which closes itself out after that one payment.
  • MultiUse, a link that keeps accepting payments from the same or different customers indefinitely.

Every link moves through a simple lifecycle — Active, Inactive, Expired, or Completed. Flute tracks how many payments it's received and the total collected, so the merchant always knows how a given link is performing.

A payment link is template-based. When a customer opens it, Flute auto-generates a short-lived payment session from the link's stored configuration. It then hands the customer to the hosted checkout page. That means the link itself never processes a payment directly. Six endpoints cover the resource. These include create, list, get, a JSON Merge Patch-style partial update, a soft delete, and a share-by-SMS-or-email action. Request and response fields cover the amount, currency, link type, customer, reference ID, name, description, and expiration. There are response-only fields such as short URL, payment count, and total collected amount.