Create Widget URL

This API creates a widgetUrl to securely store widget query parameters and authentication context. This facilitates secure widget interactions by encapsulating info in a sessionId, reducing exposure in client-side requests.

Use the returned widgetUrl to load the Transak Widget. This URL expires 5 minutes after creation.

Important:

  • Each sessionId is single-use.

  • The widget cannot be reopened using the same widgetUrl.

  • A new sessionId is required for every new user flow.

EnvironmentBase URL
Staginghttps://api-gateway-stg.transak.com
Productionhttps://api-gateway.transak.com
<Callout intent="note"> Call this API only from the partner backend, with partner IPs whitelisted. Direct frontend calls are not supported. </Callout> <Callout intent="warning"> `apiKey` and `referrerDomain` are mandatory query parameters inside the `widgetParams` object. </Callout>
post/api/v2/auth/session

Request

  • Base URL: https://api-stg.transak.com/partners/api/v2
  • URL: https://api-stg.transak.com/partners/api/v2/api/v2/auth/session
  • Auth: none declared. Required headers: x-user-ip, x-api-key, access-token

Headers

x-user-ipstring required

End user's originating IP. More details here

x-api-keystring required

Partner API Key present in Transak Dashboard.

access-tokenstring required

Your Partner Access Token. Please refer here for a tutorial on generating your access token.

authorizationstring

User Authorization Token. Only required in Integrations via User Authentication APIs.

Request body

Response

Success

Changes

No recorded changes to this operation across all 1 revision of this API.