list_payments
Retrieve payment records from the Stream server with filters for status, invoice ID, date range, or search terms to monitor transaction activity.
Instructions
List payments with optional filters.
Filter by statuses (PENDING, PROCESSING, SUCCEEDED, FAILED, CANCELED, UNDER_REVIEW, EXPIRED, SETTLED, REFUNDED), invoice_id, search_term, or a date range (from_date / to_date in ISO-8601).
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": "list_payments"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| limit | No | ||
| statuses | No | ||
| invoice_id | No | ||
| search_term | No | ||
| from_date | No | ||
| to_date | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||