Filter Payments
Returns a paginated list of payments for the authenticated merchant with advanced filtering capabilities.
This endpoint provides comprehensive search functionality using the SearchIndex infrastructure, allowing you to filter payments by various criteria including status, payment 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 payment history efficiently.
Features:
- Full-text search: Search across payment content
- Advanced filtering: Filter by status, payment method, currency, amount, contact, dates, and fraud finding
- Contact filtering: Filter by contact internal ID or external ID
- Date range support: Support for specific dates, datetimes, date ranges, datetime ranges, and keywords
- Pagination: Efficient cursor-based pagination
- Merchant-scoped: Only returns payments for the authenticated merchant
per_page
number
Optional. Number of payments to return per page. Default: 10, Maximum: 100
page
number
Optional. Page number for pagination. Default: 1 (first page)
status
string
Optional. Filter by payment status. Examples: 'PENDING', 'SUCCESSFUL', 'AUTHORIZED', 'VOIDED', 'REVERSED', 'FAILED'
Allowed values:PENDINGSUCCESSFULAUTHORIZEDVOIDEDREVERSEDFAILED
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)
captured_at
string
Optional. Filter by capture 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)
payment_method
string
Optional. Filter by payment method name. Examples: 'card', 'promptpay', 'k_plus'
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).
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 payment content. Searches payment method names, and customer email addresses. Uses fuzzy matching for partial text matches. Examples: 'visa', 'stripe', 'john@example.com'
fraud_finding
string
Optional. Filter by fraud finding result. Examples: 'safe', 'risky'
Allowed values:saferisky
| Attribute | Description |
|---|---|
previousobject
|
Pagination for the previous page. Contains 'before' (page number) and 'perpage' (page size) parameters. Use these values in the 'page' and 'perpage' parameters of the next request to get the previous page. Returns null if there is no previous page. |
pagearray
|
The current page of records, ordered by creation date (newest first). Each record is serialized according to the specified record_serializer option. |
nextobject
|
Pagination for the next page. Contains 'after' (page number) and 'perpage' (page size) parameters. Use these values in the 'page' and 'perpage' parameters of the next request to get the next page. Returns null if there is no next page. |
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.