Get checkout status
get_checkout_statusUse this to read whether a checkout is pending, paid, consumed, expired, or cancelled. Use get_receipt to deliver content, and cancel_checkout to invalidate an unused confirmation. Input: confirmation or offer_id. Returns the state, amount, units remaining, and expiry. It does not pay or cancel.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "get_checkout_status"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| offer_id | No | Accepted offer id. Pass this or confirmation. | |
| confirmation | No | Single-use confirmation from prepare_checkout. Pass this or offer_id. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| note | Yes | ||
| state | Yes | ||
| amount | Yes | ||
| network | Yes | ||
| testnet | Yes | ||
| offer_id | Yes | ||
| expires_at | Yes | ||
| amount_atomic | Yes | ||
| schema_version | Yes | ||
| units_remaining | Yes |