Your balances
Return the balance of every currency wallet on your account, for the mode of your API key.
GET
https://afropin.com/api/v1/brand/wallets
HMAC-signed request with a unique Idempotency-Key header. Authentication
With an SDK
PHP
$afropin->brand->wallets->list($params)Node.js
afropin.brand.wallets.list(params)Python
afropin.brand.wallets.list(params)Java
afropin.brand().wallets().list(params)This request takes no parameters. Wallets are sorted by currency code.
Response fields
data[].amount
number
Required
Available balance, truncated (never rounded up) to 2 decimal places.
data[].currency
string
Required
ISO 4217 currency code of the wallet.
Test and live wallets are separate: a test key returns test balances only. Redemptions credit the wallet in the PIN's currency, less your redemption fee in live mode.
Response 200
{
"ok": true,
"data": [
{
"amount": 495.38,
"currency": "EUR"
},
{
"amount": 125000,
"currency": "NGN"
}
]
}Errors
Failed requests return a stable code with a translated message. Branch on code, never on the message.
{
"ok": false,
"error": {
"code": "invalid_api_key",
"message": "This API key is unknown, revoked or expired, or live access is not switched on",
"fields": null
}
}