Get Wallet API

The Get Wallet API fetches users wallets based on the specified currency and country parameters.

Endpoint

GET https://{{baseURL}}/v1/wallet?currency={currency}&country={country}

This API requires two query parameters: currency and country.

Query Parameters

Headers

Request Example

curl --location --request GET 'https://{{baseURL}}/v1/wallet?currency=NGN&country=NG' \
--header 'x-api-key: API_KEY_SANDBOX:Zg0hBvVl.Ra!MS.XS$H5QGEqhbASpBPn49fl08!qHYuPh7U5MeGFzAyMBj8!R1ir' \
--header 'Content-Type: application/json'

Sucessful Response Example (200k)

If the request is successful, the API returns the following JSON response:

{
    "message": "wallets fetched successfully",
    "status": "success",
    "data": [
        {
            "id": "abd2de64-a226-4405-8731-7b42fd937914",
            "balance": 23094071.00,
            "currency": "NGN",
            "country": "NG"
        }
    ]
}

Response Breakdown

General Information

Data Details

Key Takeaways

• The user can fetch the wallet balance by providing the currency and country query parameters.
• The response includes the wallet balance along with the currency and country information.
• The API returns a 200 OK status if the wallet data is successfully retrieved.

Best Practices

✅ Include a valid x-api-key in the request headers to authenticate the request.
✅ Ensure that the currency and country parameters are valid and correctly formatted.
✅ Handle potential errors in case the wallet data is not found or the request fails.

Error Handling