List Virtual Accounts

List Virtual Accounts

get

https://api.aurixpay.wshttps://sandbox.api.aurixpay.ws

/banking/v1/virtual-accounts

This endpoint returns a list of virtual accounts associated with the authenticated merchant. Each account includes balance, bank account information, and status.

scope: virtual-accounts.read

Header parameters

Content-TypestringOptionalExample: application/json

X-API-KeystringRequiredExample: {{API_KEY}}

Responses

200

Success

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

get

/banking/v1/virtual-accounts

HTTPcURLJavaScriptPython

GET /banking/v1/virtual-accounts HTTP/1.1
Host: api.aurixpay.ws
X-API-Key: text
Accept: */*

{
  "data": [
    {
      "id": "019764e2-0c97-7071-b162-bf6d347b5833",
      "merchant_id": "019764e0-4ab4-706a-b399-9c3d541689a3",
      "currency": "BRL",
      "balance": 0,
      "type": "merchant",
      "bank_account_id": null,
      "label": "Starter account",
      "status": "active",
      "is_default": false,
      "created_at": "2025-06-12T16:03:45.000000Z",
      "updated_at": "2025-06-12T16:03:45.000000Z",
      "deleted_at": null,
      "merchant": {
        "id": "019764e0-4ab4-706a-b399-9c3d541689a3",
        "name": "Aurix"
      },
      "bank_account": null
    },
    {
      "id": "01976540-f222-718d-97f6-335f6aef1db4",
      "merchant_id": "019764e0-4ab4-706a-b399-9c3d541689a3",
      "currency": "BRL",
      "balance": 80,
      "type": "merchant",
      "bank_account_id": "01976540-f21b-72b2-acf0-f0005d032d6f",
      "label": "Starter account",
      "status": "active",
      "is_default": false,
      "created_at": "2025-06-12T17:47:24.000000Z",
      "updated_at": "2025-06-16T20:12:31.000000Z",
      "deleted_at": null,
      "merchant": {
        "id": "019764e0-4ab4-706a-b399-9c3d541689a3",
        "name": "Aurix"
      },
      "bank_account": {
        "id": "01976540-f21b-72b2-acf0-f0005d032d6f",
        "account_number": "123456",
        "bank_code": "001"
      }
    },
    {
      "id": "01976559-1fdf-7093-8d5c-2a54ac47a83b",
      "merchant_id": "019764e0-4ab4-706a-b399-9c3d541689a3",
      "currency": "BRL",
      "balance": 0,
      "type": "merchant",
      "bank_account_id": "01976540-f21b-72b2-acf0-f0005d032d6f",
      "label": "Main Virtual Account 2",
      "status": "active",
      "is_default": false,
      "created_at": "2025-06-12T18:13:49.000000Z",
      "updated_at": "2025-06-16T20:12:31.000000Z",
      "deleted_at": null,
      "merchant": {
        "id": "019764e0-4ab4-706a-b399-9c3d541689a3",
        "name": "Aurix"
      },
      "bank_account": {
        "id": "01976540-f21b-72b2-acf0-f0005d032d6f",
        "account_number": "123456",
        "bank_code": "001"
      }
    },
    {
      "id": "01977a5b-274d-705f-a889-2b03137cb838",
      "merchant_id": "019764e0-4ab4-706a-b399-9c3d541689a3",
      "currency": "BRL",
      "balance": 0,
      "type": "merchant",
      "bank_account_id": "01976540-f21b-72b2-acf0-f0005d032d6f",
      "label": "Main Virtual Account 2",
      "status": "active",
      "is_default": true,
      "created_at": "2025-06-16T20:08:03.000000Z",
      "updated_at": "2025-06-16T20:14:16.000000Z",
      "deleted_at": null,
      "merchant": {
        "id": "019764e0-4ab4-706a-b399-9c3d541689a3",
        "name": "Aurix"
      },
      "bank_account": {
        "id": "01976540-f21b-72b2-acf0-f0005d032d6f",
        "account_number": "123456",
        "bank_code": "001"
      }
    }
  ],
  "total": 4,
  "currentPage": 1,
  "perPage": 15
}