ZEzerohash
Virtual Accounts

List virtual accounts

Changed on

Returns a paginated list of virtual accounts scoped to the authenticated platform. With participant_code, returns only that participant's virtual accounts. Without participant_code, returns all of the platform's virtual accounts across every participant. Filterable by status and currency.

get/virtual_accounts

Request

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

Query parameters

participant_codestring
Example:ABCDEF

Filter by a specific participant code. Always 6 uppercase alphanumeric characters.

pagenumber
Example:1

Page number for pagination (starts at 1).

page_sizenumber
Example:15

Number of items per page for pagination. Default and maximum is 100

status'PENDING' | 'ACTIVE' | 'CLOSING' | 'CLOSED' | 'BLOCKED' | 'FAILED'
currency'USD'

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

Paginated list of virtual accounts.

pageinteger
page_sizeinteger
total_pagesinteger
countinteger

Example response

{
  "message": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "participant_code": "PART01",
      "platform_code": "PLAT01",
      "provider_type": "CRB",
      "status": "PENDING",
      "currency": "USD",
      "virtual_account_name": "Acme Holdings Operating Account",
      "account_label": "treasury",
      "bank_details": {
        "bank_account_number": "0000000001",
        "bank_routing_number": "123456789",
        "provider_account_id": "0000000001",
        "bank_name": "Cross River Bank"
      },
      "status_detail": {
        "code": "VA_CREATION_FAILED",
        "message": "zerohash was unable to open this virtual account. Contact zerohash support to request a new account.",
        "at": "2026-07-21T09:05:00.000Z"
      },
      "settlement_policy": {
        "type": "HOLD"
      },
      "created_at": "2026-07-20T14:22:00.000Z",
      "updated_at": "2026-07-20T14:22:00.000Z"
    }
  ],
  "page": 1,
  "page_size": 200,
  "total_pages": 1,
  "count": 1
}

Changes