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

# GET /payouts/all

`GET /payouts/all`

Query all payouts with filtering, sorting, and pagination capabilities

## Query parameters

- `startDate` string, date
- `endDate` string, date
- `channel` 'BANK TRANSFER' | 'MOBILE MONEY'
- `currency` string
- `orderReference` string
- `status` 'SUCCESS' | 'PROCESSING' | 'PENDING' | 'FAILED' | 'REFUNDED' | 'REVERSED'
- `transferType` 'ACH' | 'RTGS'
- `clientId` string
- `sortBy` string
- `orderBy` 'ASC' | 'DESC'
- `skip` integer
- `limit` integer

## Response `200`

Query all payouts response

- PayoutsListResponse
  - `data` PayoutResponse[] — Array of payout records
    - `updatedAt` string, date-time — Last updated timestamp
    - `createdAt` string, date-time — Creation timestamp
    - `id` string — Payout ID
    - `orderReference` string — Associated order reference
    - `amount` string — Payout amount
    - `currency` string — Currency code
    - `fee` string — Transaction fee
    - `status` 'SUCCESS' | 'PROCESSING' | 'PENDING' | 'FAILED' | 'REFUNDED' | 'REVERSED' — Payout 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
    - `channel` 'BANK TRANSFER' | 'MOBILE MONEY' — Payment channel
    - `channelProvider` string — Name of the payment provider
    - `settlementType` 'ACH' | 'RTGS' — Settlement type if applicable
    - `notes` string — Additional notes if available
    - `beneficiary` object
      - `accountNumber` string — Beneficiary's account number
      - `accountName` string — Beneficiary's account name
      - `swiftNumber` string — SWIFT number if applicable
      - `routingNumber` string — Routing number if applicable
      - `beneficiaryMobileNumber` string — Beneficiary's mobile number if applicable
      - `beneficiaryEmail` string, email — Beneficiary's email if applicable
  - `totalCount` integer — Total number of payouts 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)