List charges
charges_listList charges newest first to review payment activity, filter by status, paid token or network, creation time, or overpayment, and paginate results with a cursor.
Instructions
List this environment's charges, newest first, optionally filtered by status, paid token/network, creation time (since) or isOverpaid. Paginate with limit and the previous page's nextCursor. metadata is left out unless includeMetadata is true.
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": "charges_list"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Max items to return per page (1–100, default 20). | |
| since | No | Only return charges created at or after this timestamp (filters on `createdAt`, not on when the status last changed). If polling as a fallback for missed webhooks, use a window at least as wide as the longest `expiresIn` your charges use, or you can miss a long-lived charge that changed status outside a narrower window. | |
| token | No | Filters on `paidWith.token` — the pair actually paid, not accepted. | |
| cursor | No | Opaque — pass the previous response's `nextCursor` verbatim to fetch the next page. Never construct or parse this value yourself; its shape is not part of the public contract and may change. | |
| status | No | Payment progress, from the payer side. `pending`: created, nothing received yet. `partially_paid`: some funds received, less than `amount`. `confirmed`: full amount received (or more — see `isOverpaid`). `expired`: `expiresAt` passed with zero funds received. `underpaid`: `expiresAt` passed while `partially_paid`. Every status is reached automatically, on its own timeline — there is no merchant-initiated cancellation. This never reflects whether funds actually reached the merchant — see `settlementStatus` for that. | |
| network | No | Filters on `paidWith.network` — the pair actually paid, not accepted. | |
| isOverpaid | No | ||
| includeMetadata | No | Include each charge's free-form `metadata` object (merchant-supplied data, may hold customer details). Omitted unless true. |