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. Cursor for the previous page. Contains 'before' (ID) and 'per_page' (page size) parameters. Use these values in the 'before' and 'per_page' parameters of the next request to get the previous page.
page
array<object.entry>

Always present. The current page of records, ordered by creation date (newest first).
next
object

Nullable. Cursor for the next page. Contains 'after' (ID) and 'per_page' (page size) parameters. Use these values in the 'after' and 'per_page' parameters of the next request to get the next page.
Entry attributes
Attribute Description
entry_id
string

Always present. Unique identifier of this ledger entry.
transaction_id
string

Always present. Unique identifier of the transaction that contains this entry.
direction
string

Always present. Whether this entry is a credit or debit for the balance.

Possible values:
  • CREDIT
  • DEBIT
type
string

Always present. Entry name (e.g. ADD_PREFUND, INVOICE, PAY_OUT.
amount
number

Always present. Entry amount in currency subunits (always positive; use direction for sign semantics).
currency
string

Always present. ISO currency code.
status
string

Always present. Lifecycle status of the entry at the time of the request.

Possible values:
  • ON_HOLD
  • EFFECTIVE
  • CANCELED
invoice_id
string

Nullable. Invoice ID when this entry's transaction is linked to an invoice.
statement_id
string

Nullable. Merchant statement ID when this entry's transaction is linked to a statement.
payout_id
string

Nullable. Payout ID when this entry's transaction is linked to a payout.
topup_id
string

Nullable. Topup ID when this entry's transaction is linked to a topup.
dispute_id
string

Nullable. Dispute ID when this entry's transaction is linked to a dispute.
parent_id
string

Nullable. Payment ID when this entry's transaction is linked to a dispute.
parent_type
string

Nullable. Parent object type when this entry's transaction is linked to a dispute.

Possible values:
  • PAYMENT
created_at
number

Always present. Unix timestamp when the entry was created.
effective_at
number

Nullable. Unix timestamp when the entry became effective for the ledger, if applicable.
canceled_at
number

Nullable. Unix timestamp when the entry was canceled, if applicable.
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.