v1

latestOpenAPI 3.0.22026-07-26128245430.3 KB

Virtual Accounts

Update a Virtual Account

Update instructions for an existing Virtual Account

put/customers/{customerID}/virtual_accounts/{virtualAccountID}

Path parameters

customerIDstring required

A UUID that uniquely identifies a resource

virtualAccountIDstring required

A UUID that uniquely identifies a resource

Request body

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.

Example request

{
  "destination": {
    "currency": "usdc",
    "payment_rail": "polygon",
    "address": "0xdeadbeef",
    "blockchain_memo": "from_bridge"
  },
  "developer_fee_percent": "0.1",
  "fee_config": {
    "source": {
      "fee_percent": "1.5",
      "fee_amount": "10.00",
      "minimum_fee": "1.00",
      "maximum_fee": "1000.00"
    }
  }
}

Response

Updated Virtual Account object

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