v1

latestOpenAPI 3.1.02026-07-241910582.8 KB

Create Virtual Account

post/virtual_accounts

Request body

namestring required

internal_account_idstring required

credit_ledger_account_idstring

This field is deprecated and replaced by ledger_account_id.

debit_ledger_account_idstring

This field has been deprecated and replaced by the ledger_account_id of the Internal Account.

counterparty_idstring

descriptionstring

metadatastring json

Response

201

idstring

objectstring

namestring

{"stackTrail":"paths:/virtual_accounts:post:responses:201:content:application/json:schema:properties:description","oasType":"schema","type":"unknown"}

activeboolean

{"stackTrail":"paths:/virtual_accounts:post:responses:201:content:application/json:schema:properties:counterparty_id","oasType":"schema","type":"unknown"}

internal_account_idstring

debit_ledger_account_idstring

credit_ledger_account_idstring

metadataobject

live_modeboolean

created_atstring

updated_atstring

Example response

{
  "id": "2e0296c1-1daf-4b3e-954d-fb9ec7be56f6",
  "object": "virtual_account",
  "name": "Funds on behalf of Alice Jones",
  "active": true,
  "internal_account_id": "c743edb7-4059-496a-94b8-06fc081156fd",
  "debit_ledger_account_id": "f5cc945c-ac46-4f05-b96b-f13f9c6a1cdd",
  "credit_ledger_account_id": "c39d893d-4944-419e-816e-1266387f2ec5",
  "account_details": [
    {
      "id": "5668c0cf-972d-49c6-970f-b32591f3e8a6",
      "object": "account_detail",
      "account_number_safe": "0001",
      "account_number_type": "other"
    }
  ],
  "routing_details": [
    {
      "id": "5ceb251f-0235-48a2-81cb-0c668f5ee81b",
      "object": "routing_detail",
      "routing_number": "121141822",
      "routing_number_type": "aba",
      "bank_name": "BANK OF AMERICA CALIFORNIA, NA",
      "bank_address": {
        "id": "2f1e12dd-de80-44aa-92cd-f0e4101b8e54",
        "object": "address",
        "line1": "PO BOX 27025",
        "locality": "RICHMOND",
        "region": "VA",
        "postal_code": "23261-7025",
        "country": "US",
        "live_mode": true,
        "created_at": "2019-11-09T00:11:07Z",
        "updated_at": "2019-11-09T00:11:07Z"
      },
      "live_mode": true,
      "created_at": "2019-11-09T00:11:07Z",
      "updated_at": "2019-11-09T00:11:07Z"
    }
  ],
  "live_mode": true,
  "created_at": "2020-11-09T00:11:07Z",
  "updated_at": "2020-11-09T00:11:07Z"
}