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

# Open Banking

The **Open Banking** payment method lets users in the **UK** fund crypto purchases with a **secure, real-time bank transfer**. The user authorizes the payment in their own banking app or website, so there are no bank details to copy.

Open Banking is returned by the [Get Fiat Currencies](/api/whitelabel/lookup/get-fiat-currencies) API with the payment method ID `pm_open_banking`, and is shown to users as **Easy Bank Transfer**.

This feature is available only for users whose **KYC country is supported** under Plaid's Open Banking framework (e.g., UK, etc.). The list of supported countries and banks can be found [here](https://plaid.com/docs/resources/#european-bank-coverage).

## 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?

![Open Banking order flow](https://files.buildwithfern.com/visual-editor-images/docs.transak.com/2026-07-01T06:16:43.648Z/guides/biconomy/open-banking.png "Open Banking order flow")

#### Get Fiat Currencies

Call [Get Fiat Currencies](/api/whitelabel/lookup/get-fiat-currencies) to confirm supported fiat currencies (e.g., GBP) and verify the availability of `pm_open_banking` as a payment method.

#### Get Quote

Call [Get Quote](/api/whitelabel/lookup/get-quote) to generate a quote for fiat → crypto using Open Banking as the selected payment method.

#### Get KYC Requirement

Call [Get KYC Requirement](/api/whitelabel/kyc/get-kyc-requirement) with the `quoteId` (and the **User Access Token** as required by the API) to validate KYC for the provided quote 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 User Limits**.
      </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/open-banking/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/open-banking/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) to validate the user's daily, monthly, and yearly limits for `pm_open_banking`.

#### 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/open-banking/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 & Initiate Payment Authorization

Call [Create Order](/api/whitelabel/payments/open-banking/create-order) with `quoteId`, `walletAddress`, and `paymentInstrumentId: pm_open_banking`.

#### Mandatory Parameters

| Parameter             | Description                                                                    |
| --------------------- | ------------------------------------------------------------------------------ |
| `quoteId`             | Quote ID generated from the [Get Quotes API](/api/whitelabel/lookup/get-quote) |
| `paymentInstrumentId` | Payment method — set to `pm_open_banking` for Open Banking                     |
| `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/open-banking/get-vasps) API |
| `vaspDid`    | Decentralised Identifier (DID) of the VASP. Retrieve from the [Get VASPs](/api/whitelabel/payments/open-banking/get-vasps) API       |

Launch the Open Banking authorization flow by opening the `redirectUrl` received in the response in an in-app browser or external browser.

<table>
  <tbody>
    <tr>
      <td>
        **`data.paymentDetails.redirectUrl`** `string`

        The Open Banking authorization URL

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

#### Cancel Order

Call [Cancel Order](/api/whitelabel/orders/cancel-order) to cancel a pending order (if still `AWAITING_PAYMENT_FROM_USER`) by providing `orderId` and `cancelReason`.

#### Get Order By ID

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

## API Overview

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

Checks whether the user's virtual account for Open Banking is ready.

#### [Create Virtual Account](/api/whitelabel/payments/open-banking/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 for `pm_open_banking`.

#### [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/open-banking/get-vasps)

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

#### [Create Order](/api/whitelabel/payments/open-banking/create-order)

Places the order and returns the `redirectUrl` for the Open Banking authorization.

#### [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.