List payments
list_paymentsRetrieve organization payments with status, amount, method, payor, invoice and patient IDs, and refunds. Filter by patient or paid_at date range to review payment history.
Instructions
Payments in the Organization with status, amount (minor currency units), method type, payor type, invoice and patient ids and any refunds. Filters sent as documented: patient_id, paid_at_from, paid_at_to (UTC; payments with no paid_at are omitted when a bound is set). Stored card details are never returned.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | next_cursor from a previous call, to continue where it stopped (send the same filters) | |
| paid_at_to | No | Inclusive upper bound for paid_at, YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DD (a bare date means the end of that day) | |
| patient_id | No | ||
| max_results | No | Maximum number of records to return (pages of up to 100 are fetched until this is reached) | |
| paid_at_from | No | Inclusive lower bound for paid_at, YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DD | |
| include_contact_details | No | Include nothing extra (internal notes are the practice's own text), and stop redacting email addresses, phone numbers, NHS-number-shaped digit groups and UK postcodes typed into names and other text |