Skip to navigation

Open Banking

Let users buy crypto with a secure, real-time bank payment through the Whitelabel API.

View as Markdown

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

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?

Open Banking order flow
1

Get Fiat Currencies

Call Get Fiat Currencies to confirm supported fiat currencies (e.g., GBP) and verify the availability of pm_open_banking as a payment method.

2

Get Quote

Call Get Quote to generate a quote for fiat → crypto using Open Banking as the selected payment method.

3

Get KYC Requirement

Call 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:

WhenNext step

data.kyc.status = APPROVED

No further steps in the KYC process. Proceed to Get User Limits.

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.

4

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.

5

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.

6

Get User Limits

Call Get User Limits to validate the user’s daily, monthly, and yearly limits for pm_open_banking.

7

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

8

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.

9

Create Order & Initiate Payment Authorization

Call Create Order with quoteId, walletAddress, and paymentInstrumentId: pm_open_banking.

ParameterDescription
quoteIdQuote ID generated from the Get Quotes API
paymentInstrumentIdPayment method — set to pm_open_banking for Open Banking
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

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

data.paymentDetails.redirectUrl
string

The Open Banking authorization URL

10

Cancel Order

Call Cancel Order to cancel a pending order (if still AWAITING_PAYMENT_FROM_USER) by providing orderId and cancelReason.

11

Get Order By ID

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

API Overview

See Error Codes for the errors these APIs return.