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 being sold and how it can be paid, and 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 (available in all supported countries), as well as Boleto, Pix, Google Pay, and Apple Pay (in Brazil). Which methods are available depends on the seller's country — see Supported payment methods.

Key concepts

  • Payment Link — the shareable URL tied to a product catalog and a payment configuration.
  • Custom Link (type: custom) — 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 maintains a transition history.
  • Short ID — a compact, public identifier that appears in the link URL. The shopper's checkout frontend retrieves the link using it, via 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 search by short ID.
  • Orders and Receipts — list and retrieve orders for a link and get the receipt for an order (read-only).
  • Business Configurations — save and retrieve a reusable base configuration (default methods, expiration, currency) to speed up the creation of new links.
  • Sellers — retrieve the seller profile, with enabled services and payment methods.
  • Images — upload product images and retrieve them by identifier.

Authentication

Access uses OAuth 2.0 Client Credentials. The seller exchanges client_id and client_secret for a token, which is sent in the Authorization header of requests. Seller, country, and tenant information come from the token itself, not from separate headers. The only access exception is retrieving a link by short ID, which is public. See Authentication.

Next steps

On this page

Payment Link API Overview