Query Checkout Request

GET

/v1/checkout-order/check-status

This endpoint describes how to query a merchant initiated checkout request.

Used by the merchant to to query the status of a transaction asynchronously.

In the Params, add IdType and Id

IdType is 1 and Id stands for the originatorConversationId

Request

Authorization

Query Params

Body Params application/jsonRequired

Examples

Responses

🟢200Success

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/v1/checkout-order/check-status?IdType=1&Id=2f0da9c0-472c-4b17-a049-577761ed510v' \
--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

{
    "id": "0451e566-a938-f111-bc70-0e7d952d79b7",
    "originatorConversationId": "2f0da9c0-472c-4b17-a049-577761ed510b",
    "conversationId": "01000000-0129-0a00-de9a-08de9acd3e00",
    "checkoutId": "0551e566-a938-f111-bc70-0e7d952d79b7",
    "checkoutReference": "ORD-20260215-6bc624ed-d087-464c-a607-4b64d346a983",
    "checkoutRouteId": "c51f1c8a-fe0b-f111-bc33-0e7d952d79b7",
    "checkoutRouteChannelType": 159,
    "checkoutNotes": "checkout for QA test",
    "checkoutCurrencyCode": "404",
    "checkoutCurrencyName": "KES",
    "checkoutDueDate": "2026-04-15T00:00:00Z",
    "checkoutReturnUrl": "https://www.zamupay.com/",
    "checkoutCancelUrl": "https://checkout.merchant.com/payment/cancel",
    "checkoutCallbackUrl": "https://bright-sparrow-35.webhook.cool",
    "checkoutAccountNo": "00770",
    "checkoutTotalAmount": 19.50,
    "checkoutFeeAmount": 0.00,
    "billToFirstName": null,
    "billToLastName": null,
    "billToAddress1": null,
    "billToLocality": null,
    "billToAdministrativeArea": null,
    "billToPostalCode": null,
    "billToCountry": null,
    "billToEmail": null,
    "billToPhoneNumber": null,
    "checkoutOutcome": {
        "status": 0,
        "statusDesc": "Pending",
        "resultCode": null,
        "resultDesc": null,
        "thirdPartyPayload": {
            "responseCode": null,
            "responseDesc": null,
            "reference": null
        }
    },
    "checkoutRequestLines": [
        {
            "sku": "SKU247",
            "name": "Gas Cooker",
            "price": 19.50
        }
    ]
}

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

Checkout Order Request

Checkout Callback Request