GET
/
payouts
/
all
cURL
curl --request GET \
  --url https://api.clickpesa.com/third-parties/payouts/all \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "updatedAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "orderReference": "<string>",
      "amount": "<string>",
      "currency": "<string>",
      "fee": "<string>",
      "status": "SUCCESS",
      "exchanged": true,
      "exchange": {
        "sourceCurrency": "USD",
        "targetCurrency": "TZS",
        "sourceAmount": 1000,
        "rate": 2500
      },
      "channel": "BANK TRANSFER",
      "channelProvider": "<string>",
      "settlementType": "ACH",
      "notes": "<string>",
      "beneficiary": {
        "accountNumber": "<string>",
        "accountName": "<string>",
        "swiftNumber": "<string>",
        "routingNumber": "<string>",
        "beneficiaryMobileNumber": "<string>",
        "beneficiaryEmail": "jsmith@example.com"
      }
    }
  ],
  "totalCount": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
startDate
string<date>

Start date for filtering payouts . Accepted formats : YYYY-MM-DD or DD-MM-YYYY

​
endDate
string<date>

End date for filtering payouts . Accepted formats : YYYY-MM-DD or DD-MM-YYYY

​
channel
enum<string>

Payout channel filter

Available options:
BANK TRANSFER,
MOBILE MONEY
​
currency
string

Currency filter (e.g., TZS, USD)

​
orderReference
string

Order reference filter

​
status
enum<string>

Payout status filter

Available options:
SUCCESS,
PROCESSING,
PENDING,
FAILED,
REFUNDED,
REVERSED
​
transferType
enum<string>

Settlement type filter

Available options:
ACH,
RTGS
​
clientId
string

Client ID filter

​
sortBy
string

Field to sort by (default: createdAt). All response fields are sortable including beneficiary fields

​
orderBy
enum<string>
default:DESC

Sort order (default: DESC)

Available options:
ASC,
DESC
​
skip
integer
default:0

Number of records to skip for pagination

Required range: x >= 0
​
limit
integer
default:20

Number of records to return

Required range: x >= 1

Response

Query all payouts response

​
data
object[]

Array of payout records

​
totalCount
integer

Total number of payouts matching the query criteria