listAllPayments
listAllPaymentsRetrieve a paginated list of all payments and refunds with filters by customer, amount, status, date, and more, plus sorting.
Instructions
Retrieve a paginated list of all payments, including refund records, with extensive filtering and sorting options.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | The cursor for pagination. | |
| limit | No | Maximum number of payments to return per page (defaults to 10). | |
| search | No | General search query. | |
| sort_key | No | Key to sort the results by (e.g., 'id'). | |
| sort_type | No | Sort order type (e.g., 'asc'). | |
| order | No | Order of results (e.g., '-created_at'). | -created_at |
| id | No | Filter by payment ID. | |
| customer_id | No | Filter by customer ID. | |
| connector_id | No | Filter by connector ID. | |
| external_id__ilike | No | Case-insensitive partial match for external ID. | |
| payment_method | No | Filter by payment method (e.g., 'card', 'cash', 'bank_transfer'). | |
| type | No | Filter by payment type (e.g., 'payment', 'refund'). | |
| amount__gte | No | Filter by amount greater than or equal to. | |
| amount__lte | No | Filter by amount less than or equal to. | |
| amount_refunded__gte | No | Filter by amount refunded greater than or equal to. | |
| amount_refunded__lte | No | Filter by amount refunded less than or equal to. | |
| currency_code__ilike | No | Case-insensitive partial match for currency code. | |
| receipt_number__ilike | No | Case-insensitive partial match for receipt number. | |
| status | No | Filter by payment status (e.g., 'success', 'failed'). | |
| autocharge | No | Filter by auto-charge status. | |
| parent_id | No | Filter by parent payment ID. | |
| timestamp__gte | No | Filter by timestamp greater than or equal to (Unix time). | |
| timestamp__lte | No | Filter by timestamp less than or equal to (Unix time). | |
| created_at__gte | No | Filter by creation date greater than or equal to (ISO 8601). | |
| created_at__lte | No | Filter by creation date less than or equal to (ISO 8601). | |
| invoice__id | No | Filter by associated invoice ID. | |
| invoice__bill_for_date__gte | No | Filter by invoice billing date greater than or equal to (ISO 8601). | |
| invoice__bill_for_date__lte | No | Filter by invoice billing date less than or equal to (ISO 8601). | |
| invoice__approved_at__gte | No | Filter by invoice approval date greater than or equal to (ISO 8601). | |
| invoice__approved_at__lte | No | Filter by invoice approval date less than or equal to (ISO 8601). | |
| customer__business_entity_id | No | Filter by customer's business entity ID. | |
| __userContext | No | Internal user context for multi-tenant authentication and approval workflow |