GET
/
payments
/
{orderReference}
curl --request GET \
  --url https://api.clickpesa.com/third-parties/payments/{orderReference} \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "status": "SUCCESS",
    "paymentReference": "<string>",
    "orderReference": "<string>",
    "collectedAmount": 123,
    "collectedCurrency": "<string>",
    "message": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "customer": {
      "customerName": "<string>",
      "customerPhoneNumber": "<string>",
      "customerEmail": "jsmith@example.com"
    }
  }
]

Authorizations

​
Authorization
string
header
required

Authorization header in the form of Bearer <token>, where <token> is a valid JWT from generate token endpoint

Path Parameters

​
orderReference
string
required

Unique identifier for the payment order

Response

200
application/json
Query Payments by order reference response
​
id
string

Unique transaction ID

​
status
enum<string>

Payment status

Available options:
SUCCESS,
SETTLED,
PROCESSING,
PENDING,
FAILED
​
paymentReference
string

Unique reference for the payment

​
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

Timestamp when payment was last updated

​
createdAt
string

Timestamp when payment was created

​
customer
object