List payments
list_paymentsRetrieve and filter payments by status, customer, reference, virtual account, amount, or creation date to locate and review transaction records.
Instructions
List payments.
List payments. Filter by status, customer, reference, virtual_account, amount received (amount[gte], amount[lte], in kobo) and creation time. Add expand[]=customer to embed the customer object.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Search: a payment id (pay_…), reference (starts with), account number (starts with) or va_…, customer id (cus_…), email, phone or name (starts with), split rule id (spl_…), or the transfer reference or session id of the transfer that paid it | |
| limit | No | Number of objects to return | |
| amount | No | Amount received (kobo), e.g. amount[gte]=100000 | |
| expand | No | Embed related objects instead of their ids. `customer` embeds the customer. | |
| status | No | Only objects with this status. | |
| created | No | Filter on creation time, e.g. created[gte]=2026-01-01T00:00:00Z | |
| customer | No | Only objects of this customer (`cus_…`). | |
| reference | No | Only the payment with this reference. | |
| ending_before | No | Cursor: return objects created after this object id (newer) | |
| starting_after | No | Cursor: return objects created before this object id (older) | |
| virtual_account | No | Payments into this virtual account (va_…) |