PUT
/
customers
/
{customerID}
/
virtual_accounts
/
{virtualAccountID}
Update a Virtual Account
curl --request PUT \
  --url https://api.bridge.xyz/v0/customers/{customerID}/virtual_accounts/{virtualAccountID} \
  --header 'Api-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "destination": {
    "currency": "usdc",
    "payment_rail": "polygon",
    "address": "0xdeadbeef",
    "blockchain_memo": "from_bridge"
  },
  "developer_fee_percent": "0.1"
}'
{
  "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
​
virtualAccountID
string
required

A UUID that uniquely identifies a resource

Required string length: 1 - 42

Body

application/json

The Virtual Account details to be updated

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

Updated Virtual Account object

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