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

Filter Payouts

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

This endpoint provides comprehensive search functionality using the SearchIndex infrastructure, allowing you to filter payouts by various criteria including status, payout method, currency, amount ranges, and date ranges.

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

Features:

  • Full-text search: Search across payout content
  • Advanced filtering: Filter by status, payout method, currency, amount, and dates
  • Date range support: Support for specific dates, datetimes, date ranges, datetime ranges, and keywords
  • Pagination: Efficient cursor-based pagination
  • Merchant-scoped: Only returns payouts 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-payouts HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer <token>
{
per_page: number?,
page: number?,
status: string?,
created_at: string?,
paid_at: string?,
sent_at: string?,
payout_method: string?,
currency: string?,
amount: string?,
bank_code: string?,
contact_id: string?,
terms: 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 payouts to return per page. Default: 10, Maximum: 100

page number

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

status string

Optional. Filter by payout status. Examples: 'PENDING', 'SENT', 'SUCCESSFUL', 'FAILED', 'CANCELLED'

Allowed values:
  • PENDING
  • SENT
  • SUCCESSFUL
  • FAILED
  • CANCELLED
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)

paid_at string

Optional. Filter by paid 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)

sent_at string

Optional. Filter by sent 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)

payout_method string

Optional. Filter by payout method name.

currency string

Optional. Filter by currency code. Examples: 'THB', 'USD'. Case-insensitive.

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).

bank_code string

Optional. Filter by bank code.

contact_id string

Optional. Filter by contact ID. Accepts either internal UID (starting with ctc_ ) or external ID. Examples: ctc_1234567890 or ext_1234567890

terms string

Optional. Full-text search across payout content. Searches payout method names. Uses fuzzy matching for partial text matches.

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<object.payout>

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.
Payout attributes
Attribute Description
payout_id
string

Always present. The ID of the payout.
external_id
string

Nullable. The external ID of the payout.
status
string

Always present. The current status of the payout.

Possible values:
  • SUCCESSFUL
  • SENT
  • PENDING
  • FAILED
  • CANCELLED
amount
number

Always present. The payout amount in subunits.
currency
string

Always present. The currency code of the payout.
created_at
number

Always present. The timestamp when the payout was created.
paid_at
number

Nullable. The timestamp when the payout was settled/paid.
sent_at
number

Nullable. The timestamp when the payout was sent.
bank_account_id
string

Nullable. The ID of the bank account for the payout.
bank_code
string

Nullable. The bank code identifying the financial institution.
bank_account_number
string

Nullable. The bank account number.
bank_account_name
string

Nullable. The name of the account holder.
bank_country_code
string

Nullable. The ISO country code where the bank account is located.
payout_method
string

Nullable. The payout method name.
mobile_number
string

Nullable. The mobile number for PromptPay payouts (when payout_method is mobile_number).
national_id
string

Nullable. The national ID for PromptPay payouts (when payout_method is national_id).
fees
array<object.fee>

Always present. The fees associated with the payout.
ref1
string

Nullable. The first custom reference (e.g., internal payout ID).
Fee attributes
Attribute Description
fee_id
string

Always present. The ID of the fee.
kind
string

Always present. The type of fee.

Possible values:
  • dispute
  • payment
  • payout
  • plan
  • refund
parent_id
string

Always present. The ID of the billable item that this fee is attached to. For example, if the fee is a dispute fee, this would be the ID of the dispute.
billing_code
string

Always present. The billing code of the fee.
unit_amount
number

Always present. The unit amount of the fee, in subunits. I.e. how much is billed for each unit of the fee.
percentage_amount
number

Always present. The percentage amount of the fee, in subunits. E.g. With a percentage_fee of 4%, a payment of 1000 THB would have a percentage_amount of 40_00.
discount_applied
boolean

Always present. Whether the fee has been discounted.

Possible values:
  • true
  • false
statement_id
string

Always present. The ID of the statement that this fee is attached to.
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-payouts" \
  -X POST
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $(RESERVEPAY_API_KEY)" \
  -d '{
        "amount": "1000..5000",
        "status": "FAILED"
      }'
Learn how to run these code samples in your terminal by reading our guide.