Virtual accounts

Close a virtual account

Closes the account for good. Nothing is erased: the account, its payments and its number stay on record, and the number is never given to another customer. The account is closed at its issuing bank where the bank can, otherwise on the platform only. Closing a closed account returns it with 200, so the call is safe to repeat. A key closes only accounts in its own mode. Money that reaches the account after it is closed is never credited to you automatically: it is held for review, and returned to the payer or credited to you. You are told by the virtual_account.closed webhook. A 409 means the account is still being opened, or was never opened. A 503 means the bank did not confirm the close and nothing changed; try again.

Path parameters#

• virtualAccountIDuuidRequired

Headers#

• Idempotency-KeystringRequired

  Client-generated key that makes the request safe to retry. Replaying the key with an identical payload returns the original response; replaying it with a different payload is rejected. Up to 255 characters.

Responses#

• 200The closed virtual account
• 400The request could not be read.
• 401The secret key is missing, invalid or revoked.
• 403The key is not allowed to do this, or the request came from an address that is not on its allowlist.
• 404Nothing was found for this business and mode.
• 409The request clashes with the current state, such as a reference reused with different details.
• 503A dependency could not be reached