crate::connectivity::fiat::controller::openapi::virtual_accounts

List locally synchronized virtual accounts, newest first. This request does not refresh bank data. Optional filters use exact matches and are combined with AND. Archived accounts are excluded.

Changed on
get/v1/accounts/{account_id}/virtual-accounts

Request

Path parameters

account_idstring required

Account ID (BZ-/IN-) or legacy customer UUID

Query parameters

pageinteger

Page number (starts from 1, default: 1)

sizeinteger

Number of items per page (1-100, default: 10)

external_idstring

HTTP Idempotency-Key header value. Stricter than other IDs: ≤64 ASCII chars per the common REST API convention.

Exact match for the external_id supplied in the creation request body.

status'PENDING' | 'ACTIVE' | 'DEACTIVE' | 'FAILED'

Return only virtual accounts in this state.

asset'USD' | 'EUR' | 'CNY' | 'HKD' | 'MXN' | 'BRL' | 'GBP' | 'AED' | 'INR' | 'PHP' | 'SGD' | 'JPY'

Return only virtual accounts denominated in this currency.

is_defaultboolean

True for automatically discovered projections; false for customer-created additional accounts.

Response

totalinteger required

Total number of undeleted virtual accounts matching the filters for this customer.

pageinteger required

Current page number (1-based).

sizeinteger required

Requested page size.

Example response

{
  "list": [
    {
      "virtual_account_id": "VA-7K3M-9X2R",
      "fee": {
        "value": "1.00",
        "asset": "USD"
      },
      "created_at": "2025-08-21T07:56:57.981Z",
      "last_modified_at": "2025-08-21T07:56:57.981Z",
      "networks": [
        {
          "network": "US_FEDWIRE",
          "account_holder": {
            "address": {
              "full_address": "490 2nd St Suite 300, San Francisco, CA 94107",
              "country_code": "USA",
              "address_line1": "490 2nd St",
              "address_line2": "Suite 300",
              "city": "San Francisco",
              "region": "CA",
              "postal_code": "94107"
            }
          }
        }
      ]
    }
  ],
  "page": 1,
  "size": 10
}

Changes