v2

latestOpenAPI 3.0.0raw.githubusercontent.com2026-02-16143114179.4 KB
Customer Portal

List customer payments

Returns a paginated list of all payments made by the customer.

get/api/portal/customers/{externalId}/payments

Path parameters

externalIdstring required

Customer external ID

Query parameters

pagenumber
limitnumber

Response

Paginated payments

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
  }
}