Payment links are shareable URLs that allow payers to complete a payment without requiring a direct API integration.
Objects
Payment link object
Unique identifier for the internal service.
Reference for checkout url
ATTEMPTACTIVEEXPIREDFINISHEDPROCESSING_PAYMENTList of items to pay for
preTaxAmountstringrequiredThe amount of the item
totalAmountstringrequiredamount + tax.amount, if no tax it's equal to amount
descriptionstringrequiredThe description of the item
taxobjectnullablenamestringrequiredThe name of the fee.
typestringrequiredFIXEDPERCENTAGEvaluestringrequiredThe value of the fee.
amountstringrequiredThe calculated amount of the fee.
Specifies the currency used, following the ISO 4217 standard for fiat currencies (e.g., CLP, ARS, MXN). Go to the currencies page for the complete list of supported values.
Addition of all items preTaxAmounts
Addition of all items totalAmounts
Url to open checkout flow
Allowed payment methods.
Optional customer to pass into the checkout session
idstringUnique identifier for the internal service.
firstNamestringPayer's name
emailstringPayer's email
lastNamestringPayer's last name
phoneNumberstringPayer's phone number without prefix
phoneNumberPrefixstringPhone number prefix (e.g., +57)
documentTypestringDocumeny type of the entity (e.g., RUT, CURP, CURL). Go to the Supported Identity document types page for the complete list of supported values.
documentNumberstringThe document number associated with the documentType
addressobjectThe entity’s address information.
administrativeAreaLevel1stringThe first-level administrative division.
administrativeAreaLevel2stringThe second-level administrative division.
administrativeAreaLevel3stringThe third-level administrative division.
streetstringThe name of the street.
streetNumberstringThe street number.
optionalAddressstringAdditional address details.
countrystringCountry of operations for the entity, specified using the ISO 3166-1 alpha-3 standard (e.g., CHL, USA, MEX). Go to the countries page for the complete list of supported values.
zipcodestringZipcode f the address
When the link expires
A list of destinations for the transaction.
namestringThe name of the source or destination of the transaction.
typestringrequiredACCOUNTexternalIdstringExternal reference identifier for integrations.
amountstringrequiredThe amount involved in the transaction.
metadataobjectAdditional metadata related to the transaction source or destination.
imagestringrequiredAn image representing the source or destination.
descriptionstringrequiredA brief description of the source or destination.
categorystringrequiredThe category or grouping of the source or destination.
accountobjectrequiredtypestringrequiredCHECKINGFiat liquid account used for spending, withdrawals, or operations.ASSETTracks non-operational or financial assets.SAVINGSHolds funds intended for savings or long-term storage.ESCROWTemporary routing account for incoming funds.FEEHolds all fees collected via FEE or FEE_INVOICE.currencystringrequiredSpecifies the currency used, following the ISO 4217 standard for fiat currencies (e.g., CLP, ARS, MXN). Go to the currencies page for the complete list of supported values.
accountNumberstringrequiredInternal reference number for the account.
accountHolderstringrequiredName of the entity or user owning the internal account.
Amount of seconds for payment link to be inactivated after creation
Identity reference object used inside account nodes.
identityIdstringrequiredUser unique identifier
namestringUser name
lastnamestringUser lastname
nicknamestringUser nickname
documentNumberstringUser DNI
entityTypestringEntity type of identity
The URL to which the end user will be redirected after successful payment completion.
The URL to which the end user will be redirected after failed payment or cancellation.
Payment link destination object
The name of the source or destination of the transaction.
ACCOUNTExternal reference identifier for integrations.
The amount involved in the transaction.
Additional metadata related to the transaction source or destination.
imagestringrequiredAn image representing the source or destination.
descriptionstringrequiredA brief description of the source or destination.
categorystringrequiredThe category or grouping of the source or destination.
typestringrequiredCHECKINGFiat liquid account used for spending, withdrawals, or operations.ASSETTracks non-operational or financial assets.SAVINGSHolds funds intended for savings or long-term storage.ESCROWTemporary routing account for incoming funds.FEEHolds all fees collected via FEE or FEE_INVOICE.currencystringrequiredSpecifies the currency used, following the ISO 4217 standard for fiat currencies (e.g., CLP, ARS, MXN). Go to the currencies page for the complete list of supported values.
accountNumberstringrequiredInternal reference number for the account.
accountHolderstringrequiredName of the entity or user owning the internal account.