API references
Search documentation... ⌘K
Open merchant dashboard
Merchant API
All our references

Balance history

Returns a paginated list of ledger entries for the merchant's default balance, newest first. Each row includes the owning transaction (transaction_id) alongside the entry fields. There is no time window: all entries for the balance are included, ordered by recency.

The response includes cursor-based pagination with previous and next cursors that can be used to navigate through the balance history.

Endpoint signature
This endpoint requires an API key. Read our authentication guide for more information.
POST https://api.reservepay.com/merchants/balance-history HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer <token>
{
per_page: number?,
after: string?,
before: string?,
}
Returns: object
New to Reservepay? Read our guide on how to call endpoints to get started. Note that this endpoint returns a paginated response, see the Pagination section of the same guide.
Request arguments
per_page number

Optional. Number of entries to return per page (default: 25).

after string

Optional. Cursor for pagination - return entries created before this entry ID.

before string

Optional. Cursor for pagination - return entries created after this entry ID.

Response attributes
Attribute Description
previous
object

Nullable. Pagination for the previous page. Contains 'before' (page number) and 'per_page' (page size) parameters. Use these values in the 'page' and 'per_page' parameters of the next request to get the previous page. Returns null if there is no previous page.
page
array

Always present. The current page of records, ordered by creation date (newest first). Each record is serialized according to the specified record_serializer option.
next
object

Nullable. Pagination for the next page. Contains 'after' (page number) and 'per_page' (page size) parameters. Use these values in the 'page' and 'per_page' parameters of the next request to get the next page. Returns null if there is no next page.
Errors specific to this endpoint
NOT_FOUND

No balance exists for this merchant.

Errors common to all endpoints
UNHANDLED_ERROR

This error occurs when the server encounters an unexpected internal error that it cannot handle gracefully. This typically happens due to bugs, infrastructure issues, or edge cases that weren't anticipated during development.

INVALID_ARGUMENTS

This error occurs when the request contains invalid or missing parameters. Common cases include missing required fields, or values that don't match the expected format or type.

BAD_VERSION

This error occurs when making requests to an API version that does not exist. This commonly happens when using an outdated SDK or when the API version specified in the request URL is incorrect.

Open in Markdown
CODE SAMPLES
curl
curl "https://api.reservepay.com/merchants/balance-history" \
  -X POST
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $(RESERVEPAY_API_KEY)" \
  -d '{}'
Learn how to run these code samples in your terminal by reading our guide.