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

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/checkout/cart' \
--header 'Content-Type: application/json' \
--data-raw '{
    "originatorConversationId": "00a9f0d4-6e2b-4a8f-b9d3-5f7c2e1a4b66",
    "checkoutReference": "ORD-20260126-7848",
    "checkoutRouteId": "DED81224-70B6-ED11-AD49-0EE00E897F52",
    "checkoutRouteChannelType": 172,
    "checkoutNotes": "Customer checkout for apparel purchase",
    "checkoutCurrencyCode": 404,
    "checkoutCurrencyName": "KES",
    "checkoutDueDate": "2026-12-31T23:59:59Z",
    "checkoutReturnUrl": "https://checkout.merchant.com/payment/response",
    "checkoutCancelUrl": "https://checkout.merchant.com/payment/cancel",
    "checkoutCallbackUrl": "https://checkout.merchant.com/api/payment/result",
    "checkoutAccountNo": "0072",
    "checkoutRequestLines": [
        {
            "sku": "SHRT-BLK-XL-9981",
            "name": "Black Shirt XL",
            "price": 2500.0
        },
        {
            "sku": "SHRT-BLU-L-4421",
            "name": "Blue Shirt Large",
            "price": 2200.0
        },
        {
            "sku": "SHRT-GRN-M-7712",
            "name": "Green Shirt Medium",
            "price": 2300.0
        }
    ],
    "checkoutOutcome": {
        "Status": 4,
        "StatusDesc": "Completed",
        "ResultCode": "000",
        "ResultDesc": "Request Processed",
        "ThirdPartyPayload": {
            "ResponseCode": "000",
            "ResponseDesc": "Request Processed",
            "Reference": "TXN565FDR43211",
        }
    }
}'

Response Example

{}

Modified at 2026-04-30 05:53:25

Query Checkout Request

Overview