Check Balance
This endpoint allows merchants to retrieve both the closing balance for a specific date and the current balance of their account. It provides the final account balance for the selected day and the real-time balance as of the query moment. The response includes details for both balances, supporting operational and reporting needs.
Request Endpoint
All methods use the same endpoint, differing only in their request payload structure
GET /partners-int/accounts/balance
Path Parameters
| Parameter | Format | Description |
|---|---|---|
| accountUid (optional) | string (UUID) | The specific account ID to retrieve the balance for (optional). If omitted, the balance of the authenticated account will be returned. |
Query Parameters
| Parameter | Format | Description |
|---|---|---|
| filterDate | string (ISO8601) | The specific date for which the closing balance is requested (optional). |
Check Balance for a Specific Account
To retrieve the balance of a specific account, include the accountUid parameter in your GET request. If the accountId is provided, the balance returned will correspond to the specified account, provided the user has the necessary access permissions.
GET {{baseUrl}}/partners-int/accounts/balance/1ac29487-1a20-455d-8a47-1b6c0752ae98
Check current Balance
To retrieve the current balance, send a GET request to the endpoint without specifying the filterDate parameter. The current balance reflects the real-time amount available in the account at the moment of the query.
GET {{baseUrl}}/partners-int/accounts/balance
Check Balance for an specific Date
To retrieve the closing balance for a specific date, include the filterDate parameter in your GET request. The filterDate parameter must be in ISO 8601 format (UTC timezone).
Attention
Always use the zeroed time (00:00:00.000Z) for the desired date. If a client wants to check the closing balance for January 1, 2025, they must use 2025-01-01T00:00:00.000Z.
- Closing balance for January 1, 2025
GET {{baseUrl}}/partners-int/accounts/balance?filterDate=2025-01-01T00:00:00:000Z
- Closing balance for January 2, 2025:
GET {{baseUrl}}/partners-int/accounts/balance?filterDate=2025-01-02T00:00:00.000Z
- Closing balance for January 3, 2025:
GET {{baseUrl}}/partners-int/accounts/balance?filterDate=2025-01-03T00:00:00.000Z
Success Response Fields
| Parameter | Format | Description |
|---|---|---|
| statusCode | string | Status of the request, e.g., "Done". |
| data | object | Contains details of the account balance. |
| data.accountActualBalance | string | Contain the available value in your account. |
Updated 3 days ago