> For a complete page index, fetch https://docs.transak.com/llms.txt

# Bank Transfer

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

| Method             | `paymentInstrumentId` |
| ------------------ | --------------------- |
| GBP bank transfer  | `gbp_bank_transfer`   |
| SEPA bank transfer | `sepa_bank_transfer`  |
| Wire transfer      | `pm_wire`             |

Call [Get Fiat Currencies](/api/whitelabel/lookup/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](/integration/api) first. New to the Whitelabel API? Start with the [Quickstart](/integration/api/quickstart).

#### Lookup

Get the supported countries, fiat currencies, cryptocurrencies, payment methods and a quote. See [Lookup](/integration/api#lookup).

#### Authentication

Log the user in with **Transak Auth** or **Partner Auth (Auth Reliance)**. See [Authentication](/features/authentication).

#### User

Call [Get User Details](/api/whitelabel/user/get-user-details) to check the user's profile and KYC status.

#### KYC

Complete the KYC steps the user needs. See [KYC](/features/kyc).

## How to integrate?

![Bank Transfer order flow](https://files.buildwithfern.com/visual-editor-images/docs.transak.com/2026-07-01T06:16:27.724Z/guides/biconomy/bank-transfer.png "Bank Transfer order flow")

#### Get KYC Requirement

Call [Get KYC Requirement](/api/whitelabel/kyc/get-kyc-requirement) with the `quoteId` to fetch the user's KYC status and route accordingly:

<table>
  <thead>
    <tr>
      <th>
        When
      </th>

      <th>
        Next step
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        `data.kyc.status` = **APPROVED**
      </td>

      <td>
        No further steps in the KYC process. Proceed to **Get Payment Instrument Status**.
      </td>
    </tr>

    <tr>
      <td>
        `data.kyc.status` = **NOT_SUBMITTED**
      </td>

      <td>
        User details need to be submitted. Proceed to **Patch User Details**.
      </td>
    </tr>

    <tr>
      <td>
        `data.kyc.status` = **ADDITIONAL_FORMS_REQUIRED**
      </td>

      <td>
        More steps in the KYC process are required. Proceed to **Get Additional Requirements**.
      </td>
    </tr>
  </tbody>
</table>

#### Get Payment Instrument Status

Call [Get Payment Instrument Status](/api/whitelabel/payments/bank-transfer/get-payment-instrument-status) with the `quoteId` and `paymentInstrumentId` to check the user's virtual account status:

<table>
  <thead>
    <tr>
      <th>
        When
      </th>

      <th>
        Next step
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        `status` = **COMPLETED**
      </td>

      <td>
        Virtual account is ready. Proceed to **Get User Limits**.
      </td>
    </tr>

    <tr>
      <td>
        `status` = **INITIATED**
      </td>

      <td>
        Account creation is still in progress. Poll this endpoint again until status changes.
      </td>
    </tr>

    <tr>
      <td>
        `status` = **FAILED**
      </td>

      <td>
        Account creation failed. Proceed to **Create Virtual Account**.
      </td>
    </tr>

    <tr>
      <td>
        `Error 404` : **Not Found**
      </td>

      <td>
        Virtual account not yet created. Proceed to **Create Virtual Account**.
      </td>
    </tr>
  </tbody>
</table>

#### Create Virtual Account

Call [Create Virtual Account](/api/whitelabel/payments/bank-transfer/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.

#### Get User Limits

Call [Get User Limits](/api/whitelabel/user/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**.

#### Get Active Orders

Call [Get Active Orders](/api/whitelabel/orders/get-active-orders) to check for any existing pending orders. Transak doesn't support placing multiple orders simultaneously.

<table>
  <tbody>
    <tr>
      <td>
        **`activeOrder`** `exists`

        Proceed to **Cancel Order**

        ---

        **`activeOrder`** `not exists`

        Proceed to **Create Order**

        ---
      </td>
    </tr>
  </tbody>
</table>

#### Get VASPs (For Custodial Wallet Address)

Call [Get VASPs](/api/whitelabel/payments/bank-transfer/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`.

#### Create Order

Call the [Create Order](/api/whitelabel/payments/bank-transfer/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

#### Mandatory Parameters

| Parameter             | Description                                                                               |
| --------------------- | ----------------------------------------------------------------------------------------- |
| `quoteId`             | Quote ID generated from the [Get Quotes API](/api/whitelabel/lookup/get-quote)            |
| `paymentInstrumentId` | Payment method from the [Fiat Currencies API](/api/whitelabel/lookup/get-fiat-currencies) |
| `walletAddress`       | Wallet address where crypto will be delivered                                             |

Required for **Custodial wallet addresses** for Travel Rule compliance:

#### addressAdditionalData

| Parameter    | Description                                                                                                                           |
| ------------ | ------------------------------------------------------------------------------------------------------------------------------------- |
| `walletType` | Type of the destination wallet. Accepted values: `EXCHANGE`, `PRIVATE`                                                                |
| `vaspName`   | Name of the VASP managing the destination wallet. Retrieve from the [Get VASPs](/api/whitelabel/payments/bank-transfer/get-vasps) API |
| `vaspDid`    | Decentralised Identifier (DID) of the VASP. Retrieve from the [Get VASPs](/api/whitelabel/payments/bank-transfer/get-vasps) API       |

<table>
  <tbody>
    <tr>
      <td>
        **`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**

        ---
      </td>
    </tr>
  </tbody>
</table>

#### Confirm Payment

Call [Confirm Payment](/api/whitelabel/payments/bank-transfer/confirm-payment) with `orderId` and `paymentMethod` to confirm the bank transfer.

On success → proceed to **Get Order By ID**.

#### Cancel Order

Call [Cancel Order](/api/whitelabel/orders/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.

#### Get Order By ID

Call [Get Order By ID](/api/whitelabel/orders/get-order-by-id) with `orderId` to poll the final order status.

## API Overview

#### [Get Payment Instrument Status](/api/whitelabel/payments/bank-transfer/get-payment-instrument-status)

Checks whether the user's virtual account for the payment method is ready.

#### [Create Virtual Account](/api/whitelabel/payments/bank-transfer/create-virtual-account)

Starts creating the user's virtual account.

#### [Get User Limits](/api/whitelabel/user/get-user-limits)

Returns the user's daily, monthly and yearly limits and what is still available.

#### [Get Active Orders](/api/whitelabel/orders/get-active-orders)

Returns the user's pending orders. Only one order can be active at a time.

#### [Get VASPs](/api/whitelabel/payments/bank-transfer/get-vasps)

Lists the VASPs to choose from when the wallet address is custodial (Travel Rule).

#### [Create Order](/api/whitelabel/payments/bank-transfer/create-order)

Places the order and returns the bank details the user pays to.

#### [Confirm Payment](/api/whitelabel/payments/bank-transfer/confirm-payment)

Tells Transak the user has made the bank transfer.

#### [Cancel Order](/api/whitelabel/orders/cancel-order)

Cancels a pending order.

#### [Get Order By ID](/api/whitelabel/orders/get-order-by-id)

Returns the order and its current status.

See [Error Codes](/api/whitelabel/error-codes) for the errors these APIs return.