Payment Link API Overview

The Payment Link API allows merchants (sellers) to create shareable payment URLs that buyers (shoppers) can use to complete a purchase.

Instead of integrating a full checkout, the seller creates a link, defines what is for sale and how the buyer can pay for it, and then shares the resulting URL.

Each link is tied to a product catalog and a payment configuration. Payment methods are configurable and include credit and debit cards, available in all supported countries. In Brazil, Boleto, Pix, Google Pay, and Apple Pay are also available.

The available methods depend on the seller's country. For details, see Supported payment methods.

Key concepts

  • Payment Link: the shareable URL tied to a product catalog and a payment configuration.
  • Custom Link (type: custom): a link with predefined products and fixed amounts. Requires the products list. This is the default type.
  • Order: the payment transaction created when a shopper pays through the link. An order has its own status lifecycle (pending, paid, approved, refunded, denied) and keeps a history of its status changes.
  • Short ID: a compact, public identifier that appears in the link URL. The shopper's checkout frontend uses the Short ID to retrieve the link from a public endpoint.
  • Seller: the merchant who creates and manages the links. Their identity and settings are derived from the authentication token.

How the API is organized

The API groups its operations into several sets:

  • Payment Links: create, list, retrieve, update (PUT/PATCH), and look up by short ID.
  • Orders and Receipts: list and retrieve a link's orders, and get an order's receipt. These operations are read-only.
  • Business Configurations: save and retrieve a reusable base configuration (default methods, expiration, currency) so you can create new links faster.
  • Sellers: retrieve the seller profile, including its enabled services and payment methods.
  • Images: upload product images and retrieve them by identifier.

Authentication

The API uses the OAuth 2.0 Client Credentials flow. You exchange your client_id and client_secret for a token and send it in the Authorization header of each request. Seller, country, and tenant information comes from the token itself, not from separate headers. The only exception is the endpoint that retrieves a link by short ID. This endpoint is public and doesn't require a token. See Authentication.

See also

On this page

Payment Link API Overview