Skip to main content

ListPayments retrieves all payments for the organization.

GET 
/api/v1/billing/payments

Returns paginated payment history with extensive filtering options. Useful for transaction history, reconciliation, and reporting.

Authorization​

Requires billing:read permission.

Filtering​

  • status: Filter by payment status
  • gateway: Filter by payment gateway (mpesa, stripe, manual)
  • payment_method: Filter by method (stk_push, bank_transfer, etc.)
  • type: Filter by payment type (wallet_topup, invoice_payment)
  • date range: Filter by created_at date

Response​

Returns paginated list of Payment objects sorted by created_at desc.

Request​

Responses​

A successful response.