Skip to main content
PUT
Update a Virtual Account

Authorizations

Api-Key
string
header
required

Path Parameters

customerID
string
required

A UUID that uniquely identifies a resource

Required string length: 1 - 42
Pattern: [a-z0-9]*
virtualAccountID
string
required

A UUID that uniquely identifies a resource

Required string length: 1 - 42
Pattern: [a-z0-9]*

Body

application/json

The Virtual Account details to be updated

destination
object
Example:
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"

fee_config
object

Developer fee configuration. Available by request only. Contact Bridge to enable this feature for your developer account. When provided, performs a full replacement of the existing fee configuration. If the virtual account was previously configured with developer_fee_percent, providing fee_config will clear developer_fee_percent and replace it with the new configuration. Include the desired fee under source (e.g. fee_config.source.fee_percent). Cannot be provided alongside developer_fee_percent in the same request.

Response

200 - application/json

Updated Virtual Account object

id
string
read-only

A UUID that uniquely identifies a resource

Required string length: 1 - 42
Pattern: [a-z0-9]*
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"

fee_config
object

Developer fee configuration. Available by request only and returned only for developers with this feature enabled.

customer_id
string

A UUID that uniquely identifies a resource

Required string length: 1 - 42
Pattern: [a-z0-9]*
created_at
string<date-time>
read-only

Time of creation of the virtual account

source_deposit_instructions
Virtual Account US · object
Example:
destination
object
Example: