Open a virtual account

Authorization

OAuth2PasswordBearer

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Registering a collection account a payer can push money to. IN-302.

Two kinds, and scheme decides which. A dedicated account belongs to this business alone, so a credit is attributable without anything else — those need account_identifier. A shared one (local_reference) is a partner account many businesses pay into, where the payer's reference is the only thing telling them apart, so we issue a reference_code instead.

label*Label

Your name for it, shown wherever accounts are listed. Yours rather than the bank's, because a business with four collection accounts needs to tell them apart at a glance.

Length1 <= length <= 140

Example"EUR collections — Bridge"

currency*Currency

ISO 4217. What the account can receive.

Length3 <= length <= 3

Example"EUR"

scheme*AccountScheme

The rail a payer reaches the account over. ach and fedwire for USD, sepa for EUR, faster_payments for GBP — all dedicated. local_reference is the shared kind, used for RWF and UGX where the partner gives one account rather than one each.

Example"sepa"

Value in

"ach"
"fedwire"
"sepa"
"faster_payments"
"local_reference"
"nuban"

provider?|

The partner holding the account — bridge, intouchpay, xente. Omit it and we route to whichever partner collects in this currency, which is what opening your own account should do: which partner sits behind a rail is ours to choose and ours to change. Name one only to record an account you already hold with that specific partner.

Example"bridge"

account_identifier?|

Required for a dedicated account: the IBAN, or the account number for ach/fedwire. Leave it off for local_reference — there is no per-business number to give, which is the whole reason that scheme issues a reference instead.

Example"DE89370400440532013000"

bank_name?|

As it should be quoted to a payer setting up a transfer.

Example"Bridge Bank"

routing_code?|

Whatever the scheme routes on — BIC for sepa, the routing number for ach and fedwire, sort code for faster_payments.

Example"BRIDGEDEFF"

provider_account_id?|

The partner's own identifier for the account, where you already hold one. Used to reconcile against their reporting; omit it and nothing is lost on our side.

Example"ba_01JB2QK8S4WV6M0P7Z3X9Y1C5D"

Response Body

`application/json`

curl -X POST "https://example.com/api/b/v1/virtual-accounts" \  -H "Content-Type: application/json" \  -d '{    "label": "EUR collections — Bridge",    "currency": "EUR",    "scheme": "sepa"  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "label": "string",  "currency": "string",  "scheme": "string",  "provider": "string",  "account_identifier": "string",  "bank_name": "string",  "routing_code": "string",  "reference_code": "string",  "status": "string",  "reference_required": true,  "created_at": "2019-08-24T14:15:22Z"}

Authorization

Cookie Parameters

Request Body

Response Body

201application/json

422application/json

`application/json`

`application/json`