Creates a checkout session. For hosted integrations this may generate a hosted checkout payment link.
For direct integrations, the payment link may be omitted.
Request
This endpoint expects an object.
merchantIdstringRequiredformat: "uuid"
The merchant identifier.
merchantReferencestringRequired
Your reference for the checkout session.
amountintegerRequired1-1000000000000
Amount in minor units.
currencyenumRequired
Currency of the session (ISO 4217). Without a rateLockId this is the
collection currency the payer pays in. With a rateLockId it must equal the
lock’s base currency (the currency you price in, e.g. USD); the payer is then
charged the equivalent in the lock’s quote currency at the lock’s all-in rate.
USD is valid only together with a rateLockId.
integrationTypeenumRequired
Type of integration.
payerDetailsobjectRequired
redirectUrlstringOptionalformat: "uri"
Optional URL to redirect after payment.
rateLockIdstringOptional
Optional rate lock to apply to this session. When set, the session currency
must equal the lock’s base currency, and the payer is charged the equivalent in
the lock’s quote currency at the lock’s all-in rate. The lock is verified when a
payment is initiated; if it has expired or been cancelled, the payment is
rejected with 422.
paymentAttributesmap from strings to stringsOptional
Optional session attributes to pass through the payment lifecycle.
Response
Session created successfully.
sessionIdstring
Unique identifier for the session.
paymentLinkstringformat: "uri"
Hosted checkout payment link (present for hosted integrations).
payerIdstringformat: "uuid"
Identifier for the created/associated payer.
signaturestring
Signature used for hosted checkout verification.
