Skip to navigation

Get Payment Instrument Status

View as Markdown

The Get Payment Instrument Status is an authenticated API that polls the payment instrument status. Keep polling until status is COMPLETED before placing an order. A FAILED status indicates account creation failed.

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
Partner API Key present in Transak Dashboard.
authorizationstringOptional

Transak Auth. The user’s accessToken from Transak’s OTP login, returned by the Verify User OTP API (/api/v2/auth/verify). Send the token on its own, with no Bearer prefix. It is valid for 30 days. Call the Refresh User Access Token API before it expires. Do not send x-access-token or x-user-identifier with it.

x-access-tokenstringOptional

Partner Auth (Auth Reliance). Your Partner Access Token, valid for 7 days. 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.

Query parameters

paymentInstrumentIdstringRequired

Payment instrument identifier. Use gbp_bank_transfer for GBP bank transfer.

quoteIdstringRequired

Quote ID generated from api/v2/lookup/quotes

Response

200 - Success

dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error