Wallet Enquiry
Overview
The Wallet Enquiry endpoints allow you to retrieve detailed wallet information including balance, status, tier, and profile metadata.
Two methods are available:
- By Wallet ID - Query specific wallet using account number
- By Merchant ID - Retrieve all wallets under your merchant account
Use Cases
- Check wallet balance before transactions
- Verify wallet status (ACTIVE, SUSPENDED, etc.)
- Retrieve wallet tier and limits
- List all customer wallets
- Verify wallet ownership
Method 1: Query by Wallet ID
Retrieve details for a specific wallet using its account number.
Endpoint
GET /waas/WalletManagement/getWalletsByAccountNo
Request Parameters
Required Headers
| Header | Value |
|---|---|
Authorization | Bearer <access_token> |
Ocp-Apim-Subscription-Key | Your access subscription key |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
AccountNo | string | Yes | Wallet/account number (10 digits) |
Request Example
curl -X GET "https://api-sandbox.accessbankplc.com/waas/WalletManagement/getWalletsByAccountNo?AccountNo=0702334455" \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
Response
{
"succeeded": true,
"code": "200",
"message": "successful request",
"data": {
"accountNumber": "0702334455",
"accountName": "JOHN DOE",
"tier": "Tier1",
"balance": 15000.00,
"currency": "NGN",
"status": "ACTIVE"
},
"pageMeta": {},
"errors": {}
}
Method 2: Query by Merchant ID
Retrieve all wallets belonging to your merchant account.
Endpoint
GET /waas/WalletManagement/getWalletsById
Request Parameters
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
merchantId | string | Yes | Your unique merchant identifier |
Response
{
"succeeded": true,
"code": "200",
"message": "successful request",
"data": [
{
"accountNumber": "0702334455",
"accountName": "JOHN DOE",
"tier": "Tier1",
"balance": 15000.00,
"currency": "NGN",
"status": "ACTIVE"
}
],
"pageMeta": {},
"errors": {}
}