Skip to main content

List Daily Balance

Use this endpoint to list the daily balances with filters.

Available Environments​

https://api.gateway.com.br/core

Endpoint​

  • Method: GET
  • Endpoint: /wallet/daily-balance
  • Authentication: Bearer token

Query Params​

ℹ️ Dates in ISO

The startDate and endDate fields must be sent as an ISO date string.

Example:

  • 2026-03-06T12:00:00.000Z
ℹ️ Snapshot pagination

The snapshot is not a pointer to the "next page": it is a fixed identifier of the pagination session, used together with page (which is still sent and incremented normally) to keep the results consistent even if new records are created while you navigate.

Take the snapshot value from the first response (sent without a snapshot on the first request) and resend that same value, unchanged, on the requests for the following pages, along with the same filters and the same perPage used originally. If any of those values changes while an old snapshot is resent, the API returns an error.

NameTypeRequiredDescriptionValidations
snapshotstringNoIdentifier of the pagination session (received in the snapshot field of the first response); resend it unchanged along with page on the following pagesMust match the same filters and the same perPage of the original request
startDatestringNoStart date of the filterMust be an ISO date string
endDatestringNoEnd date of the filterMust be an ISO date string

Request Example​

curl --request GET \
--url https://api.gateway.com.br/core/wallet/daily-balance?startDate=2026-03-06T00:00:00.000Z&endDate=2026-03-06T23:59:59.999Z \
--header 'Authorization: Bearer your-jwt-token'

Success Response​

FieldTypeRequiredDescription
totalPagesnumberYesTotal pages
currentPagenumberYesCurrent page
perPagenumberYesItems per page
snapshotstringNoIdentifier of the pagination session; resend it unchanged on the following pages
dataarrayYesList of balances

Fields of the item in data​

FieldTypeRequiredDescription
idstring (UUID)YesUnique identifier
totalCreditsnumberYesTotal credits (integer, in cents)
totalDebitsnumberYesTotal debits (integer, in cents)
balanceChangenumberYesBalance change (integer, in cents)
openingBalancenumberYesOpening balance (integer, in cents)
closingBalancenumberYesClosing balance (integer, in cents)
datestringYesDate of the day
createdAtstring (ISO)YesCreation date

Response Example​

{
"totalPages": 1,
"currentPage": 1,
"perPage": 15,
"snapshot": "b3BhcXVlLXNuYXBzaG90LXRva2Vu",
"data": [
{
"id": "553e8400-e29b-41d4-a716-436251480000",
"totalCredits": 100000,
"totalDebits": 30000,
"balanceChange": 70000,
"openingBalance": 400000,
"closingBalance": 470000,
"date": "2026-03-06",
"createdAt": "2026-03-06T12:49:04.681Z"
}
]
}

Possible Errors​

CodeDescriptionSolution
401Invalid credentialsCheck your credentials
403No permission/authorizationContact support
422Invalid or missing dataCheck the format of the data
500Internal errorContact support