Payments
List payments
Retrieve a paginated list of payments. Supports filtering by status, provider, invoice, and date range.
get/api/payments
Query parameters
statusstring
providerstring
invoiceIdstring
dateFromstring
dateTostring
pagenumber
limitnumber
Response
Paginated list of payments with invoice and customer details
Example response
{
"data": [
{
"id": "clx1234567890",
"invoiceId": "clxinv123",
"provider": "paystack",
"providerTransactionId": "PAY_txn_abc123",
"amount": "99.9900",
"currency": "USD",
"status": "SUCCEEDED",
"failureReason": "Insufficient funds"
}
],
"meta": {
"total": 150,
"page": 1,
"limit": 20,
"totalPages": 8
}
}