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>",
    "settlementType": "ACH",
    "notes": "<string>",
    "beneficiary": {
      "accountNumber": "<string>",
      "accountName": "<string>",
      "swiftNumber": "<string>",
      "routingNumber": "<string>",
      "beneficiaryMobileNumber": "<string>",
      "beneficiaryEmail": "jsmith@example.com"
    }
  }
]

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
orderReference
string
required

Unique identifier for the payout order

Response

200
application/json
Generate Checkout Link Response
​
updatedAt
string

Last updated timestamp

​
createdAt
string

Creation timestamp

​
id
string

Payout ID

​
orderReference
string

Associated order reference

​
amount
string

Payout amount

​
currency
string

Currency code

​
fee
string

Transaction fee

​
status
enum<string>

Payout status

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

Payment channel

Available options:
BANK TRANSFER,
MOBILE MONEY
​
channelProvider
string

Name of the payment provider

​
settlementType
enum<string>

Settlement type if applicable

Available options:
ACH,
RTGS
​
notes
string

Additional notes if available

​
beneficiary
object