v1

latestOpenAPI 3.0.02026-07-24126202516.7 KB

Virtual Accounts

Create Virtual Account

Create a Virtual Account for a given Wallet Account.

post/wallet_accounts/{id}/virtual_accounts

Path parameters

idstring uuid required

Wallet Account ID.

Request body

account_namestring

A name given for a Virtual Account. This is used in CoP lookups.

aka_namesAkaName[]

A list of AKA Names.

Example request

{
  "account_name": "Real Estate Agency X",
  "aka_names": [
    "Realestate Agency X",
    "Realestate Agency X of PropTech Marketplace"
  ]
}

Response

Accepted

idstring uuid

routing_numberstring numeric

account_numberstring numeric

currencystring alphabets

user_external_idstring uuid

wallet_account_idstring uuid

status'active' | 'pending_activation' | 'activation_failed' | 'disabled' | 'closed'

created_atstring date-time

updated_atstring date-time

account_type'NIND'

full_legal_account_namestring

account_namestring

A name given for a Virtual Account. This is used in CoP lookups.

aka_namesAkaName[]

A list of AKA Names.

merchant_idstring

An identifier that links a Virtual Account to a merchant. This is used in CoP lookups.

Example response

{
  "id": "46deb476-c1a6-41eb-8eb7-26a695bbe5bc",
  "currency": "AUD",
  "user_external_id": "46deb476-c1a6-41eb-8eb7-26a695bbe5bc",
  "wallet_account_id": "46deb476-c1a6-41eb-8eb7-26a695bbe5bc",
  "status": "active",
  "created_at": "2020-04-27T20:28:22.378Z",
  "updated_at": "2020-04-27T20:28:22.378Z",
  "account_type": "NIND",
  "full_legal_account_name": "Prop Tech Marketplace",
  "account_name": "Real Estate Agency X",
  "aka_names": [
    "Realestate Agency X",
    "Realestate Agency X of PropTech Marketplace"
  ],
  "merchant_id": "46deb476c1a641eb8eb726a695bbe5bc"
}