payments:read or payables:read
Returns every payment the business sent: held, returned, refunded and cancelled ones included, and each split and retry as its own payment.
Query parameters
integer
default:"1"
Page number.
integer
default:"25"
1 to 100.
string
Only payments for this bill, every split and retry included.
string
Only payments to this contact.
string
pending, scheduled, processing, held, completed, failed, returned, cancelled, refund_pending or refunded.string
ISO 8601 time. Created at or after it.
string
ISO 8601 time. Created before it.
Response
200 with { items, totalCount }. Each item is a payment. Items are newest first, with ties in a fixed order, so walking the pages neither repeats nor skips a payment that did not change.
A payment the business recorded outside Cleo (check, wire, cash) has paymentRail: null.