Search payments
search_paymentsFind account payments by status, external reference, payer email, or date range, with sorting and paging. Returns compact summaries by default for quick review.
Instructions
Search payments on the account by status, external_reference, payer email, and date range. Returns paging info and compact summaries unless compact=false.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "search_payments"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Sort field | date_created |
| limit | No | Page size (1-100) | |
| range | No | Date field that begin_date/end_date apply to. Defaults to date_created | |
| offset | No | Results to skip | |
| status | No | Filter by payment status | |
| compact | No | Return a short summary per payment instead of the full payload | |
| criteria | No | Sort direction | desc |
| end_date | No | End of the range: ISO 8601 or NOW. Defaults to NOW when begin_date is set | |
| begin_date | No | Start of the range: ISO 8601 or relative like NOW-7DAYS. Date-only values use 00:00 UTC | |
| payer_email | No | Filter by payer email | |
| external_reference | No | Your own order reference sent when the payment was created |