Actions27
- Payment Actions
- Payout Actions
- Swap Actions
- Common Actions
Payment → Search Payments
AI-generatedSummary
Search for payment transactions using various filters and pagination options to retrieve a list matching specified criteria.
Inputs
- Filters — Optional filters to narrow down payments by track ID, type (invoice, white label, static address), status, pay currency, currency, network, address, date range (from_date, to_date), amount range (from_amount, to_amount), and sorting options (sort_by and sort_type).
- Page — The page number of the results to retrieve; defaults to 1.
- Page Size — Number of payment records to fetch per page; defaults to 10, maximum is 200.
Output shape
A list of payment transaction records matching the applied filters and pagination parameters.
Supports filtering by multiple optional criteria; if filters are not provided, the operation returns payments without filtering. The results are paginated according to page and page size inputs.
Examples
Example 1: Search payments filtered by status 'paid' and sorted by pay date descending on page 1 with 10 records per page
Set Filters to status=paid, sort_by=pay_date, sort_type=desc, page=1, size=10.