GET
/
payments
/
all
cURL
curl --request GET \
  --url https://api.clickpesa.com/third-parties/payments/all \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "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"
      }
    }
  ],
  "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 payments (YYYY-MM-DD)

​
endDate
string<date>

End date for filtering payments (YYYY-MM-DD)

​
status
enum<string>

Payment status filter

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

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

​
channel
string

Payment channel filter

​
id
string

Payment ID filter

​
orderReference
string

Order reference filter

​
clientId
string

Client ID filter

​
sortBy
string

Field to sort by (default: createdAt). All response fields are sortable including customer 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
​
search
string

Search across specific fields using format: field=keyword,another_field=another_keyword. Available searchable fields: id, status, paymentReference, orderReference, collectedAmount, collectedCurrency, message, createdAt, updatedAt, customer.customerName, customer.customerPhoneNumber, customer.customerEmail. Example: search=customer.customerName=John,collectedCurrency=TZS,status=SUCCESS

Response

200
application/json

Query all payments response

The response is of type object.