Withdraw from contract here
withdraw_from_contractDestructiveIdempotent
Your person withdraws from their booking (one they paid for) or order, within the period the business states (withdrawal on get_item_status). Two steps: without confirm_withdrawal nothing is sent and you get the statement to show them (confirm.statement); send confirm_withdrawal: true on their yes. Before the goods went out the order ends and what was paid is refunded; once they reached your person, the goods come back (lines: only some of them) and are refunded. The business emails a copy. Never refused: past the period, or for something that cannot be returned, it goes to a person there instead (passed_on), or becomes a return under the business's own policy.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| key | No | The person's key (sdkey1_…), if that is all you have: it is exchanged once for a pass, which comes back in identity.passes — keep the pass and send it next time instead. Never stored. | |
| note | No | Anything your person wants to tell the business. | |
| pass | No | The person's passes (sdpass1_…), space-separated, at most 8: presented to the network that issued each, so the business recognises the customer. Or send them in the Sdi-Pass header. Never stored. | |
| lines | No | Once the goods reached them: only these lines (by index in the order's orderedItem), and how many of each. | |
| item_id | Yes | ||
| access_token | No | Capability secret returned when the item was created without an account. | |
| idempotency_key | No | Same key + same request = same answer. Required for agents. Make it a fresh random UUID per request: a retry of a create with a random key gets its access token again. | |
| confirm_withdrawal | No | true once your person confirmed the statement you were shown. Left out, nothing is sent: you get the statement. |