DevelopersVirtual AccountCancel a Virtual Account
Cancel a Virtual Account
You can cancel a virtual account before it expires or receives a payment. Cancellation is only supported for nonstatic accounts.
⚠️
Only the integration that created the virtual account can cancel it. Attempting to cancel an account belonging to a different settlement account will result in an authorisation error.
Endpoint
PATCH/virtual/cancel?reference=<external_reference>
Query Parameters
| Parameter | Required | Description |
|---|---|---|
| reference | Yes | The external_reference of the nonstatic virtual account to cancel. |
Sample Request
Request
PATCH /virtual/cancel?reference=INV-2026-0001
secretKey: sk_staging_xxxxxxxxxxxxxxxxxxxxSupported Account Types
| Type | Can Cancel via API? | Reason |
|---|---|---|
| nonstatic | ✅ Yes | Single-use, time-limited accounts can be cancelled early |
| static | ❌ No | Permanent accounts are managed via the dashboard |
| static-flex | ❌ No | Permanent accounts are managed via the dashboard |
Success Response
Response
{
"status": "success",
"message": "Virtual account cancelled successfully."
}