List payments
GET
apiKeyheader
AuthorizationBearer <token>An API key (blk_…) from Settings → API keys.
page?integerRange
1 <= value <= 100000Default
1pageSize?integerRange
1 <= value <= 100Default
25sort?stringMatch
^[A-Za-z]+:(asc|desc)$invoiceId?stringMatch
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Format
uuidclientId?stringMatch
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Format
uuidstatus?stringValue in
"completed""refunded"q?stringLength
length <= 100application/json- response
items*array<>total*integerRange
-9007199254740991 <= value <= 9007199254740991page*integerRange
-9007199254740991 <= value <= 9007199254740991pageSize*integerRange
-9007199254740991 <= value <= 9007199254740991curl -X GET 'https://your-billleaf-api/v1/payments'Example Response200
{ "items": [ { "id": "string", "invoiceId": "string", "invoiceNumber": "string", "clientId": "string", "clientName": "string", "amount": -9007199254740991, "currency": "string", "paidOn": "2019-08-24", "method": "bank_transfer", "reference": "string", "notes": "string", "status": "completed", "refundedAt": "2019-08-24T14:15:22Z", "refundReason": "string", "receiptId": "string", "receiptNumber": "string", "receiptLastSentAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z" } ], "total": -9007199254740991, "page": -9007199254740991, "pageSize": -9007199254740991}