Skip to main content
PATCH

Authorizations

Authorization
string
header
required

The data.access_token value from Get access token.

Headers

X-Api-Version
string

Version applied to this request. It wins over your account's pinned version — see Versioning.

Example:

"2026-06-01"

Path Parameters

virtual_account_id
string<uuid>
required

UUID of the account to change.

Body

application/json

Send markup, metadata, or both.

markup
object

The fees to change on this account, each a decimal string with at most two decimals. A value sets that fee, null removes it, and a fee you leave out keeps its value. Any key not listed here is rejected, and so is an empty object. To remove every fee, send each one as null.

metadata
object

A patch, not a replacement: a key with a value sets it, a key with "" deletes it, and {} clears every key. The limits apply to the result — see Metadata.

Response

Success.

One virtual account. The six flat bank fields repeat what source_deposit_instructions holds: absent when it is null, and null where it holds an empty value.

id
string<uuid>

Virtual account UUID.

user_id
string<uuid>

UUID of the user that owns the account.

status
string

Where the account is in its lifecycle. See Virtual account values. Available options: pending, activating, active, failed, deactivated, frozen.

type
enum<string>

Account type.

Available options:
US_BANK
bank
string | null

Which bank the account runs on, and with it the rail — see Virtual account values. null while the bank is still opening it.

mode
string

What the account does with a deposit. Available options: fiat, crypto. See Virtual account values.

destination
object | null

Where a crypto-mode deposit is sent. null on a fiat-mode account.

source_deposit_instructions
object | null

The bank details a payer uses to send money to this account. null until the bank assigns them.

They can also arrive filled with placeholders, such as an account_number of PENDING-ACT-ACCOUNT. Treat them as real only after the virtual_account.activated webhook — see Webhooks.

crypto_addresses
object[]

Addresses where a payer can send stablecoins, one per network. What arrives is credited to this account in dollars — see Crypto inbound. Absent while the account has none.

payment_methods
object | null

Which rails the account takes money on and pays out on.

methods
object | null

The same value as payment_methods.

account_holder_name
string | null

Name the payment must be made out to.

account_number
string | null

Account number the payer sends to.

routing_number
string | null

Routing number the payer sends to.

bank_name
string | null

Name of the bank holding the account.

bank_address
string | null

Postal address of that bank.

account_holder_address
string | null

Postal address of the beneficiary.

description
string

Label you set when you created the account. Absent when you set none.

status_reason
string

Why the account is in its current status, in the bank's own words. Free text — read it, do not parse it. Absent when there is nothing to report.

markup
object

Your fees on this account, each a decimal string. Absent when none are set.

created_at
string

When the account was created, as an ISO 8601 timestamp.

updated_at
string

When the account last changed, as an ISO 8601 timestamp.

metadata
object

Key/value pairs you attached to the account. {} when you attached none.