Sign in

v1

latestOpenAPI 3.0.22026-07-26128245430.3 KB
Virtual Accounts

List Virtual Accounts by Customer

List all Virtual Account objects for a customer

get/customers/{customerID}/virtual_accounts

Path parameters

customerIDstring required

A UUID that uniquely identifies a resource

Query parameters

status'activated' | 'deactivated'

The activation status of the Virtual Account

Limit results to those with the given activation status

limitinteger

The number of items to return (min 1, default 10, max 100)

starting_afterstring

This is a virtual account id. If this is specified, the next page that starts with a virtual account right AFTER the specified virtual account id on the virtual account timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that virtual account older than the specified virtual account id will be returned (shouldn't be set if ending_before is set)

ending_beforestring

This is a virtual account id. If this is specified, the previous page that ends with a virtual account right BEFORE the specified virtual account id on the virtual account timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that virtual account newer than the specified virtual account id will be returned (shouldn't be set if starting_after is set)

Response

List of Virtual Accounts

countinteger required

total number of items in data

Example response

{
  "data": [
    {
      "developer_fee_percent": "0.1",
      "fee_config": {
        "source": {
          "default": {
            "fee_percent": "0.5",
            "minimum_fee": "1.00"
          },
          "wire": {
            "fee_amount": "10.00",
            "fee_percent": "1.0"
          }
        }
      },
      "source_deposit_instructions": {
        "currency": "usd",
        "payment_rails": [
          "ach_push",
          "fednow",
          "wire"
        ],
        "bank_name": "Lead Bank",
        "bank_address": "1801 Main St., Kansas City, MO 64108",
        "bank_beneficiary_name": "Customer Name",
        "bank_beneficiary_address": "1234 Main St., Kansas City, MO 64108",
        "bank_account_number": "123456789",
        "bank_routing_number": "87654321"
      },
      "destination": {
        "currency": "usdc",
        "payment_rail": "polygon",
        "address": "0xdeadbeef"
      }
    }
  ]
}