Quickstart
This page takes you from a Transak API key to your first successful Whitelabel API call. It then lists the calls you make to place your first order.
Before you start
You need:
- A partner account on the Transak Partner Dashboard. See How To Create a Partner Dashboard Account.
- Your API Key, from the Developers tab of the dashboard. Use the staging API key on staging and the production API key on production.
- A backend server. Whitelabel API calls must come from your backend, never from a browser or mobile app.
Step 1: Get access
Ask Transak to enable the Whitelabel API for your API key
Your API key must be enabled for the Whitelabel API before the calls work. See What does it take to get access to the Whitelabel API? for the commercial terms, and Need help in Integration for how to reach the team.
Send your backend IP addresses for allowlisting
Transak only accepts Whitelabel API calls from allowlisted IP addresses. Share your backend’s static egress IP addresses for both staging and production. See Mandatory Security Changes.
Step 2: Pick the base URL
Build and test on staging first. Staging KYC checks are dummy checks and always approve the user. See How to Test Using Sandbox Credentials for test users and payment details.
Step 3: Send the required headers
Send these headers on every call:
Calls made for a logged-in user also need one of these two ways to authenticate the user. Use one or the other, never both:
Lookup calls, such as Get Quote for a user who isn’t logged in, need only x-api-key and x-user-ip. Each endpoint page in the API reference lists the headers it takes.
Step 4: Make your first call
Get a price quote on staging for 50 GBP of USDC on Ethereum, paid by bank transfer. Get Quote also takes your API key as the apiKey query parameter.
A successful call returns 200 with a quote:
If the call fails, check the errorCode in the response against Error Codes. The API allows 40 requests per IP address every 10 seconds. See What are the rate limits on the Whitelabel APIs?
Step 5: Place your first order
These are the calls for a first bank transfer order. The Whitelabel API overview has the full flow for each payment method.
Look up what the user can buy
Get Countries, Get Fiat Currencies and Get Crypto Currencies return the supported countries, payment methods, cryptocurrencies and networks.
Get a quote
Call Get Quote and keep the quoteId. For US, EEA and UK users, show the disclaimers in termsIds. See How to Display Disclaimers in Your API Integration.
Log the user in
With Transak Auth, call Send User OTP and Verify User OTP to get the user’s accessToken. With Partner Auth (Auth Reliance), call Onboard User for a new user.
Complete KYC
Call Get KYC Requirement with the quoteId, then submit what it asks for, starting with Patch User Details.
Create the order
Check for an existing order with Get Active Orders, then call Create Order with the quoteId and the user’s wallet address.
Before you go live
- Your production API key is enabled for the Whitelabel API, and your production IP addresses are allowlisted.
- Your terms show Transak’s Terms of Service, and your app shows the disclaimers in
termsIds. - You have completed the Mandatory Security Changes.
- Webhook URLs are registered for production. See Add or Update Webhook.