Checkout Callback Request

POST

/checkout/cart

This document describes how to handle merchant-provided URL callbacks.

Used by the system to notify the merchant about the status of a transaction asynchronously.

Response:
Return HTTP 200 OK to acknowledge that the callback has been received successfully.

Security:
Optional: validate a secret signature/hash if provided in query string or headers.

Request

Authorization

Body Params application/jsonRequired

Examples

Responses

🟢200Success

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location '/checkout/cart' \
--header 'Content-Type: application/json' \
--data '{
    "originatorConversationId": "string",
    "checkoutReference": "string",
    "checkoutRouteId": "string",
    "checkoutRouteChannelType": 0,
    "checkoutNotes": "string",
    "checkoutCurrencyCode": 0,
    "checkoutCurrencyName": "string",
    "checkoutDueDate": "string",
    "checkoutReturnUrl": "string",
    "checkoutCancelUrl": "string",
    "checkoutCallbackUrl": "string",
    "checkoutAccountNo": "string",
    "checkoutRequestLines": [
        {
            "sku": "string",
            "name": "string",
            "price": 0
        }
    ],
    "checkoutOutcome": {
        "Status": 0,
        "StatusDesc": "string",
        "ResultCode": "string",
        "ResultDesc": "string",
        "ThirdPartyPayload": {
            "ResponseCode": "string",
            "ResponseDesc": "string",
            "Reference": "string"
        }
    }
}'

Response Example

{
    "id": "cf8c67ee-e833-f111-bc6a-0e7d952d79b7",
    "originatorConversationId": "258699d5-4bcb-4a21-8e2f-ffd85b9d4930",
    "conversationId": "01000000-0032-0a00-37f6-08de960cc984",
    "checkoutId": "cf8c67ee-e833-f111-bc6a-0e7d952d79b7",
    "checkoutReference": "ORD-20260215-9e553581-47e2-46c8-a711-8513ce746224",
    "checkoutRouteId": "c51f1c8a-fe0b-f111-bc33-0e7d952d79b7",
    "checkoutRouteChannelType": 159,
    "checkoutNotes": "checkout test",
    "checkoutCurrencyCode": "404",
    "checkoutCurrencyName": "KES",
    "checkoutDueDate": "2026-04-09T00:00:00",
    "checkoutReturnUrl": "https://www.monexia.com/",
    "checkoutCancelUrl": "https://checkout.merchant.com/payment/cancel",
    "checkoutCallbackUrl": "https://bright-sparrow-36.webhook.cool",
    "checkoutAccountNo": "00771",
    "checkoutTotalAmount": 19.50,
    "checkoutFeeAmount": 0.00,
    "billTo": {
        "firstName": null,
        "lastName": null,
        "address1": null,
        "locality": null,
        "administrativeArea": null,
        "postalCode": null,
        "country": null,
        "email": null,
        "phoneNumber": null
    },
    "deviceInfo": {
        "deviceType": null,
        "ipAddress": null,
        "userAgent": null,
        "deviceId": null,
        "sessionId": null,
        "acceptHeader": null,
        "language": null,
        "timeZone": null,
        "screenHeight": 0,
        "screenWidth": 0,
        "colorDepth": 0,
        "osName": null,
        "osVersion": null,
        "appVersion": null,
        "sdkVersion": null,
        "manufacturer": null,
        "model": null
    },
    "checkoutOutcome": {
        "status": 4,
        "statusDesc": "Completed",
        "resultCode": null,
        "resultDesc": "AUTHORIZED",
        "thirdPartyPayload": {
            "responseCode": null,
            "responseDesc": "0",
            "reference": "7757214988876650504805"
        }
    },
    "checkoutRequestLines": [
        {
            "sku": "SKU247",
            "name": "Gas Cooker",
            "price": 19.50
        }
    ]
}

Modified at 2026-07-17 13:40:19

Query Checkout Request

Overview