CollectPaymentsPayment Initiation

Get Checkout Session

Retrieves the details of a specific checkout session using the provided session ID. The response includes the session object and may include an active transaction if one exists.

Query parameters

sessionIdstringRequiredformat: "uuid"
Unique identifier for the checkout session.

Response

Checkout session details retrieved successfully.
sessionobject
payerIdstringOptionalformat: "uuid"

Persistent identifier for the payer (customer) associated with this session. The same payer keeps the same payerId across all of their sessions and transactions. Store it against your customer record and pass it back in payerDetails.payerId on future sessions to recognise a returning customer. See the Payer ID guide.

payerDetailsobjectOptional
activeTransactionobjectOptional

The current active transaction for this session (if any). Fields may vary depending on payment method and auth state.

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error