Skip to main content
A payment link is a page that takes payment without an integration, by URL or by QR code. You send the link to the customer yourself. Payment transactions through a payment link send no webhook events, so step 4 polls.
The answer is 201, with the link at status: active, its checkout page and a qr_code of the page’s URL, usable in a plain <img>.
  • type is single_use, which is paid once, or reusable.
  • expires_at defaults to 7 days from now, and can be from 60 seconds to 1 year ahead.
  • success_url and failure_url are optional, as a pair.
  • Without is_test: true, the link is live, which answers 409 LIVE_PAYMENTS_NOT_ALLOWED for a merchant that isn’t live yet.
  • Make one Idempotency-Key for each link you mean to send, and store it with the invoice or order before you send the request. A retry with a new key makes a second link, which a customer can also pay. See Idempotency.
Unlike a payment transaction’s checkout, a link’s checkout and qr_code can be read again while the link is open, so you can print or resend them. Treat them as secrets all the same: anyone holding the URL can pay. Send checkout.url to the customer, by email or message, or show the QR code.

3. The Customer Pays

The customer opens the link, gives their details, chooses their bank and pays. Customer.

4. List the Link’s Payment Transactions

The list holds every attempt through the link, including abandoned and cancelled ones, newest first. For a test link, add is_test=true. Each payment transaction carries the link’s order.
view_count and first_viewed_at say whether the customer has opened the page.