Retrieve a checkout

Reads one checkout, including whether it is paid. Call this before you fulfill. See Confirming a payment.

GET /v1/payments/merchant/checkouts/{id}

Headers

Header	Required
Authorization	Yes	Bearer mkp_…

Path

Parameter
id	cs_ke_… or cs_ug_…, then 24 hex characters

An id with another shape returns 400 before a lookup.

Example

curl

curl https://payments-ke-staging.salimia.me/v1/payments/merchant/checkouts/cs_ke_3f9a1c7e5b2d4a8e6c0b91d7 \
  -H "Authorization: Bearer $MOOKHPAY_SECRET_KEY"

Node

const res = await fetch(`${process.env.MOOKHPAY_API}/checkouts/${id}`, {
  headers: { Authorization: `Bearer ${process.env.MOOKHPAY_SECRET_KEY}` },
});
const { data } = await res.json();

Python

requests.get(
    f"{os.environ['MOOKHPAY_API']}/checkouts/{checkout_id}",
    headers={"Authorization": f"Bearer {os.environ['MOOKHPAY_SECRET_KEY']}"},
)

Response

200 OK. A completed checkout:

{
  "ok": true,
  "description": "Checkout",
  "data": {
    "id": "cs_ke_3f9a1c7e5b2d4a8e6c0b91d7",
    "url": "https://…/checkout/cs_ke_3f9a1c7e5b2d4a8e6c0b91d7",
    "status": "completed",
    "amount": "150000",
    "currency": "KES",
    "reference": "order-1042",
    "description": "2× Latte, 1× Mandazi",
    "return_url": "https://yourshop.example/paid",
    "expires_at": "2026-09-30T09:30:00.000Z",
    "created_at": "2026-09-30T09:00:00.000Z",
    "payment": {
      "intent_id": "pi_8c1e4f0a7b3d92e5a6f01c48",
      "status": "completed",
      "amount_settled": "150000",
      "provider_receipt": "…",
      "phone": "254712345678"
    }
  }
}

Errors

HTTP	Code	When
400	1701	id is not a checkout id
401	2781	Missing, malformed, unknown, or revoked key
404	2783	No checkout for your key. Another merchant's id returns the same 404
429	1804	More than 120 requests in one minute
503	2782	The key service did not answer. Retry