List payment links
GET
/payment-linksLists the seller’s payment links. Returns the X-Total-Count header.
Header Parameters
Authorizationstringrequired
Bearer Token (JWT). x-seller-id, country, and tenant are extracted from the token.
Query Parameters
limitinteger
pageinteger
sortstring
sort_typestring
payment_typestring
statusstring
created_at_startstring
created_at_endstring
titlestring
expiration_startstring
expiration_endstring
Response
List of payment links
link_idstring<uuid>
short_idstring
seller_idstring<uuid>
labelstring
expirationstring<date-time>
max_ordersinteger
type"custom" | "unique"
successful_salesinteger
request_delivery_addressboolean
shipping_amountinteger
productsobject[]
paymentobject
Payment methods configuration. At least one method must be enabled (enabled: true).
Availability by country:
| Method | BR | MX | AR | CL | ES | UY |
|---|---|---|---|---|---|---|
| credit | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| debit | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| bankslip | ✓ | — | — | — | — | — |
| instant_payment | ✓ | — | — | — | — | — |
| google_pay | ✓ | — | — | — | — | — |
| apple_pay | ✓ | — | — | — | — | — |
| c2p_master | — | — | ✓ | — | — | — |
status"ACTIVE" | "INACTIVE" | "EXPIRED"
created_atstring<date-time>
updated_atstring<date-time>
currencystring
ISO 4217 code (3 letters). Main ones: BRL, ARS, CLP, MXN, EUR, UYU, USD, COP, PEN
Bad request - validation error
error_codestring
messagestring
detailsobject[]
status_codeinteger
Unprocessable entity
error_codestring
messagestring
status_codeinteger
Internal server error
error_codestring
messagestring
status_codeinteger
English › Documentation › API Reference › Payments › Payment Link API › Payment Links