ZEzerohash
Virtual Accounts

Close a virtual account

Changed on

Requests closure. Closing is asynchronous: a 202 Accepted returns the record with status: CLOSING, and the account reaches CLOSED once the banking partner acknowledges. Poll GET /virtual_accounts/{id} for the transition. Calling it again while a close is in flight, or after it completes, returns 200 OK. Accounts in PENDING, BLOCKED or FAILED cannot be closed and return 409 Conflict. An unknown id or an account belonging to another platform return 404 Not Found. The request body is empty.

patch/virtual_accounts/{id}/close

Request

  • Base URL
    https://api.cert.zerohash.com
  • URL
    https://api.cert.zerohash.com/virtual_accounts/{id}/close
  • Auth
    API key in header X-SCX-API-KEY and API key in header X-SCX-PASSPHRASE

Path parameters

idstring uuid required

Headers

X-SCX-SIGNEDstring required

HMAC-SHA256 signature of the request, base64-encoded. See the Authentication guide for the exact signing formula.

X-SCX-TIMESTAMPstring required
Example:1678901234

Current Unix timestamp in seconds. Must be within 60 seconds of server time or the request is rejected.

Response

A closure was already in flight or already complete.

idstring uuid
status'PENDING' | 'ACTIVE' | 'CLOSING' | 'CLOSED' | 'BLOCKED' | 'FAILED' nullable

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "CLOSING"
}

Changes