GET
/
payouts
/
{orderReference}
curl --request GET \
  --url https://api.clickpesa.com/third-parties/payouts/{orderReference} \
  --header 'Authorization: Bearer <token>'
[
  {
    "updatedAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "orderReference": "<string>",
    "amount": "<string>",
    "currency": "<string>",
    "fee": "<string>",
    "status": "SUCCESS",
    "channel": "BANK TRANSFER",
    "channelProvider": "<string>",
    "transferType": "ACH",
    "notes": "<string>",
    "beneficiary": {
      "accountNumber": "<string>",
      "accountName": "<string>",
      "swiftNumber": "<string>",
      "routingNumber": "<string>",
      "beneficiaryMobileNumber": "<string>",
      "beneficiaryEmail": "jsmith@example.com"
    }
  }
]

Authorizations

​
Authorization
string
header
required

Authorization header containing the JWT access token returned from the generate token endpoint. The token already includes the Bearer prefix. Example: Authorization: Bearer eyJhbGciOi...

Path Parameters

​
orderReference
string
required

Unique identifier for the payout order

Response

200
application/json

Query Payout Response

The response is of type object[].