Error Codes
Error response format and errorCode reference for the Transak Whitelabel API.
Every error from the Whitelabel API returns the same JSON shape. Use errorCode to decide what to do next: it is stable, while the message wording can change.
Error response format
Error response
How to handle errors
- Branch on
errorCode, not on the HTTP status. Some errors are passed on from the Transak service that rejected the request, so the sameerrorCodecan come with a different HTTP status on different endpoints. For example,4001(invalid wallet address) returns400on Bank Transfer: Create Order and422on the headless payment endpoints. 401errors mostly return1002(the KYC Reliance endpoints return1010). The user or partner token is missing, invalid or expired. Refresh the token or log the user in again.- Request validation errors return
400with9001. Themessagenames the field, for examplequoteId is required. - Unrecognised errors fall back to a default code:
9999in most cases,4099for order errors and6099for headless payment errors. Retry once, then contact Transak support with the request details. - Rate limit. The API gateway allows 40 requests per IP address every 10 seconds. See What is the API Rate Limit? to request a higher limit.
Authentication errors (10xx)
User and FCA errors (20xx)
KYC errors (30xx)
Order errors (40xx)
Lookup and quote errors (50xx)
Headless payment errors (60xx)
Returned by the headless Apple Pay, Google Pay and Cards flows: Transaction Session and Create Order with a requestId.