Creates a payment attempt to pre-validate and initialize a payment flow.
/payment-attemptsHeaders
Bearer access token returned by the authentication endpoint.
The API key used for authentication when making requests to the API Gateway.
API version selector for Conomy endpoints. Use 24-04-2025 for the current version.
Identifies the application making the request.
Request body
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.
Final/destination amount mode. Send either totalAmount or purchaseAmount, never both.
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
PURCHASETOPUP_ACCOUNTWITHDRAWAL_ACCOUNTP2PCOLLECTFEEREMITTANCESource/customer-entered amount mode. Send either purchaseAmount or totalAmount, never both.
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 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 for Argentina (ARS). Supports pay-in (static or dynamic CVU allocation) and pay-out (provide recipient CVU code). 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.
amountOutstringNet amount after all fees have been deducted from this node. Equal to amount minus fee.amount.
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
holderstringCard holder full name
schemestringCard scheme
typestringCard type
maskstringLast 4 digits
countrystringIssuing country
tokenstringrequiredCard token
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.
accountNumberstringrequiredThe bank account number.
bankstringrequiredThe name of the bank where the account is held.
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.
typeAccountstringType of bank account. Accepted values: CHECKING, SAVINGS.
accountHolderstringrequiredThe full name of the account holder.
accountHolderDnistringrequiredThe national identification number or tax ID of the account holder.
countrystringrequiredCountry 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.
providerstringOptional wallet provider identifier (for routing/integration).
referenceIdstringOptional external wallet identifier in the provider system.
tokenstringOptional token symbol (e.g., USDC, USDT) when not implied by currency.
networkstringOptional blockchain network (e.g., ETH, TRON, SOLANA).
addressstringrequiredWallet's address
datastringrequiredThe actual PIX code (EMV-compliant string) that represents the payment. This is what is known as the 'PIX' in Brazil and can be copied and pasted instead of scanning.
qrCodestringThe rendered QR code string that can be scanned for PIX payments.
expiredAtstringdate-timeThe expiration date and time of the QR code. UTC format.
instructionsstringOptional instructions displayed to the user for completing the PIX payment.
customerobjectrequiredDetails of the customer initiating the payment.
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
successUrlstringRedirect url in case of success
failedUrlstringRedirect url in case of failure
qrCodestringThe QR code string that can be rendered or scanned for interoperable transfer payments in Argentina under the BCRA's PCT (Transfer QR) standard.
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
successUrlstringRedirect url in case of success
failedUrlstringRedirect url in case of failure
customerobjectInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
urlstringredirectUrlstringdeprecatedexpiresAtstringtimetokenstringsignatureTokenstringsuccessUrlstringRedirect url in case of success
failedUrlstringRedirect url in case of failure
customerobjectInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
successUrlstringRedirect URL on successful payment.
failedUrlstringRedirect URL on failed payment.
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
successUrlstringRedirect URL on successful payment.
failedUrlstringRedirect URL on failed payment.
wompiobjectWompi gateway payload for Colombia pay-ins.
customerobjectInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
urlstringredirectUrlstringexpiresAtstringtokenstringsignatureTokenstringbankIdstringrequiredBank identifier for PSE transfer.
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
successUrlstringRedirect URL on successful payment.
failedUrlstringRedirect URL on failed payment.
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
successUrlstringRedirect URL on successful payment.
failedUrlstringRedirect URL on failed payment.
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
successUrlstringRedirect URL on successful payment.
failedUrlstringRedirect URL on failed payment.
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
successUrlstringRedirect URL on successful payment.
failedUrlstringRedirect URL on failed payment.
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
successUrlstringRedirect URL on successful payment.
failedUrlstringRedirect URL on failed payment.
bankIdstringrequiredBank identifier for the recipient's account.
accountNumberstringrequiredRecipient's bank account number.
accountTypestringCHECKINGSAVINGScustomerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
codestringThe CVU code for this node. Required when CVU is used as a destination (pay-out) — provide the recipient's CVU number. For pay-in in dynamic mode, omit this field — the platform allocates a unique code per payment attempt and returns it here in the response. In static pay-in mode, this field carries the fixed CVU pre-assigned to the identity; retrieve it with GET /payment-origins and send it in the CVU origin when creating the static CVU payment.
customerobjectInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
clabestringrequiredCLABE (18-digit interbank code) of the recipient. Required for pay-out.
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
successUrlstringRedirect URL on successful payment.
failedUrlstringRedirect URL on failed payment.
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
successUrlstringRedirect URL on successful payment.
failedUrlstringRedirect URL on failed payment.
routingNumberstringrequiredABA routing number (9 digits).
accountNumberstringrequiredBank account number.
accountTypestringCHECKINGSAVINGScustomerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
swiftCodestringrequiredSWIFT/BIC code of the recipient's bank.
routingNumberstringABA routing number (9 digits).
accountNumberstringrequiredRecipient's bank account number.
bankNamestringName of the recipient's bank.
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
routingNumberstringrequiredABA routing number (9 digits).
accountNumberstringrequiredBank account number.
accountTypestringCHECKINGSAVINGScustomerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
routingNumberstringrequiredABA routing number (9 digits).
accountNumberstringrequiredBank account number.
accountTypestringCHECKINGSAVINGScustomerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
ibanstringrequiredRecipient's IBAN.
bicstringBIC/SWIFT code of the recipient's bank.
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
accountNumberstringrequiredUK bank account number (8 digits).
sortCodestringrequiredSort code (6 digits, e.g., "200415").
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
swiftCodestringrequiredSWIFT/BIC code of the recipient's bank.
ibanstringRecipient IBAN when destination country requires it (typically SEPA zone).
bankobjectrequiredRecipient bank account details.
accountNumberstringrequiredRecipient's bank account number.
namestringName of the recipient's bank.
customerobjectrequiredBeneficiary identity data required by correspondent banks.
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer's name
emailstringrequiredPayer's email
lastNamestringrequiredPayer's last name
phoneNumberstringPayer's phone number without prefix
phoneNumberPrefixstringPhone number prefix (e.g., +57)
documentTypestringrequiredDocumeny type of the entity (e.g., RUT, CURP, CURL). Go to the Supported Identity document types page for the complete list of supported values.
documentNumberstringrequiredThe 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
A 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 for Argentina (ARS). Supports pay-in (static or dynamic CVU allocation) and pay-out (provide recipient CVU code). 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.
amountOutstringNet amount after all fees have been deducted from this node. Equal to amount minus fee.amount.
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
holderstringCard holder full name
schemestringCard scheme
typestringCard type
maskstringLast 4 digits
countrystringIssuing country
tokenstringrequiredCard token
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.
accountNumberstringrequiredThe bank account number.
bankstringrequiredThe name of the bank where the account is held.
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.
typeAccountstringType of bank account. Accepted values: CHECKING, SAVINGS.
accountHolderstringrequiredThe full name of the account holder.
accountHolderDnistringrequiredThe national identification number or tax ID of the account holder.
countrystringrequiredCountry 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.
providerstringOptional wallet provider identifier (for routing/integration).
referenceIdstringOptional external wallet identifier in the provider system.
tokenstringOptional token symbol (e.g., USDC, USDT) when not implied by currency.
networkstringOptional blockchain network (e.g., ETH, TRON, SOLANA).
addressstringrequiredWallet's address
datastringrequiredThe actual PIX code (EMV-compliant string) that represents the payment. This is what is known as the 'PIX' in Brazil and can be copied and pasted instead of scanning.
qrCodestringThe rendered QR code string that can be scanned for PIX payments.
expiredAtstringdate-timeThe expiration date and time of the QR code. UTC format.
instructionsstringOptional instructions displayed to the user for completing the PIX payment.
customerobjectrequiredDetails of the customer initiating the payment.
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
successUrlstringRedirect url in case of success
failedUrlstringRedirect url in case of failure
qrCodestringThe QR code string that can be rendered or scanned for interoperable transfer payments in Argentina under the BCRA's PCT (Transfer QR) standard.
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
successUrlstringRedirect url in case of success
failedUrlstringRedirect url in case of failure
customerobjectInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
urlstringredirectUrlstringdeprecatedexpiresAtstringtimetokenstringsignatureTokenstringsuccessUrlstringRedirect url in case of success
failedUrlstringRedirect url in case of failure
customerobjectInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
successUrlstringRedirect URL on successful payment.
failedUrlstringRedirect URL on failed payment.
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
successUrlstringRedirect URL on successful payment.
failedUrlstringRedirect URL on failed payment.
wompiobjectWompi gateway payload for Colombia pay-ins.
customerobjectInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
urlstringredirectUrlstringexpiresAtstringtokenstringsignatureTokenstringbankIdstringrequiredBank identifier for PSE transfer.
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
successUrlstringRedirect URL on successful payment.
failedUrlstringRedirect URL on failed payment.
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
successUrlstringRedirect URL on successful payment.
failedUrlstringRedirect URL on failed payment.
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
successUrlstringRedirect URL on successful payment.
failedUrlstringRedirect URL on failed payment.
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
successUrlstringRedirect URL on successful payment.
failedUrlstringRedirect URL on failed payment.
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
successUrlstringRedirect URL on successful payment.
failedUrlstringRedirect URL on failed payment.
bankIdstringrequiredBank identifier for the recipient's account.
accountNumberstringrequiredRecipient's bank account number.
accountTypestringCHECKINGSAVINGScustomerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
codestringThe CVU code for this node. Required when CVU is used as a destination (pay-out) — provide the recipient's CVU number. For pay-in in dynamic mode, omit this field — the platform allocates a unique code per payment attempt and returns it here in the response. In static pay-in mode, this field carries the fixed CVU pre-assigned to the identity; retrieve it with GET /payment-origins and send it in the CVU origin when creating the static CVU payment.
customerobjectInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
clabestringrequiredCLABE (18-digit interbank code) of the recipient. Required for pay-out.
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
successUrlstringRedirect URL on successful payment.
failedUrlstringRedirect URL on failed payment.
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
successUrlstringRedirect URL on successful payment.
failedUrlstringRedirect URL on failed payment.
routingNumberstringrequiredABA routing number (9 digits).
accountNumberstringrequiredBank account number.
accountTypestringCHECKINGSAVINGScustomerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
swiftCodestringrequiredSWIFT/BIC code of the recipient's bank.
routingNumberstringABA routing number (9 digits).
accountNumberstringrequiredRecipient's bank account number.
bankNamestringName of the recipient's bank.
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
routingNumberstringrequiredABA routing number (9 digits).
accountNumberstringrequiredBank account number.
accountTypestringCHECKINGSAVINGScustomerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
routingNumberstringrequiredABA routing number (9 digits).
accountNumberstringrequiredBank account number.
accountTypestringCHECKINGSAVINGScustomerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
ibanstringrequiredRecipient's IBAN.
bicstringBIC/SWIFT code of the recipient's bank.
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
accountNumberstringrequiredUK bank account number (8 digits).
sortCodestringrequiredSort code (6 digits, e.g., "200415").
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
swiftCodestringrequiredSWIFT/BIC code of the recipient's bank.
ibanstringRecipient IBAN when destination country requires it (typically SEPA zone).
bankobjectrequiredRecipient bank account details.
accountNumberstringrequiredRecipient's bank account number.
namestringName of the recipient's bank.
customerobjectrequiredBeneficiary identity data required by correspondent banks.
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer's name
emailstringrequiredPayer's email
lastNamestringrequiredPayer's last name
phoneNumberstringPayer's phone number without prefix
phoneNumberPrefixstringPhone number prefix (e.g., +57)
documentTypestringrequiredDocumeny type of the entity (e.g., RUT, CURP, CURL). Go to the Supported Identity document types page for the complete list of supported values.
documentNumberstringrequiredThe 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
Responses
idstringrequiredUnique identifier for the internal service.
externalIdstringrequiredExternal reference identifier for integrations.
identityIdstringrequiredIdentifier linking the transaction to a specific user or organization.
identityExternalIdstringExternal reference identifier for the identity associated with the transaction.
accountNumberstringrequiredThe account number involved in the transaction.
totalAmountstringrequiredThe total amount of the transaction.
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.
descriptionstringA brief description of the transaction.
productstringThe product or service related to the transaction. purchaseCurrency:Currency
statusstringrequiredLifecycle state of the payment. Possible values: CREATED, AUTHORIZED, REQUIRES_REVIEW, CAPTURED, RECEIVED, SETTLED (terminal — success), FAILED, EXPIRED, UNSETTLED (terminal — error).
typestringrequiredPURCHASEPayment initiated by an external customer for goods or services.TOPUP_ACCOUNTA deposit of funds into an internal accountWITHDRAWAL_ACCOUNTFunds withdrawn from an internal account to an external bank account.P2PPull of funds from another internal account.COLLECTPull of funds from another internal account.FEEFee charged or collected within the system.REMITTANCECrossborder payment from an internal or external account to receipient in another country.purchaseAmountstringThe amount paid in the transaction.
purchaseCurrencystringSpecifies 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.
feesobject[]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.
createdAtstringrequiredTimestamp indicating when the transaction was created.
updatedAtstringrequiredTimestamp indicating the last update to the transaction.
expiresAtstringTimestamp indicating when the transaction expires, if applicable.
capturedAtstringTimestamp indicating when the transaction was captured.
authorizedAtstringTimestamp indicating when the transaction was authorized.
refundedAtstringTimestamp indicating when the transaction was refunded, if applicable.
originsoneOf[]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 for Argentina (ARS). Supports pay-in (static or dynamic CVU allocation) and pay-out (provide recipient CVU code). 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.
amountOutstringNet amount after all fees have been deducted from this node. Equal to amount minus fee.amount.
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
holderstringCard holder full name
schemestringCard scheme
typestringCard type
maskstringLast 4 digits
countrystringIssuing country
tokenstringrequiredCard token
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.
accountNumberstringrequiredThe bank account number.
bankstringrequiredThe name of the bank where the account is held.
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.
typeAccountstringType of bank account. Accepted values: CHECKING, SAVINGS.
accountHolderstringrequiredThe full name of the account holder.
accountHolderDnistringrequiredThe national identification number or tax ID of the account holder.
countrystringrequiredCountry 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.
providerstringOptional wallet provider identifier (for routing/integration).
referenceIdstringOptional external wallet identifier in the provider system.
tokenstringOptional token symbol (e.g., USDC, USDT) when not implied by currency.
networkstringOptional blockchain network (e.g., ETH, TRON, SOLANA).
addressstringrequiredWallet's address
datastringrequiredThe actual PIX code (EMV-compliant string) that represents the payment. This is what is known as the 'PIX' in Brazil and can be copied and pasted instead of scanning.
qrCodestringThe rendered QR code string that can be scanned for PIX payments.
expiredAtstringdate-timeThe expiration date and time of the QR code. UTC format.
instructionsstringOptional instructions displayed to the user for completing the PIX payment.
customerobjectrequiredDetails of the customer initiating the payment.
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
successUrlstringRedirect url in case of success
failedUrlstringRedirect url in case of failure
qrCodestringThe QR code string that can be rendered or scanned for interoperable transfer payments in Argentina under the BCRA's PCT (Transfer QR) standard.
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
successUrlstringRedirect url in case of success
failedUrlstringRedirect url in case of failure
customerobjectInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
urlstringredirectUrlstringdeprecatedexpiresAtstringtimetokenstringsignatureTokenstringsuccessUrlstringRedirect url in case of success
failedUrlstringRedirect url in case of failure
customerobjectInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
successUrlstringRedirect URL on successful payment.
failedUrlstringRedirect URL on failed payment.
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
successUrlstringRedirect URL on successful payment.
failedUrlstringRedirect URL on failed payment.
wompiobjectWompi gateway payload for Colombia pay-ins.
customerobjectInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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.
urlstringredirectUrlstringexpiresAtstringtokenstringsignatureTokenstringbankIdstringrequiredBank identifier for PSE transfer.
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
successUrlstringRedirect URL on successful payment.
failedUrlstringRedirect URL on failed payment.
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
successUrlstringRedirect URL on successful payment.
failedUrlstringRedirect URL on failed payment.
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
successUrlstringRedirect URL on successful payment.
failedUrlstringRedirect URL on failed payment.
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
successUrlstringRedirect URL on successful payment.
failedUrlstringRedirect URL on failed payment.
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
successUrlstringRedirect URL on successful payment.
failedUrlstringRedirect URL on failed payment.
bankIdstringrequiredBank identifier for the recipient's account.
accountNumberstringrequiredRecipient's bank account number.
accountTypestringCHECKINGSAVINGScustomerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
codestringThe CVU code for this node. Required when CVU is used as a destination (pay-out) — provide the recipient's CVU number. For pay-in in dynamic mode, omit this field — the platform allocates a unique code per payment attempt and returns it here in the response. In static pay-in mode, this field carries the fixed CVU pre-assigned to the identity; retrieve it with GET /payment-origins and send it in the CVU origin when creating the static CVU payment.
customerobjectInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
clabestringrequiredCLABE (18-digit interbank code) of the recipient. Required for pay-out.
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
successUrlstringRedirect URL on successful payment.
failedUrlstringRedirect URL on failed payment.
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
successUrlstringRedirect URL on successful payment.
failedUrlstringRedirect URL on failed payment.
routingNumberstringrequiredABA routing number (9 digits).
accountNumberstringrequiredBank account number.
accountTypestringCHECKINGSAVINGScustomerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
swiftCodestringrequiredSWIFT/BIC code of the recipient's bank.
routingNumberstringABA routing number (9 digits).
accountNumberstringrequiredRecipient's bank account number.
bankNamestringName of the recipient's bank.
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
routingNumberstringrequiredABA routing number (9 digits).
accountNumberstringrequiredBank account number.
accountTypestringCHECKINGSAVINGScustomerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
routingNumberstringrequiredABA routing number (9 digits).
accountNumberstringrequiredBank account number.
accountTypestringCHECKINGSAVINGScustomerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
ibanstringrequiredRecipient's IBAN.
bicstringBIC/SWIFT code of the recipient's bank.
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
accountNumberstringrequiredUK bank account number (8 digits).
sortCodestringrequiredSort code (6 digits, e.g., "200415").
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
swiftCodestringrequiredSWIFT/BIC code of the recipient's bank.
ibanstringRecipient IBAN when destination country requires it (typically SEPA zone).
bankobjectrequiredRecipient bank account details.
accountNumberstringrequiredRecipient's bank account number.
namestringName of the recipient's bank.
customerobjectrequiredBeneficiary identity data required by correspondent banks.
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer's name
emailstringrequiredPayer's email
lastNamestringrequiredPayer's last name
phoneNumberstringPayer's phone number without prefix
phoneNumberPrefixstringPhone number prefix (e.g., +57)
documentTypestringrequiredDocumeny type of the entity (e.g., RUT, CURP, CURL). Go to the Supported Identity document types page for the complete list of supported values.
documentNumberstringrequiredThe 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
destinationsoneOf[]A 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 for Argentina (ARS). Supports pay-in (static or dynamic CVU allocation) and pay-out (provide recipient CVU code). 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.
amountOutstringNet amount after all fees have been deducted from this node. Equal to amount minus fee.amount.
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
holderstringCard holder full name
schemestringCard scheme
typestringCard type
maskstringLast 4 digits
countrystringIssuing country
tokenstringrequiredCard token
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.
accountNumberstringrequiredThe bank account number.
bankstringrequiredThe name of the bank where the account is held.
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.
typeAccountstringType of bank account. Accepted values: CHECKING, SAVINGS.
accountHolderstringrequiredThe full name of the account holder.
accountHolderDnistringrequiredThe national identification number or tax ID of the account holder.
countrystringrequiredCountry 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.
providerstringOptional wallet provider identifier (for routing/integration).
referenceIdstringOptional external wallet identifier in the provider system.
tokenstringOptional token symbol (e.g., USDC, USDT) when not implied by currency.
networkstringOptional blockchain network (e.g., ETH, TRON, SOLANA).
addressstringrequiredWallet's address
datastringrequiredThe actual PIX code (EMV-compliant string) that represents the payment. This is what is known as the 'PIX' in Brazil and can be copied and pasted instead of scanning.
qrCodestringThe rendered QR code string that can be scanned for PIX payments.
expiredAtstringdate-timeThe expiration date and time of the QR code. UTC format.
instructionsstringOptional instructions displayed to the user for completing the PIX payment.
customerobjectrequiredDetails of the customer initiating the payment.
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
successUrlstringRedirect url in case of success
failedUrlstringRedirect url in case of failure
qrCodestringThe QR code string that can be rendered or scanned for interoperable transfer payments in Argentina under the BCRA's PCT (Transfer QR) standard.
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
successUrlstringRedirect url in case of success
failedUrlstringRedirect url in case of failure
customerobjectInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
urlstringredirectUrlstringdeprecatedexpiresAtstringtimetokenstringsignatureTokenstringsuccessUrlstringRedirect url in case of success
failedUrlstringRedirect url in case of failure
customerobjectInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
successUrlstringRedirect URL on successful payment.
failedUrlstringRedirect URL on failed payment.
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
successUrlstringRedirect URL on successful payment.
failedUrlstringRedirect URL on failed payment.
wompiobjectWompi gateway payload for Colombia pay-ins.
customerobjectInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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.
urlstringredirectUrlstringexpiresAtstringtokenstringsignatureTokenstringbankIdstringrequiredBank identifier for PSE transfer.
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
successUrlstringRedirect URL on successful payment.
failedUrlstringRedirect URL on failed payment.
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
successUrlstringRedirect URL on successful payment.
failedUrlstringRedirect URL on failed payment.
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
successUrlstringRedirect URL on successful payment.
failedUrlstringRedirect URL on failed payment.
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
successUrlstringRedirect URL on successful payment.
failedUrlstringRedirect URL on failed payment.
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
successUrlstringRedirect URL on successful payment.
failedUrlstringRedirect URL on failed payment.
bankIdstringrequiredBank identifier for the recipient's account.
accountNumberstringrequiredRecipient's bank account number.
accountTypestringCHECKINGSAVINGScustomerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
codestringThe CVU code for this node. Required when CVU is used as a destination (pay-out) — provide the recipient's CVU number. For pay-in in dynamic mode, omit this field — the platform allocates a unique code per payment attempt and returns it here in the response. In static pay-in mode, this field carries the fixed CVU pre-assigned to the identity; retrieve it with GET /payment-origins and send it in the CVU origin when creating the static CVU payment.
customerobjectInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
clabestringrequiredCLABE (18-digit interbank code) of the recipient. Required for pay-out.
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
successUrlstringRedirect URL on successful payment.
failedUrlstringRedirect URL on failed payment.
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
successUrlstringRedirect URL on successful payment.
failedUrlstringRedirect URL on failed payment.
routingNumberstringrequiredABA routing number (9 digits).
accountNumberstringrequiredBank account number.
accountTypestringCHECKINGSAVINGScustomerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
swiftCodestringrequiredSWIFT/BIC code of the recipient's bank.
routingNumberstringABA routing number (9 digits).
accountNumberstringrequiredRecipient's bank account number.
bankNamestringName of the recipient's bank.
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
routingNumberstringrequiredABA routing number (9 digits).
accountNumberstringrequiredBank account number.
accountTypestringCHECKINGSAVINGScustomerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
routingNumberstringrequiredABA routing number (9 digits).
accountNumberstringrequiredBank account number.
accountTypestringCHECKINGSAVINGScustomerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
ibanstringrequiredRecipient's IBAN.
bicstringBIC/SWIFT code of the recipient's bank.
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
accountNumberstringrequiredUK bank account number (8 digits).
sortCodestringrequiredSort code (6 digits, e.g., "200415").
customerobjectrequiredInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer'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
swiftCodestringrequiredSWIFT/BIC code of the recipient's bank.
ibanstringRecipient IBAN when destination country requires it (typically SEPA zone).
bankobjectrequiredRecipient bank account details.
accountNumberstringrequiredRecipient's bank account number.
namestringName of the recipient's bank.
customerobjectrequiredBeneficiary identity data required by correspondent banks.
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer's name
emailstringrequiredPayer's email
lastNamestringrequiredPayer's last name
phoneNumberstringPayer's phone number without prefix
phoneNumberPrefixstringPhone number prefix (e.g., +57)
documentTypestringrequiredDocumeny type of the entity (e.g., RUT, CURP, CURL). Go to the Supported Identity document types page for the complete list of supported values.
documentNumberstringrequiredThe 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
settlementstringSettlement period for the transaction.
errorobjecttypestringMachine-readable error identifier.
infoobjectnullableAdditional context (field name, constraint, etc.).
messagestringnullableHuman-readable message. May be null.
errorobjecttypestringMachine-readable error identifier.
infoobjectnullableAdditional context (field name, constraint, etc.).
messagestringnullableHuman-readable message. May be null.
POST /sandbox/payment-attempts HTTP/1.1
Host: api.conomyhq.com
Authorization: Bearer {ACCESS_TOKEN}
x-api-key: {YOUR_API_KEY}
conomyhq-api-version: 24-04-2025
User-Agent: MyApp/1.0
Content-Type: application/json
{
"identityId": "679c482ee4420cb5b0966c9a",
"accountNumber": "123456",
"product": "ARS:ARS",
"type": "PAYMENT",
"purchaseAmount": "100",
"purchaseCurrency": "ARS",
"currency": "ARS",
"origins": [
{
"name": "ETPAY",
"type": "PAYMENT_INITATION",
"amount": "100",
"currency": "ARS",
"paymentInitiation": {
"origin": "ETPAY",
"referenceId": "external_payment_id_1"
}
}
],
"destinations": [
{
"type": "ACCOUNT",
"amount": "100",
"currency": "ARS",
"identity": {
"userId": "679c482ee4420cb5b0966c9a",
"name": "Jane Smith",
"lastname": "Turner",
"nickname": "Juanpe",
"dni": "12312252"
},
"account": {
"accountNumber": "123456"
}
}
]
}curl -X POST \
'https://api.conomyhq.com/sandbox/payment-attempts' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {YOUR_API_KEY}' \
-H 'conomyhq-api-version: 24-04-2025' \
-H 'User-Agent: MyApp/1.0' \
-H 'Content-Type: application/json' \
-d '{
"identityId": "679c482ee4420cb5b0966c9a",
"accountNumber": "123456",
"product": "ARS:ARS",
"type": "PAYMENT",
"purchaseAmount": "100",
"purchaseCurrency": "ARS",
"currency": "ARS",
"origins": [
{
"name": "ETPAY",
"type": "PAYMENT_INITATION",
"amount": "100",
"currency": "ARS",
"paymentInitiation": {
"origin": "ETPAY",
"referenceId": "external_payment_id_1"
}
}
],
"destinations": [
{
"type": "ACCOUNT",
"amount": "100",
"currency": "ARS",
"identity": {
"userId": "679c482ee4420cb5b0966c9a",
"name": "Jane Smith",
"lastname": "Turner",
"nickname": "Juanpe",
"dni": "12312252"
},
"account": {
"accountNumber": "123456"
}
}
]
}'const response = await fetch('https://api.conomyhq.com/sandbox/payment-attempts', {
method: 'POST',
headers: {
'Authorization': 'Bearer {ACCESS_TOKEN}',
'x-api-key': '{YOUR_API_KEY}',
'conomyhq-api-version': '24-04-2025',
'User-Agent': 'MyApp/1.0',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"identityId": "679c482ee4420cb5b0966c9a",
"accountNumber": "123456",
"product": "ARS:ARS",
"type": "PAYMENT",
"purchaseAmount": "100",
"purchaseCurrency": "ARS",
"currency": "ARS",
"origins": [
{
"name": "ETPAY",
"type": "PAYMENT_INITATION",
"amount": "100",
"currency": "ARS",
"paymentInitiation": {
"origin": "ETPAY",
"referenceId": "external_payment_id_1"
}
}
],
"destinations": [
{
"type": "ACCOUNT",
"amount": "100",
"currency": "ARS",
"identity": {
"userId": "679c482ee4420cb5b0966c9a",
"name": "Jane Smith",
"lastname": "Turner",
"nickname": "Juanpe",
"dni": "12312252"
},
"account": {
"accountNumber": "123456"
}
}
]
}),
});
const data = await response.json();import requests
payload = {
"identityId": "679c482ee4420cb5b0966c9a",
"accountNumber": "123456",
"product": "ARS:ARS",
"type": "PAYMENT",
"purchaseAmount": "100",
"purchaseCurrency": "ARS",
"currency": "ARS",
"origins": [
{
"name": "ETPAY",
"type": "PAYMENT_INITATION",
"amount": "100",
"currency": "ARS",
"paymentInitiation": {
"origin": "ETPAY",
"referenceId": "external_payment_id_1"
}
}
],
"destinations": [
{
"type": "ACCOUNT",
"amount": "100",
"currency": "ARS",
"identity": {
"userId": "679c482ee4420cb5b0966c9a",
"name": "Jane Smith",
"lastname": "Turner",
"nickname": "Juanpe",
"dni": "12312252"
},
"account": {
"accountNumber": "123456"
}
}
]
}
response = requests.post(
'https://api.conomyhq.com/sandbox/payment-attempts',
headers={
'Authorization': 'Bearer {ACCESS_TOKEN}',
'x-api-key': '{YOUR_API_KEY}',
'conomyhq-api-version': '24-04-2025',
'User-Agent': 'MyApp/1.0',
'Content-Type': 'application/json',
},
json=payload
)
data = response.json()package main
import (
"encoding/json"
"net/http"
"bytes"
)
func main() {
payload, _ := json.Marshal( {
"identityId": "679c482ee4420cb5b0966c9a",
"accountNumber": "123456",
"product": "ARS:ARS",
"type": "PAYMENT",
"purchaseAmount": "100",
"purchaseCurrency": "ARS",
"currency": "ARS",
"origins": [
{
"name": "ETPAY",
"type": "PAYMENT_INITATION",
"amount": "100",
"currency": "ARS",
"paymentInitiation": {
"origin": "ETPAY",
"referenceId": "external_payment_id_1"
}
}
],
"destinations": [
{
"type": "ACCOUNT",
"amount": "100",
"currency": "ARS",
"identity": {
"userId": "679c482ee4420cb5b0966c9a",
"name": "Jane Smith",
"lastname": "Turner",
"nickname": "Juanpe",
"dni": "12312252"
},
"account": {
"accountNumber": "123456"
}
}
]
})
body := bytes.NewBuffer(payload)
req, _ := http.NewRequest("POST", "https://api.conomyhq.com/sandbox/payment-attempts", body)
req.Header.Set("Authorization", "Bearer {ACCESS_TOKEN}")
req.Header.Set("x-api-key", "{YOUR_API_KEY}")
req.Header.Set("conomyhq-api-version", "24-04-2025")
req.Header.Set("User-Agent", "MyApp/1.0")
req.Header.Set("Content-Type", "application/json")
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
var data map[string]any
json.NewDecoder(resp.Body).Decode(&data)
}use reqwest::Client;
use serde_json::json;
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let client = Client::new();
let resp = client
.post("https://api.conomyhq.com/sandbox/payment-attempts")
.header("Authorization", "Bearer {ACCESS_TOKEN}")
.header("x-api-key", "{YOUR_API_KEY}")
.header("conomyhq-api-version", "24-04-2025")
.header("User-Agent", "MyApp/1.0")
.header("Content-Type", "application/json")
.json(&json!({
"identityId": "679c482ee4420cb5b0966c9a",
"accountNumber": "123456",
"product": "ARS:ARS",
"type": "PAYMENT",
"purchaseAmount": "100",
"purchaseCurrency": "ARS",
"currency": "ARS",
"origins": [
{
"name": "ETPAY",
"type": "PAYMENT_INITATION",
"amount": "100",
"currency": "ARS",
"paymentInitiation": {
"origin": "ETPAY",
"referenceId": "external_payment_id_1"
}
}
],
"destinations": [
{
"type": "ACCOUNT",
"amount": "100",
"currency": "ARS",
"identity": {
"userId": "679c482ee4420cb5b0966c9a",
"name": "Jane Smith",
"lastname": "Turner",
"nickname": "Juanpe",
"dni": "12312252"
},
"account": {
"accountNumber": "123456"
}
}
]
}))
.send()
.await?;
let data: serde_json::Value = resp.json().await?;
Ok(())
}{
"id": "string",
"externalId": "string",
"identityId": "string",
"identityExternalId": "string",
"accountNumber": "string",
"totalAmount": "string",
"currency": "string",
"description": "string",
"product": "string",
"status": "string"
}{
"error": {
"type": "bad_request",
"info": null
},
"message": null
}{
"error": {
"type": "unauthorized",
"info": null
},
"message": null
}{
"error": {
"type": "forbidden",
"info": null
},
"message": null
}{
"error": {
"type": "not_found",
"info": null
},
"message": null
}{
"error": {
"type": "validation_error",
"info": {
"field": "string",
"message": "string"
}
},
"message": null
}{
"error": {
"type": "internal_error",
"info": null
},
"message": null
}