Skip to main content

Get a Wallet (Legacy)

Overview

This service is used to fetch specific wallet information using the wallet_id. It returns the wallet currency, total balance, available balance, and pending inward/outward amounts.

Resource Access

  • HTTP Method: GET
  • Endpoint: /profile/v2.2/wallets/{wallet_id}
  • Authentication: Bearer token required

Request Headers

HeaderValueRequiredDescription
Acceptapplication/jsonYesContent type for the response
AuthorizationBearer {access_token}YesBearer token for authentication
x-api-keystringNoAPI key for additional authentication

Path Parameters

ParameterTypeRequiredDescription
wallet_idnumberYesUnique identifier of the wallet (e.g. 2718).

Response

Success Response (200 OK)

{
"success": true,
"data": {
"id": 2718,
"currency": "ZAR",
"totalAmount": 10000.5,
"availableAmount": 9500.0,
"pendingInwardAmount": 500.5,
"pendingOutwardAmount": 0.0
}
}

Response Fields

FieldTypeDescription
successbooleanIndicates whether the wallet lookup was successful.
data.idnumberUnique ID of the wallet.
data.currencystringCurrency of the wallet.
data.totalAmountnumberTotal balance in the wallet.
data.availableAmountnumberAmount currently available for withdrawals/conversions.
data.pendingInwardAmountnumberPending inward deposits awaiting confirmation.
data.pendingOutwardAmountnumberPending outward transfers reserved.

Error Responses

  • 400 Bad Request: Invalid parameters or malformed request
  • 401 Unauthorized: Missing or invalid Bearer authentication token
  • 403 Forbidden: Insufficient account permissions
  • 404 Not Found: Resource not found
  • 500 Internal Server Error: An internal server error occurred

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/profile/v2.2/wallets/2718' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Python

import requests

url = "https://gateway.ahrvo.network/banking/ibans/v2/profile/v2.2/wallets/2718"
headers = {
"Accept": "application/json",
"Authorization": "Bearer YOUR_ACCESS_TOKEN"
}

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

JavaScript (Node.js)

const axios = require('axios');

const walletId = 2718;
const url = `https://gateway.ahrvo.network/banking/ibans/v2/profile/v2.2/wallets/${walletId}`;
const headers = {
'Accept': 'application/json',
'Authorization': 'Bearer YOUR_ACCESS_TOKEN'
};

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

Usage Notes

  • Always check availableAmount before executing trades or payout requests.

Interactive API Explorer