Payment Callback

Structure of the callback response received after a payment is processed.

POST https://your-server.com/your-callback-url

Responses

200 Success

This represents the JSON that will be sent to your callback_url. It contains the ExternalReference that you provided in the request and CheckoutRequestID that was returned in the request response. You can use those to track and update your payments in your system/app.

{
  "forward_url": "",
  "response": {
    "Amount": 10,
    "CheckoutRequestID": "ws_CO_02012026103543427709099876",
    "ExternalReference": "INV-009",
    "MerchantRequestID": "3202-70921557-1",
    "MpesaReceiptNumber": "SAE3YULR0Y",
    "Phone": "+254709099876",
    "ResultCode": 0,
    "ResultDesc": "The service request is processed successfully.",
    "Status": "Success"
  },
  "status": true
}

Try It Out

Please set your authentication token in the sidebar to test this API.

Code Samples

curl -X POST \
  'https://upesipay.com/api/your-callback-url' \
  -H 'Content-Type: application/json'

Payment Callback

Responses

200 Success

Try It Out

Code Samples

Was this page helpful?

Previous

Next