Skip to navigation

Bank Transfer

Let users buy crypto with a bank transfer through the Whitelabel API.
View as Markdown

With Bank Transfer, the user pays for the order from their own bank account. Transak sets up a virtual account for the user, the order returns the bank details to pay to, and your app confirms the payment once the user has made the transfer.

Supported bank transfer methods

MethodpaymentInstrumentId
GBP bank transfergbp_bank_transfer
SEPA bank transfersepa_bank_transfer
Wire transferpm_wire

Call Get Fiat Currencies to see which methods are available for the user’s fiat currency, with their limits and processing times.

Before you start

Complete these steps of the Whitelabel API flow first. New to the Whitelabel API? Start with the Quickstart.

1

Lookup

Get the supported countries, fiat currencies, cryptocurrencies, payment methods and a quote. See Lookup.

2

Authentication

Log the user in with Transak Auth or Partner Auth (Auth Reliance). See Authentication.

3

User

Call Get User Details to check the user’s profile and KYC status.

4

KYC

Complete the KYC steps the user needs. See KYC.

How to integrate?

Bank Transfer order flow
1

Get KYC Requirement

Call Get KYC Requirement with the quoteId to fetch the user’s KYC status and route accordingly:

WhenNext step

data.kyc.status = APPROVED

No further steps in the KYC process. Proceed to Get Payment Instrument Status.

data.kyc.status = NOT_SUBMITTED

User details need to be submitted. Proceed to Patch User Details.

data.kyc.status = ADDITIONAL_FORMS_REQUIRED

More steps in the KYC process are required. Proceed to Get Additional Requirements.

2

Get Payment Instrument Status

Call Get Payment Instrument Status with the quoteId and paymentInstrumentId to check the user’s virtual account status:

WhenNext step

status = COMPLETED

Virtual account is ready. Proceed to Get User Limits.

status = INITIATED

Account creation is still in progress. Poll this endpoint again until status changes.

status = FAILED

Account creation failed. Proceed to Create Virtual Account.

Error 404 : Not Found

Virtual account not yet created. Proceed to Create Virtual Account.

3

Create Virtual Account

Call Create Virtual Account with the quoteId to initiate virtual account creation.

On success (status: INITIATED) → return to Get Payment Instrument Status and resume polling for status updates.

4

Get User Limits

Call Get User Limits with paymentCategory set to the user’s bank transfer method (for example sepa_bank_transfer or gbp_bank_transfer) and fiatCurrency to fetch the user’s monthly, daily, and yearly limits along with available limits to place an order.

On success → proceed to Get Active Orders.

5

Get Active Orders

Call Get Active Orders to check for any existing pending orders. Transak doesn’t support placing multiple orders simultaneously.

activeOrder
exists

Proceed to Cancel Order

activeOrder
not exists

Proceed to Create Order

6

Get VASPs (For Custodial Wallet Address)

Call Get VASPs to get list of supported Virtual Asset Service Providers (VASPs) for custodial wallet address. search param can be passed to search VASPs based on name.

7

Create Order

Call the Create Order API to place an order using a Custodial or Non Custodial wallet address.

US, EEA and UK users: before calling Create Order, show the disclaimers for the termsIds from the Get Quote response.

How to Display Disclaimers in Your API Integration
ParameterDescription
quoteIdQuote ID generated from the Get Quotes API
paymentInstrumentIdPayment method from the Fiat Currencies API
walletAddressWallet address where crypto will be delivered

Required for Custodial wallet addresses for Travel Rule compliance:

ParameterDescription
walletTypeType of the destination wallet. Accepted values: EXCHANGE, PRIVATE
vaspNameName of the VASP managing the destination wallet. Retrieve from the Get VASPs API
vaspDidDecentralised Identifier (DID) of the VASP. Retrieve from the Get VASPs API
Case 1
status = AWAITING_PAYMENT_FROM_USER · errorMessage = null

Proceed to Confirm Payment

Case 2
status = AWAITING_PAYMENT_FROM_USER · errorMessage = Order exists

Cancel Order → repeat Get User Limits

Case 3
statusCode = 400 · message = Order exists

Get Quote → repeat Get User Limits

8

Confirm Payment

Call Confirm Payment with orderId and paymentMethod to confirm the bank transfer.

On success → proceed to Get Order By ID.

9

Cancel Order

Call Cancel Order with orderId and cancelReason to cancel a pending order.

This is only required when an active order is present. After cancellation, return to Get User Limits to start a fresh order.

10

Get Order By ID

Call Get Order By ID with orderId to poll the final order status.

API Overview

See Error Codes for the errors these APIs return.