Tizondocs
ReferenceQuotes

Cancel a quote

POST
/v1/quotes/{quote_id}/cancel

Stops a quote waiting for funds. Money that arrives afterwards is credited to the wallet as usual and simply does not pay for this quote. Cancelling a cancelled quote returns it unchanged. A paid quote is 409 already_fulfilled; a lapsed one is 409 quote_expired.

Authorization

ApiKey
AuthorizationBearer <token>

An account API key, sent as Authorization: Bearer tz_live_…. The prefix selects the mode: tz_test_ for sandbox, tz_live_ for real money.

In: header

Path Parameters

quote_id*string

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/quotes/string/cancel"
{  "id": "string",  "object": "quote",  "status": "awaiting_funds",  "offer_id": "string",  "payment_source": "wallet",  "price": {    "amount": 1450,    "currency": "USD"  },  "wallet": {    "debited": 0,    "balance_after": 0  },  "payment": {    "rail": "usdt",    "amount": {      "amount": 1450,      "currency": "USD"    },    "asset": "USDT",    "asset_amount": "14.40",    "destinations": [      {        "id": "string",        "object": "funding_destination",        "type": "bank_account",        "bank_name": "string",        "account_number": "string",        "account_name": "string"      }    ],    "lightning": {      "bolt11": "lnbc144u1p...",      "payment_hash": "string",      "amount_sats": 22656,      "expires_at": "2019-08-24T14:15:22Z"    }  },  "expires_at": "2019-08-24T14:15:22Z",  "order_id": "string",  "metadata": {    "property1": "string",    "property2": "string"  },  "created_at": "2019-08-24T14:15:22Z"}