Querying For Payments

Every payment has order reference. This could be added from

1. Offline order reference

2. Checkout link order reference added through:

   1. Checkout link widget

   2. Hosted checkout

   3. Added directly to payment through api integration type (Collection API)

This endpoint allows querying payments using a unique order reference.

GET /third-parties/payments/[YOUR_UNIQUE_ORDER_REFERENCE]

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Response

200

[
     {
          
          "id": "LCPP5L399C",
          "status": "SUCCESS",
          "paymentReference": "EC12333.9091.67600HF",
          "orderReference": "ORD13908510",
          "collectedAmount": 2000,
          "collectedCurrency": "TZS",
          "message": "Payment received successfully.",
          "updatedAt": "2024-04-10T18:22:56.153Z",
          "createdAt": "2024-04-10T18:22:16.949Z",
          "customer": {
            "customerName": "Julius Nyerere",
            "customerPhoneNumber": "255755009909",
            "customerEmail": "[e-mail]", // for customers with emails 
          }    
     }
]

404

{
  "message": "Invalid or missing payment:  [YOUR_UNIQUE_ORDER_REFERENCE]"
}

There are different payment status such as SUCCESS, SETTLED, PROCESSING, PENDING, FAILED. Payments with SUCCESS or SETTLED status are the one that were made successfully, the difference is SUCCESS represents successfully made payment that has not been settled to merchant account yet while SETTLED means the funds are already settled.