Skip to main content

Close a Checkout

Merchant route confirmed. Check applicability.

Object and complete fields · Authentication, amounts and errors · Integration guide

POST /v1/checkouts/{id}/close

Only the merchant server can explicitly close a session. Send {} as the body.

  • open, processing: changes to failed with failure_reason=closed.
  • Already failed: returns the current object without changing the original failure reason.
  • Already succeeded: rejects closure with 400 checkout_invalid_state.

Later receipts remain recognizable after closure but become funds exceptions. They neither reopen payment nor make the session successful.

Attributes​

AttributeLocationTypeRequiredDescription
Idempotency-KeyheaderstringYesUnique key for this operation; retain it for retries
idpathstringYesUnique Checkout identifier

Request example​

POST /v1/checkouts/checkout_example/close
Authorization: Bearer inv_test_...
Content-Type: application/json
Idempotency-Key: ec3a7e90-673e-41a1-94d0-6724fba6a339
{}

Response example​

200 OK, returning the complete Checkout object.

{
"id": "checkout_example",
"amount": "10",
"currency": "usdc",
"transaction_speed": "low",
"status": "failed",
"failure_reason": "closed",
"exception_status": null,
"order_id": "ORDER_001",
"description": "Order payment",
"metadata": {},
"url": "https://pay.example.com/c/checkout_example",
"return_url": "https://merchant.example.com/orders/ORDER_001",
"expires_at": "2026-10-28T08:30:00Z",
"created_at": "2026-10-28T08:00:00Z",
"updated_at": "2026-10-28T08:05:00Z"
}

Business error codes