Skip to main content
POST
Create checkout session

Authorizations

Authorization
string
header
required

User API authentication token with format cash_<64-char-hex>. Sample value cash_16cdc3b6f83c72d9d2680adca4f430962981f6bf32613a129dded0aa060387d2.

Body

application/json
country
enum<string>
required
Available options:
AR,
BR,
CL,
BO
amount
string
required

Decimal amount as string

successUrl
string<uri>
required
accountId
string<uuid>
cancelUrl
string<uri>
webhookUrl
string<uri>
expiresInSeconds
integer
idempotencyKey
string
locale
enum<string>
Available options:
es,
en
metadata
object
payer
object

BR requires name, document, and email; BO requires name, document, and email

paymentMethodId
string<uuid>

Required for CL

customer
object

Required for CL (see ClInboundTransactionRequest customer fields)

Response

Created

id
string<uuid>
publicToken
string
checkoutUrl
string<uri>
status
string
expiresAt
string<date-time>
accountDisplay
object

Present for AR (CVU, alias, holder)

qrCode
string
pixCopiaECola
string
checkoutUrlProvider
string<uri>