---
title: "GET /payments/all"
method: GET
path: "/payments/all"
---

# GET /payments/all

`GET /payments/all`

Query all payments with filtering, sorting, and pagination capabilities

## Query parameters

- `startDate` string, date
- `endDate` string, date
- `status` 'SUCCESS' | 'SETTLED' | 'PROCESSING' | 'PENDING' | 'FAILED'
- `collectedCurrency` string
- `channel` string
- `orderReference` string
- `clientId` string
- `sortBy` string
- `orderBy` 'ASC' | 'DESC'
- `skip` integer
- `limit` integer

## Response `200`

Query all payments response

- PaymentsListResponse
  - `data` PaymentResponse[] — Array of payment records
    - `id` string — Unique transaction ID
    - `status` 'SUCCESS' | 'SETTLED' | 'PROCESSING' | 'PENDING' | 'FAILED' — Payment status
    - `exchanged` boolean — Indicates if currency conversion was applied (true when source currency differs from receiving currency)
    - `exchange` object — Exchange rate details (only present when exchanged is true)
      - `sourceCurrency` string — Source currency for the exchange
      - `targetCurrency` string — Target currency for the exchange
      - `sourceAmount` number — Amount in source currency
      - `rate` number — Exchange rate used for conversion
    - `paymentReference` string — Unique reference for the payment
    - `paymentPhoneNumber` string — Sender's phone number (only available for USSD Push Payment requests and BillPay Payment requests)
    - `orderReference` string — Order reference associated with the payment
    - `collectedAmount` integer — Amount collected
    - `collectedCurrency` string — Currency in which payment was collected
    - `message` string — Message describing payment status
    - `updatedAt` string, date-time — Timestamp when payment was last updated
    - `createdAt` string, date-time — Timestamp when payment was created
    - `customer` object
      - `customerName` string — Customer's full name
      - `customerPhoneNumber` string — Customer's phone number
      - `customerEmail` string, email — Customer's email (if available)
  - `totalCount` integer — Total number of payments matching the query criteria

## Other responses

- `400` — Bad request
- `401` — Invalid or Expired Token

---

[API](https://skmtc.net/clickpesa/apis/core-api-openapi-specification.md) · [All operations](https://skmtc.net/clickpesa/apis/core-api-openapi-specification/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/clickpesa/core-api-openapi-specification/versions/9f70f35c5590/schema)