This endpoint retrieves all available wallets for a merchant or user account. Each wallet represents a balance in a specific currency (e.g., NGN for Nigerian Naira, USD for US Dollar). The response includes a list of wallets with their balances, currency codes, and other relevant information. This is useful for displaying all available currency balances to the user before initiating transactions.
Request
Method: GET
URL: /v2/transactions/wallets
Query Parameters: None
Body: None
Notes: This request is read-only and does not affect the wallet state.
Responses
200 OK – Successful
{
"data": [
{
"balance": 3470577.33,
"currency": "NGN"
},
{
"balance": 1500.00,
"currency": "USD"
}
],
"statusCode": "00",
"message": "Successful"
}
Field Descriptions:
- data (array) – List of wallets available for the account.
- balance (number) – The current wallet balance available for use in this currency.
- currency (string) – The three-letter ISO 4217 currency code for the wallet.
- statusCode (string) – Provider-specific status code (
"00"indicates success). - message (string) – Human-readable message indicating the outcome.
401 Unauthorized
Returned when the request is not authorized.
Unauthorized
403 Forbidden
Returned when the user does not have permission to access this resource.
Forbidden
500 Internal Server Error
Returned when the server encounters an unexpected condition.
Internal Server Error
Example cURL Request
curl -X GET \
'https://{baseUrl}/v2/transactions/wallets' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||