POST
/
customers
/
{customerID}
/
virtual_accounts
curl --request POST \
--url https://api.bridge.xyz/v0/customers/{customerID}/virtual_accounts \
--header 'Api-Key: <api-key>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '{
"developer_fee_percent": "0.1",
"source": {
"currency": "usd"
},
"destination": {
"currency": "usdc",
"payment_rail": "base",
"address": "0xdeadbeef"
}
}'
{
"id": "59waova4hbt1vhabj3jo7don6j1mj5peq8i8rhc5l1",
"status": "activated",
"developer_fee_percent": "0.1",
"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

Headers

Idempotency-Key
string
required

Path Parameters

customerID
string
required

A UUID that uniquely identifies a resource

Required string length: 1 - 42

Body

application/json

Virtual Account object to be created

source
object
required
Example:
{ "currency": "usd" }
destination
object
required
Example:
{
"currency": "usdc",
"payment_rail": "polygon",
"address": "0xdeadbeef"
}
developer_fee_percent
string<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.

Example:

"0.1"

Response

200 - application/json

Virtual Account object created

id
string

A UUID that uniquely identifies a resource

Required string length: 1 - 42
status
enum<string>

The activation status of the Virtual Account

Available options:
activated,
deactivated
developer_fee_percent
string<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.

Example:

"0.1"

customer_id
string

A UUID that uniquely identifies a resource

Required string length: 1 - 42
created_at
string<date-time>

Time of creation of the virtual account

source_deposit_instructions
object
Example:
{
"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
object
Example:
{
"currency": "usdc",
"payment_rail": "polygon",
"address": "0xdeadbeef"
}