Wait for checkout
wait_for_checkoutWait for a checkout to reach a terminal status without client-side polling. Returns status and whether it timed out.
Instructions
Wait server-side for a checkout to reach a terminal status, emitting progress. One call — no client-side polling. Returns { status, terminal, timed_out }. Requires scope merchant_read.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| checkout_id | Yes | Checkout id (chk_…). | |
| timeout_seconds | No | Server-side wait budget (5–290s). The internal deadline always fires with margin below the platform cap, returning timed_out:true rather than being killed. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| status | Yes | ||
| is_live | Yes | ||
| terminal | Yes | true when status reached a terminal state. | |
| timed_out | Yes | true if the wait budget elapsed before terminal; status is last observed. | |
| checkout_id | Yes |