BRbridge
Virtual Accounts

Get a Virtual Account

Changed on

Retrieve the Virtual Account object from the passed ID

get/customers/{customerID}/virtual_accounts/{virtualAccountID}

Request

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

Path parameters

customerIDstring required

A UUID that uniquely identifies a resource

virtualAccountIDstring required

A UUID that uniquely identifies a resource

Response

Successful Virtual Account object response

idstring

A UUID that uniquely identifies a resource

status'activated' | 'deactivated'

The activation status of the Virtual Account

developer_fee_percentstring number

The developer fee percent that will be applied to this Virtual Account. The value is a base 100 percentage, i.e. 10.2% is 10.2 in the API.

customer_idstring

A UUID that uniquely identifies a resource

created_atstring date-time

Time of creation of the virtual account

Example response

{
  "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