Checkout page
Cancel a checkout page
POST
/checkout-sessions/{id}/cancelScope
checkout:writeAuth Bearer keyIdempotentCloses the temporary account and stops the countdown. A session that has already been paid cannot be cancelled.
Path parameters
idstringrequiredHeaders
Idempotency-KeystringrequiredRetrying with the same key and payload replays the original response.
Responses
200Checkout session
json
{
"id": "chk_9f2b1c7a4d",
"object": "checkout_session",
"status": "cancelled",
"method": "bank_transfer",
"amount": "3000.00",
"currency": "NGN",
"amount_paid": null,
"amount_outstanding": "3000.00",
"payments": [],
"expires_at": "2026-02-04T20:59:46.000Z",
"checkout_url": "https://business.boundlesspay.com/checkout/chk_9f2b1c7a4d",
"reference": "ORDER-4821",
"description": "Order #4821",
"customer": {
"name": "Ada Nwosu",
"email": "ada@example.com",
"phone": null
},
"instructions": {
"type": "bank_transfer",
"account_number": "9902117364",
"account_name": "BOUNDLESS/ORDER-4821",
"bank_name": "Providus Bank",
"amount": "3000.00",
"currency": "NGN",
"expires_at": "2026-02-04T20:59:46.000Z"
},
"deposit_id": null,
"paid_at": null,
"success_url": "https://shop.example.com/thanks/4821",
"cancel_url": null,
"metadata": {
"order_id": "4821"
},
"created_at": "2026-02-04T20:29:46.000Z"
}Errors
Errors use RFC 9457 problem details. Branch on code, and log request_id.
400Bad request401Unauthenticated403Forbidden409Idempotency conflict422Validation error429Rate limitedcURL
curl -X POST "https://business.boundlesspay.com/api/public/v1/checkout-sessions/{id}/cancel" \
-H "Authorization: Bearer $BOUNDLESS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)"