For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Unique merchant reference. Recommended to be only alphanumeric characters (for acceptance across providers, otherwise note that they might appear stripped to alphanumerics on customer’s statements, e.g. ref-123 -> ref123)
merchantIdstringRequiredformat: "uuid"
Merchant UUID
payerDetailsobjectRequired
Payer details
integrationTypeenumRequired
Integration type
Allowed values:
collectionCurrencyenumOptional
Currency the end customer pays in (ISO 4217). Defaults to the primary currency for payerDetails.location when omitted. Used for FX-enabled sessions to determine the source→collection pair.
redirectUrlstringOptionalformat: "uri"
URL the buyer is redirected to after payment. Hosted checkout appends ?status=completed|failed|cancelled before bouncing the buyer. Direct-API redirection flows redirect the buyer here with no ?status param — your page should render a processing state and rely on transaction webhooks for authoritative terminal status.
rateLockIdstringOptional
Optional FX rate lock to price this session against. Submit the amount in the settlement currency (the lock's `base`, e.g. USD); the local collection amount is computed from the lock's rate. The lock's `base` currency must equal the session `currency`. The lock is re-verified at payment time and rejected with 422 if it has expired or been cancelled. Omit to use the standard per-session FX quote flow.
paymentAttributesmap from strings to stringsOptional
Payment-specific attributes and metadata that will be stored with the session
expiresInSecondsintegerOptional30-604800
Session lifetime in seconds. The payment confirmation window expires this long after creation; defaults to the standard session lifetime when omitted.
Response
Session created successfully
sessionIdstring
Unique identifier for the session
paymentLinkstringOptional
URL for the hosted checkout payment
payerIdstringOptionalformat: "uuid"
Unique identifier for the payer
signaturestringOptional
HMAC signature for session verification
Errors
400
Bad Request Error
401
Unauthorized Error
422
Unprocessable Entity Error
500
Internal Server Error
Optional FX rate lock to price this session against. Submit the amount in the settlement currency (the lock’s base, e.g. USD); the local collection amount is computed from the lock’s rate. The lock’s base currency must equal the session currency. The lock is re-verified at payment time and rejected with 422 if it has expired or been cancelled. Omit to use the standard per-session FX quote flow.
