GET
/
customers
/
{customerID}
/
virtual_accounts
List Virtual Accounts by Customer
curl --request GET \
  --url https://api.bridge.xyz/v0/customers/{customerID}/virtual_accounts \
  --header 'Api-Key: <api-key>'
{
  "count": 123,
  "data": [
    {
      "id": "<string>",
      "status": "activated",
      "developer_fee_percent": "0.1",
      "customer_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "source_deposit_instructions": {
        "currency": "usd",
        "payment_rails": [
          "ach_push",
          "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"
      }
    }
  ]
}

Authorizations

​
Api-Key
string
header
required

Path Parameters

​
customerID
string
required

A UUID that uniquely identifies a resource

Required string length: 1 - 42

Query Parameters

​
status
enum<string>

Limit results to those with the given activation status

Available options:
activated,
deactivated
​
limit
integer

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

​
starting_after
string

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_before
string

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

200 - application/json

List of Virtual Accounts

The response is of type object.