The Ubiqpay Balance API allows you to check the balance of your account in different currencies. This document will guide you through the process of using our API to retrieve your account balance.
Response Parameters
The response to a request to the Ubiqpay Balance API will be in JSON format, with the following parameters:
| Parameter | Type | Description |
|---|---|---|
| status_code | string | The status of the request, either "success" or "error" |
| message | string | A message describing the status of the request |
| data | object | An object containing the account balance |
The data object can contain multiple keys, each corresponding to a different currency. Each currency key contains an object with a single property:
| Property | Type | Description |
|---|---|---|
| balance | number | The balance of the account in the specified currency |
| updated_at | string | Balance update date in ISO format |
If a currency does not appear in the response, there has been no transaction in that currency. Once a transaction is made in a new currency, the currency will appear in the response.
Example Response
Here's an example of a successful response to the Ubiqpay Balance API:
{
"status_code": "success",
"message": "Request successfully processed",
"data": {
"KE": {
"KES": {
"balance": 213.45,
"updated_at": "2023-05-29T10:34:13.000Z"
}
},
"NG": {
"NGN": {
"balance": 50.00,
"updated_at": "2023-05-29T10:34:13.000Z"
}
}
}
}
In this example, the account balance is available in three currencies: KES and NGN. The account balance in each currency is shown in the corresponding currency object.
If you have any questions or need assistance with using the Ubiqpay Balance API, don't hesitate to contact our support team for assistance.