Create Checkout Session

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 code.
integrationTypeenumRequired
Type of integration.
Allowed values:
payerDetailsobjectRequired
redirectUrlstringOptionalformat: "uri"
Optional URL to redirect after payment.
paymentAttributesmap from strings to stringsOptional
Optional session attributes to pass through the payment lifecycle.

Response

Session created successfully.
sessionIdstring
Unique identifier for the session.
payerIdstring or nullformat: "uuid"

Identifier for the created/associated payer.

signaturestring or null
Signature used for hosted checkout verification.

Errors