Payments APISession

Create payment session

Create a new payment session

Request

This endpoint expects an object.
amountintegerRequired>=0

Payment amount in minor units (e.g. cents)

currencyenumRequired
Currency code
merchantReferencestringRequired

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)

merchantIdstringRequired
Merchant UUID
payerDetailsobjectRequired
Payer details
integrationTypeenumRequired
Integration type
Allowed values:
redirectUrlstringOptional
Redirect URL after payment
paymentAttributesmap from strings to stringsOptional

Payment-specific attributes and metadata that will be stored with the session

Response

Session created successfully
sessionIdstring
Unique identifier for the session
payerIdstring or null
Unique identifier for the payer
signaturestring or null
HMAC signature for session verification

Errors