Sign in

v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB
Virtual Accounts

Disable virtual account

Disable a virtual account. A disabled virtual account cannot be used to create an expected payment.

post/virtual_accounts/{id}/disable

Path parameters

idstring uuid required

The ID of the virtual account.

Response

200

idstring uuid required

The UUID of the virtual account.

object'virtual_account' required

The object, here virtual_account.

namestring required

The name of the virtual account.

virtual_account_numberstring required

The virtual account number.

connected_account_idstring uuid required

The ID of the connected account to which the virtual account refers.

counterparty_idstring uuid nullable required

The ID of the counterparty to which the virtual account refers to.

metadataobject required

Additional client data in JSON format. See Metadata.

disabled_atstring date-time required

The UTC timestamp of the disabling of this virtual account.

created_atstring date-time required

The UTC timestamp of the creation of this virtual account.

Example response

{
  "metadata": {
    "property_a": true,
    "property_b": "some text"
  }
}