Skip to main content

Get specific Wallet Details

Overview

Retrieve detailed balance information, account linkage, and operational flags for a specific wallet by its unique walletId.

Use this endpoint to verify liquid balance before executing an FX conversion or payout, inspect locked amounts, and check whether the wallet is marked as default or disabled.

Resource Access

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

Request Headers

HeaderValueRequiredDescription
AuthorizationBearer {access_token}YesJWT Bearer access token
Acceptapplication/jsonYesResponse payload format
x-api-keystringNoOptional API key

Path Parameters

ParameterTypeRequiredDescription
companyIdstringYesUnique identifier assigned to the company within the system (e.g. 4011).
walletIdnumberYesUnique identifier assigned to the wallet (e.g. 25427).

Response

Success Response (200 OK)

{
"id": 25427,
"totalBalance": 125000.50,
"availableBalance": 120000.00,
"currency": "USD",
"type": "standard",
"companyId": 4011,
"customReferenceLabel": "Operating USD Wallet",
"isDefault": true,
"isDisabled": false,
"fundingType": "account"
}

Response Fields

FieldTypeDescription
idnumberUnique identifier for the returned wallet.
totalBalancenumberTotal cumulative balance including locked funds.
availableBalancenumberUsable balance available for immediate transfers, trades, and withdrawals.
currencystringISO currency code (e.g. USD, GBP).
typestringType of wallet (standard, fx_balance).
companyIdnumberOwner company identifier.
customReferenceLabelstringUser-friendly label.
isDefaultbooleanTrue if marked as the default wallet for this currency.
isDisabledbooleanTrue if disabled for transactions.
fundingTypestringFunding method linkage (account, smartWallet, pooled, null).

Error Responses

  • 400 Bad Request: Invalid companyId or walletId format.
  • 401 Unauthorized: Missing or expired Bearer token.
  • 403 Forbidden: Caller does not have permissions to access this wallet.
  • 404 Not Found: Wallet not found for this company.
  • 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/25427' \
-H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
-H 'Accept: application/json'

Python

import requests

company_id = "4011"
wallet_id = 25427
url = f"https://gateway.ahrvo.network/banking/ibans/v2/{company_id}/wallets/{wallet_id}"
headers = {
"Authorization": "Bearer YOUR_ACCESS_TOKEN",
"Accept": "application/json"
}

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

JavaScript (Node.js)

const axios = require('axios');

const companyId = '4011';
const walletId = 25427;
const url = `https://gateway.ahrvo.network/${companyId}/wallets/${walletId}`;
const headers = {
'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
'Accept': 'application/json'
};

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

Interactive API Explorer