Get all Wallets (New)

Overview

Retrieve all digital wallets associated with a company. Filter wallets by currency, label search term, default status, or active/archived state, and use the returned wallet IDs for receiving funds, executing FX exchanges, or dispatching payouts.

Resource Access

• HTTP Method: GET
• Endpoint: /banking/ibans/v2/{companyId}/wallets
• Authentication: Bearer token required

Request Headers

Header	Value	Required	Description
Authorization	Bearer {access_token}	Yes	JWT Bearer access token
Accept	application/json	Yes	Response payload format
x-api-key	string	No	Optional API key

Path Parameters

Parameter	Type	Required	Description
companyId	string	Yes	Unique identifier assigned to the company within the system (e.g. 4011).

Query Parameters

Parameter	Type	Required	Description
limit	integer	No	Maximum number of records to return (min: 1, max: 100, default: 20).
skip	integer	No	Number of items to skip for pagination (min: 0, default: 0).
currency	string	No	Filter by 3-letter currency code (e.g. USD, EUR, GBP).
currencyId	string	No	Filter by specific unique currency ID.
searchTerm	string	No	Search by wallet label or custom reference.
isDefault	boolean	No	Filter to check if the wallet is marked as the default for its currency.
isArchived	boolean	No	Filter to check if the wallet is archived.
walletIds	string	No	Comma-separated list of specific wallet IDs (e.g. 25427,25428).
type	string	No	Filter by wallet type (standard or fx_balance).

Response

Success Response (200 OK)

{
  "totalCount": 2,
  "items": [
    {
      "id": 25427,
      "totalBalance": 125000.50,
      "availableBalance": 120000.00,
      "currency": "USD",
      "type": "standard",
      "companyId": 4011,
      "customReferenceLabel": "Operating USD Wallet",
      "isDefault": true,
      "isDisabled": false,
      "fundingType": "account"
    },
    {
      "id": 25428,
      "totalBalance": 85000.00,
      "availableBalance": 85000.00,
      "currency": "GBP",
      "type": "standard",
      "companyId": 4011,
      "customReferenceLabel": "Default GBP Wallet",
      "isDefault": true,
      "isDisabled": false,
      "fundingType": "account"
    }
  ]
}

Response Fields

Field	Type	Description
totalCount	integer	Total number of wallets matching the query criteria.
items	array	Array of Wallet objects.
items[].id	number	Unique wallet identifier.
items[].totalBalance	number	Total balance including available and locked funds.
items[].availableBalance	number	Unrestricted liquid balance.
items[].currency	string	ISO currency code.
items[].type	string	Wallet classification (standard or fx_balance).
items[].customReferenceLabel	string	Custom user-defined label.
items[].isDefault	boolean	True if this is the default wallet for the currency.
items[].isDisabled	boolean	True if disabled for operations.
items[].fundingType	string	Source of funding type.

Error Responses

• 400 Bad Request: Invalid query parameters or pagination boundaries.
• 401 Unauthorized: Missing or invalid Bearer authentication token.
• 403 Forbidden: Insufficient account permissions.
• 404 Not Found: companyId not found.
• 500 Internal Server Error: Internal platform error.

Code Examples

Base URL

Production: https://api.ahrvo.network
Staging:    https://gateway.ahrvo.network

cURL

curl -X GET \
  'https://gateway.ahrvo.network/banking/ibans/v2/4011/wallets?limit=20&skip=0&currency=USD' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Accept: application/json'

Python

import requests

company_id = "4011"
url = f"https://gateway.ahrvo.network/banking/ibans/v2/{company_id}/wallets"
params = {"limit": 20, "skip": 0, "currency": "USD"}
headers = {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Accept": "application/json"
}

response = requests.get(url, params=params, headers=headers)
print(response.status_code, response.json())

JavaScript (Node.js)

const axios = require('axios');

const companyId = '4011';
const url = `https://gateway.ahrvo.network/${companyId}/wallets`;
const headers = {
  'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
  'Accept': 'application/json'
};
const params = { limit: 20, skip: 0, currency: 'USD' };

axios.get(url, { headers, params })
  .then(res => console.log(res.data))
  .catch(err => console.error(err.response ? err.response.data : err.message));

Interactive API Explorer