BRbridge
Virtual Accounts

List Virtual Accounts

Changed on

List all Virtual Account objects

get/virtual_accounts

Request

  • Base URL
    https://api.bridge.xyz/v0
  • URL
    https://api.bridge.xyz/v0/virtual_accounts
  • Auth
    API key in header Api-Key

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"
      }
    }
  ]
}

Changes

  • a390532e9fc6Revision changes
    • warning

      removed the optional property ///// from the response with the status

    • warning

      added the new linea enum value to the /// response property for the response status

    • warning

      added the new usdl_linea enum value to the /// response property for the response status

    • warning

      added the new xdc enum value to the /// response property for the response status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      removed from the /// response property allOf list for the response status

    • info

      removed from the /// response property allOf list for the response status

    • info

      removed from the /// response property allOf list for the response status