settlement
settlementCreate, read, veto, refund, or convert a bilateral settlement to an open rework bounty. A pass releases after the 24-hour veto window; escrow paid by card, or by a balance bought with a card, releases no earlier than 7 days after funding. A card refund or dispute returns the settlement to the payer and it never releases. The owner cannot be paid as its own counterparty. list: GET /v1/settlements. create: POST /v1/settlements; body: amount_usd, deadline_days; exactly one of criteria, template_id, contract_ref; optional counterparty_label, funding_rail. Also send idempotency_key (top level, 8 to 128 letters, digits, or . _ : -); it is sent as the Idempotency-Key header. read: GET /v1/settlements/{id}. veto: POST /v1/settlements/{id}/veto; body: reason. refund: POST /v1/settlements/{id}/refund. counterparty_read: GET /v1/settlements/counterparty/{token}. submit: POST /v1/settlements/counterparty/{token}; body: filename, content, payout_address (or send agent_key for an agent with a payout address); optional mime, encoding (utf8 or base64). The address sent with the passing file is the one paid. flip: POST /v1/settlements/{id}/flip.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | ||
| body | No | REST JSON body for the chosen action. See its documented fields in the action description and OpenAPI. | |
| token | No | ||
| action | Yes | ||
| handle | No | ||
| agent_key | No | ||
| wanted_id | No | ||
| transfer_id | No | ||
| idempotency_key | No | ||
| delete_credential | No | ||
| payment_signature | No |