Skip to main content
POST
Create Virtual Account

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-MultiTenantKey
string

Required when using a Platform API token. The tenant key identifying which business to operate on.

Path Parameters

userId
string<uuid>
required

The unique identifier for the user

Example:

"c06f3427-3bbe-4d70-9a54-28acda267e48"

Body

application/json
currency
string
required

ISO 4217 currency code for the virtual account

Example:

"USD"

jobInformation
object
required
customIdentification
object
suppressNotification
boolean

Whether to suppress notifications for this virtual account, defaults to false

Example:

true

Response

Successful operation