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

Filter Topups

Returns a paginated list of topups for the authenticated merchant with advanced filtering capabilities.

This endpoint provides comprehensive search functionality using the SearchIndex infrastructure, allowing you to filter topups by funding type (manual or virtual account), virtual account number, amount ranges, and date ranges.

The response includes pagination controls with previous and next cursors that can be used to navigate through the topup history efficiently.

Features:

  • Funding type: Filter by manual transfers or virtual account topups
  • Virtual account: Filter by the virtual account number that received the funds
  • Amount ranges: Filter by an exact amount or a range
  • Date range support: Support for specific dates, datetimes, date ranges, datetime ranges, and keywords
  • Pagination: Efficient cursor-based pagination
  • Merchant-scoped: Only returns topups for the authenticated merchant
Endpoint signature
This endpoint requires an API key. Read our authentication guide for more information.
POST https://api.reservepay.com/merchants/filter-topups HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer <token>
{
per_page: number?,
page: number?,
type: string?,
virtual_account_number: string?,
amount: string?,
created_at: 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 topups to return per page. Default: 10, Maximum: 100

page number

Optional. Page number for pagination. Default: 1 (first page)

type string

Optional. Filter by funding type. 'MANUAL' for direct transfers, 'VIRTUAL_ACCOUNT' for topups received through a virtual account.

Allowed values:
  • MANUAL
  • VIRTUAL_ACCOUNT
virtual_account_number string

Optional. Filter by the virtual account number that received the funds. Only matches virtual account topups.

amount string

Optional. Filter by amount. Supports: exact amount (1000), range (1000..5000), or boundless ranges (1000.. or ..5000). Amounts are in the smallest currency unit (cents for USD).

created_at string

Optional. Filter by creation date/time. Supports: specific date (YYYY-MM-DD), datetime (ISO8601), date range (YYYY-MM-DD..YYYY-MM-DD), datetime range (ISO8601..ISO8601), or keywords (today, yesterday, this_week, last_week, this_month, last_month)

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 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/filter-topups" \
  -X POST
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $(RESERVEPAY_API_KEY)" \
  -d '{
        "amount": "1000..5000"
      }'
Learn how to run these code samples in your terminal by reading our guide.