Get Virtual Accounts

Get Virtual Account

get

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

/banking/v1/bank-accounts/{bank_account}/virtual-accounts

This endpoint retrieves a list of virtual accounts linked to a specific bank account under a merchant profile.

scope: bank-accounts.read

Path parameters

bank_accountstring · uuidRequiredExample: 01977f6d-5c06-7228-86f6-f4fc01305143

Header parameters

AcceptstringOptionalExample: application/json

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/bank-accounts/{bank_account}/virtual-accounts

HTTPcURLJavaScriptPython

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

{
  "data": [
    {
      "id": "01977a5b-274d-705f-a889-2b03137cb838",
      "merchant_id": "01977f6d-5c06-7228-86f6-f4fc01305143",
      "currency": "BRL",
      "balance": 100000,
      "type": "merchant",
      "bank_account_id": "01977f6d-5c06-7228-86f6-f4fc01305143",
      "label": "Main Account",
      "status": "active",
      "is_default": true,
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z",
      "deleted_at": null,
      "merchant": {
        "id": "01977f6d-5c06-7228-86f6-f4fc01305143",
        "name": "Example Company LTDA"
      },
      "bank_account": {
        "id": "01977f6d-5c06-7228-86f6-f4fc01305143",
        "account_number": "12345678"
      }
    },
    {
      "id": "01977a5b-274d-705f-a889-2b03137cb839",
      "merchant_id": "01977f6d-5c06-7228-86f6-f4fc01305143",
      "currency": "BRL",
      "balance": 50000,
      "type": "merchant",
      "bank_account_id": "01977f6d-5c06-7228-86f6-f4fc01305143",
      "label": "Secondary Account",
      "status": "active",
      "is_default": false,
      "created_at": "2025-01-15T11:30:00.000000Z",
      "updated_at": "2025-01-15T11:30:00.000000Z",
      "deleted_at": null,
      "merchant": {
        "id": "01977f6d-5c06-7228-86f6-f4fc01305143",
        "name": "Example Company LTDA"
      },
      "bank_account": {
        "id": "01977f6d-5c06-7228-86f6-f4fc01305143",
        "account_number": "12345678"
      }
    }
  ],
  "total": 2,
  "currentPage": 1,
  "perPage": 15
}