The Payments API lets you initiate, track, and manage the lifecycle of a payment — from defining the flow to receiving real-time updates.
Objects
Payment object
Unique identifier for the internal service.
External reference identifier for integrations.
Identifier linking the transaction to a specific user or organization.
External reference identifier for the identity associated with the transaction.
The account number involved in the transaction.
The total amount of the transaction.
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.
A brief description of the transaction.
The product or service related to the transaction. purchaseCurrency:Currency
The current status of the transaction (e.g., PENDING, AUTHORIZED, CAPTURED, ATTEMPT, REFUNDED).
PURCHASETOPUP_ACCOUNTWITHDRAWAL_ACCOUNTP2PCOLLECTFEEREMITTANCEThe amount paid in the transaction.
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.
A list of fees associated with the transaction.
namestringrequiredThe name of the fee.
typestringrequiredFIXEDPERCENTAGEvaluestringrequiredThe value of the fee.
amountstringrequiredThe calculated amount of the fee.
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.
Timestamp indicating when the transaction was created.
Timestamp indicating the last update to the transaction.
Timestamp indicating when the transaction expires, if applicable.
Timestamp indicating when the transaction was captured.
Timestamp indicating when the transaction was authorized.
Timestamp indicating when the transaction was refunded, if applicable.
A list of sources for the transaction.
namestringThe name of the source or destination of the transaction.
typestringrequiredCARDRepresents a card payment. Opens the card node.CRYPTOCryptocurrency wallet rail (global). Supports both pay-in and pay-out flows. Opens the wallet node.ACCOUNTRepresents an internal platform account. Opens the account node.BANK_ACCOUNTGeneric external bank account for payouts. Opens the bank node.PIXPIX QR code or copy-paste code in Brazil (BRL). Opens the pix node.PCTInteroperable QR payment in Argentina (ARS) under BCRA PCT standard. Opens the pct node.CVUVirtual account / CBU bank transfer pay-in in Argentina (ARS). Opens the cvu node.ETPAYOpen banking pay-in for Chile (CLP) via Etpay. Opens the etpay node.FINTOCOpen banking pay-in for Chile (CLP) via Fintoc widget. Opens the fintoc node.WEBPAYCard payment in Chile (CLP) via Transbank. Opens the webpay node.SPEIElectronic Interbank Payment System for Mexico (MXN). Opens the spei node.PSEOnline secure bank transfer pay-in for Colombia (COP). Opens the pse node.BANCOLOMBIABancolombia direct payment pay-in for Colombia (COP). Opens the bancolombia node.DAVIVIENDADavivienda direct payment pay-in for Colombia (COP). Opens the davivienda node.DAVIPLATADaviplata mobile wallet for Colombia (COP). Opens the daviplata node.NEQUINequi digital wallet for Colombia (COP). Opens the nequi node.BREBBank account transfer payout for Colombia (COP). Opens the breb node.WOMPIWompi payment gateway pay-in for Colombia (COP). Opens the wompi node.LIGOQR-based payment system pay-in for Peru (PEN). Opens the ligo node.SIPInteroperable payment system for Peru (PEN) and Bolivia (BOB). Opens the sip node.ACHAutomated Clearing House bank transfers for USA (USD). Opens the ach node.WIREWire transfer via correspondent banks for USA (USD). Opens the wire node.FEDNOWFedNow instant payment service for USA (USD). Opens the fedNow node.RTPReal-time payments network pay-in for USA (USD). Opens the rtp node.SEPASingle Euro Payments Area payout for Europe (EUR). Opens the sepa node.FPEFaster Payments near-instant bank transfer payout for UK (GBP). Opens the fpe node.SWIFTInternational bank wire transfer rail (global). Pay-out only. Opens the swift node.externalIdstringExternal reference identifier for integrations.
amountstringThe amount involved in the transaction.
amountOutstringCalculated amount - fees
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.
settlementstringIndicates the settlement period.
feeobjectDetails about any fees applied to the transaction.
namestringrequiredThe name of the fee.
typestringrequiredFIXEDPERCENTAGEvaluestringrequiredThe value of the fee.
amountstringrequiredThe calculated amount of the fee.
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.
identityobjectThe entity associated with the source or destination.
namestringThe name of the entity (for users) or the official name (for organizations).
documentNumberstringThe document number associated with the entity for identification purposes.
externalIdstringExternal reference ID (client purpose).
lastnamestringThe last name of the user (if applicable).
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.
One of
cardobjectrequiredA list of destinations for the transaction.
namestringThe name of the source or destination of the transaction.
typestringrequiredCARDRepresents a card payment. Opens the card node.CRYPTOCryptocurrency wallet rail (global). Supports both pay-in and pay-out flows. Opens the wallet node.ACCOUNTRepresents an internal platform account. Opens the account node.BANK_ACCOUNTGeneric external bank account for payouts. Opens the bank node.PIXPIX QR code or copy-paste code in Brazil (BRL). Opens the pix node.PCTInteroperable QR payment in Argentina (ARS) under BCRA PCT standard. Opens the pct node.CVUVirtual account / CBU bank transfer pay-in in Argentina (ARS). Opens the cvu node.ETPAYOpen banking pay-in for Chile (CLP) via Etpay. Opens the etpay node.FINTOCOpen banking pay-in for Chile (CLP) via Fintoc widget. Opens the fintoc node.WEBPAYCard payment in Chile (CLP) via Transbank. Opens the webpay node.SPEIElectronic Interbank Payment System for Mexico (MXN). Opens the spei node.PSEOnline secure bank transfer pay-in for Colombia (COP). Opens the pse node.BANCOLOMBIABancolombia direct payment pay-in for Colombia (COP). Opens the bancolombia node.DAVIVIENDADavivienda direct payment pay-in for Colombia (COP). Opens the davivienda node.DAVIPLATADaviplata mobile wallet for Colombia (COP). Opens the daviplata node.NEQUINequi digital wallet for Colombia (COP). Opens the nequi node.BREBBank account transfer payout for Colombia (COP). Opens the breb node.WOMPIWompi payment gateway pay-in for Colombia (COP). Opens the wompi node.LIGOQR-based payment system pay-in for Peru (PEN). Opens the ligo node.SIPInteroperable payment system for Peru (PEN) and Bolivia (BOB). Opens the sip node.ACHAutomated Clearing House bank transfers for USA (USD). Opens the ach node.WIREWire transfer via correspondent banks for USA (USD). Opens the wire node.FEDNOWFedNow instant payment service for USA (USD). Opens the fedNow node.RTPReal-time payments network pay-in for USA (USD). Opens the rtp node.SEPASingle Euro Payments Area payout for Europe (EUR). Opens the sepa node.FPEFaster Payments near-instant bank transfer payout for UK (GBP). Opens the fpe node.SWIFTInternational bank wire transfer rail (global). Pay-out only. Opens the swift node.externalIdstringExternal reference identifier for integrations.
amountstringThe amount involved in the transaction.
amountOutstringCalculated amount - fees
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.
settlementstringIndicates the settlement period.
feeobjectDetails about any fees applied to the transaction.
namestringrequiredThe name of the fee.
typestringrequiredFIXEDPERCENTAGEvaluestringrequiredThe value of the fee.
amountstringrequiredThe calculated amount of the fee.
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.
identityobjectThe entity associated with the source or destination.
namestringThe name of the entity (for users) or the official name (for organizations).
documentNumberstringThe document number associated with the entity for identification purposes.
externalIdstringExternal reference ID (client purpose).
lastnamestringThe last name of the user (if applicable).
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.
One of
cardobjectrequiredSettlement period for the transaction.
Payment node object
The name of the source or destination of the transaction.
CARDCRYPTOACCOUNTBANK_ACCOUNTPIXPCTCVUETPAYFINTOCWEBPAYSPEIPSEBANCOLOMBIADAVIVIENDADAVIPLATANEQUIBREBWOMPILIGOSIPACHWIREFEDNOWRTPSEPAFPESWIFTExternal reference identifier for integrations.
The amount involved in the transaction.
Calculated amount - fees
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.
Indicates the settlement period.
Details about any fees applied to the transaction.
namestringrequiredThe name of the fee.
typestringrequiredFIXEDPERCENTAGEvaluestringrequiredThe value of the fee.
amountstringrequiredThe calculated amount of the fee.
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.
The entity associated with the source or destination.
namestringThe name of the entity (for users) or the official name (for organizations).
documentNumberstringThe document number associated with the entity for identification purposes.
externalIdstringExternal reference ID (client purpose).
lastnamestringThe last name of the user (if applicable).
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.
Fee object
The name of the fee.
FIXEDPERCENTAGEThe value of the fee.
The 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.