Skip to navigation
TRANSAK WHITELABEL APIOn RampPaymentsHeadless Cards

Transaction Session API

View as Markdown

Creates a Headless Cards transaction session. Returns a sessionId for your integration. Requires a valid partner access token and approved KYC where applicable.

Note: Ensure the quoteId was generated with paymentMethod set to credit_debit_card.

Authentication: use either Transak Auth, which sends the user’s authorization token, or Partner Auth (Auth Reliance), which sends x-access-token and x-user-identifier. Do not send both. See the headers below.

Headers

x-user-ipstringRequired

End user’s originating IP. More details here

x-api-keystringRequired

Your Partner API key. You can find this in the Partner Dashboard.

authorizationstringOptional

Transak Auth. The user’s accessToken from Transak’s OTP login, returned by the Verify User OTP API (/api/v2/auth/verify). Do not send x-access-token or x-user-identifier with it.

x-access-tokenstringOptional

Partner Auth (Auth Reliance). Your Partner Access Token. Send it with x-user-identifier, and do not send authorization. See Auth Reliance Flows and how to create a Partner Access Token.

x-user-identifierstringOptional

Partner Auth (Auth Reliance). The email address of the user you authenticated. Send it with x-access-token.

Request

This endpoint expects an object.
quoteIdstringRequired

Quote ID from the Quotes API.

walletAddressstringRequired
Destination crypto wallet address.
successUrlstringRequired
Redirect URL or deep link on payment success.
failureUrlstringRequired
Redirect URL or deep link on payment failure.
configobjectOptional
Additional optional UI configuration passed through to the session.
billingAddressobjectOptional

Auto-fetched from user profile if omitted.

Response

Success
dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
422
Unprocessable Entity Error
500
Internal Server Error