Fetch All Wallets (Atlas)

Overview

The GET /banking/ibans/v2/{companyId}/wallets endpoint retrieves all wallets created for a specified company or sub-company.

This endpoint supports extensive query parameters to filter by currency, active status, default designation, billing wallet flags, and wallet types (standard or fx_balance).

Resource Access

• HTTP Method: GET
• Endpoint: /banking/ibans/v2/{companyId}/wallets
• Authentication: Bearer token required
• Permissions: Client:EWallets:read, Admin:Wallets:read, Client:At Ahrvo Rate:read, Client:Make Payment To Account:read, Client:Add Funds:read, Client:Add Wallets:read, Client:Make Payment To Another Business:read

Path Parameters

Parameter	Type	Required	Description	Example
companyId	string	Yes	Unique identifier of the company whose wallets are requested.	3046

Query Parameters

Parameter	Type	Required	Description	Example
limit	integer	No	Maximum records to return (max 300).	50
skip	integer	No	Number of records to skip for pagination.	0
currency	string	No	3-letter ISO currency code filter.	USD
currencyId	string	No	Internal currency identifier.	1
searchTerm	string	No	Search by wallet label or custom reference.	OPERATING
type	string	No	Wallet type: standard or fx_balance.	standard
isDefault	boolean	No	Filter for default currency wallet (true or false).	true
isBillingWallet	boolean	No	Filter by billing wallet flag.	false
isArchived	boolean	No	Include or filter archived wallets.	false
walletIds	string	No	Comma-separated list of specific wallet IDs.	12582,12583
fetchPreference	string	No	Fetch preference: fxAndDefault, fxAndAll, fxOrAll, fxOrDefault, billingOrDefault.	fxAndDefault

---

Response

Success Response (200 OK)

{
  "totalCount": 2,
  "items": [
    {
      "id": 12582,
      "totalBalance": 154200.50,
      "availableBalance": 150000.00,
      "currency": "USD",
      "type": "standard",
      "companyId": 3046,
      "customReferenceLabel": "US_OPERATING",
      "isDefault": true,
      "isDisabled": false,
      "isBillingWallet": false,
      "fundingType": "smartWallet",
      "isSplitPaymentEnabled": true,
      "splitPaymentLimit": 50000,
      "splitPaymentMessage": "This wallet supports split payments"
    },
    {
      "id": 12583,
      "totalBalance": 75300.00,
      "availableBalance": 75300.00,
      "currency": "EUR",
      "type": "standard",
      "companyId": 3046,
      "customReferenceLabel": "EUR_TREASURY",
      "isDefault": true,
      "isDisabled": false,
      "isBillingWallet": false,
      "fundingType": "account",
      "isSplitPaymentEnabled": false,
      "splitPaymentLimit": 0,
      "splitPaymentMessage": null
    }
  ]
}

Response Fields

Field	Type	Description
totalCount	integer	Total number of wallets matching the query filter.
items[].id	number	Unique wallet identifier (use this in payment, FX, and statement calls).
items[].totalBalance	number	Total balance held in the wallet including unsettled funds.
items[].availableBalance	number	Immediately spendable balance available for payouts or conversions.
items[].currency	string	3-letter ISO currency code (e.g. USD, EUR, GBP).
items[].type	string	Wallet type: standard or fx_balance.
items[].companyId	number	Company ID owning the wallet.
items[].customReferenceLabel	string	User-defined label (e.g. US_OPERATING).
items[].isDefault	boolean	Whether this is the company's primary default wallet for this currency.
items[].isDisabled	boolean	Indicates if transactions are restricted.
items[].isBillingWallet	boolean	Indicates if platform service fees debit from this wallet.
items[].fundingType	string	Clearing backing type: account, smartWallet, pooled, or null.
items[].isSplitPaymentEnabled	boolean	Whether split payment settlement is enabled.
items[].splitPaymentLimit	number	Maximum single split transaction limit.

---

Code Examples

cURL

curl -X GET "https://api.ahrvo.network/banking/ibans/v2/3046/wallets?currency=USD&type=standard" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Accept: application/json"

JavaScript (Fetch)

const companyId = '3046';
const response = await fetch(`https://api.ahrvo.network/${companyId}/wallets?currency=USD`, {
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Accept': 'application/json'
  }
});

const data = await response.json();
console.log('Total Wallets:', data.totalCount);
data.items.forEach(w => {
  console.log(`Wallet ${w.id} (${w.currency}): Available ${w.availableBalance}`);
});

Python (requests)

import requests

company_id = "3046"
url = f"https://api.ahrvo.network/banking/ibans/v2/{company_id}/wallets"
headers = {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Accept": "application/json"
}
params = {"currency": "USD", "isDefault": "true"}

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

---

Interactive API Console

Test the endpoint directly in your browser: