Skip to content

Suggested
API Dashboard
Sandbox Production
Checkout Session

Checkout sessions represent a temporary, tokenized context in which a payer completes a payment flow.

Objects

Checkout session object

Unique identifier for the internal service.

Reference Payment Link ID

Reference for checkout url

currencystringrequired

Currency code enabled for the checkout session

productstringrequired

Product conversion of the checkout session

exchangeRatestringrequired

Product's exchange rate

paymentMethodsobject[]required

Payment methods config list

When the link expires

ATTEMPTACTIVEEXPIREDFINISHEDPROCESSING_PAYMENTFAILED

List of items to pay for

preTaxAmountstringrequired

The amount of the item

totalAmountstringrequired

amount + tax.amount, if no tax it's equal to amount

descriptionstringrequired

The description of the item

taxobjectnullable

Specifies the currency used, following the ISO 4217 standard for fiat currencies (e.g., CLP, ARS, MXN). Go to the currencies page for the complete list of supported values.

Addition of all items preTaxAmounts

Addition of all items totalAmounts

Url to open checkout flow

Allowed payment methods.

Optional customer to pass into the checkout session

idstring

Unique identifier for the internal service.

firstNamestring

Payer's name

emailstring

Payer's email

lastNamestring

Payer's last name

phoneNumberstring

Payer's phone number without prefix

phoneNumberPrefixstring

Phone number prefix (e.g., +57)

documentTypestring

Documeny type of the entity (e.g., RUT, CURP, CURL). Go to the Supported Identity document types page for the complete list of supported values.

documentNumberstring

The document number associated with the documentType

addressobject

The entity’s address information.

The URL to which the end user will be redirected after completing the payment.

A list of destinations for the transaction.

namestring

The name of the source or destination of the transaction.

typestringrequired
ACCOUNT
externalIdstring

External reference identifier for integrations.

amountstringrequired

The amount involved in the transaction.

metadataobject

Additional metadata related to the transaction source or destination.

accountobjectrequired

Identity reference object used inside account nodes.

identityIdstringrequired

User unique identifier

namestring

User name

lastnamestring

User lastname

nicknamestring

User nickname

documentNumberstring

User DNI

entityTypestring

Entity type of identity

Checkout session payment object

A brief description of the transaction.

A list of sources for the transaction.

namestring

The name of the source or destination of the transaction.

typestringrequired
CARDRepresents a card payment. Opens the card node.
CRYPTOCryptocurrency wallet rail (global). Supports both pay-in and pay-out flows. Opens the wallet node.
ACCOUNTRepresents an internal platform account. Opens the account node.
BANK_ACCOUNTGeneric external bank account for payouts. Opens the bank node.
PIXPIX QR code or copy-paste code in Brazil (BRL). Opens the pix node.
PCTInteroperable QR payment in Argentina (ARS) under BCRA PCT standard. Opens the pct node.
CVUVirtual account / CBU bank transfer pay-in in Argentina (ARS). Opens the cvu node.
ETPAYOpen banking pay-in for Chile (CLP) via Etpay. Opens the etpay node.
FINTOCOpen banking pay-in for Chile (CLP) via Fintoc widget. Opens the fintoc node.
WEBPAYCard payment in Chile (CLP) via Transbank. Opens the webpay node.
SPEIElectronic Interbank Payment System for Mexico (MXN). Opens the spei node.
PSEOnline secure bank transfer pay-in for Colombia (COP). Opens the pse node.
BANCOLOMBIABancolombia direct payment pay-in for Colombia (COP). Opens the bancolombia node.
DAVIVIENDADavivienda direct payment pay-in for Colombia (COP). Opens the davivienda node.
DAVIPLATADaviplata mobile wallet for Colombia (COP). Opens the daviplata node.
NEQUINequi digital wallet for Colombia (COP). Opens the nequi node.
BREBBank account transfer payout for Colombia (COP). Opens the breb node.
WOMPIWompi payment gateway pay-in for Colombia (COP). Opens the wompi node.
LIGOQR-based payment system pay-in for Peru (PEN). Opens the ligo node.
SIPInteroperable payment system for Peru (PEN) and Bolivia (BOB). Opens the sip node.
ACHAutomated Clearing House bank transfers for USA (USD). Opens the ach node.
WIREWire transfer via correspondent banks for USA (USD). Opens the wire node.
FEDNOWFedNow instant payment service for USA (USD). Opens the fedNow node.
RTPReal-time payments network pay-in for USA (USD). Opens the rtp node.
SEPASingle Euro Payments Area payout for Europe (EUR). Opens the sepa node.
FPEFaster Payments near-instant bank transfer payout for UK (GBP). Opens the fpe node.
SWIFTInternational bank wire transfer rail (global). Pay-out only. Opens the swift node.
externalIdstring

External reference identifier for integrations.

amountstring

The amount involved in the transaction.

amountOutstring

Calculated amount - fees

currencystringrequired

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.

settlementstring

Indicates the settlement period.

feeobject

Details about any fees applied to the transaction.

identityobject

The entity associated with the source or destination.

metadataobject

Additional metadata related to the transaction source or destination.

One of

cardobjectrequired