Admin Cancel OTC Deal
Cancels an OTC offer on a token. The cancellation is settled on-chain asynchronously, so the response names the transaction that was started rather than the finished result.
Request
POST /v2/admin/otcs/tokens/{token_id}/deals/{deal_id}/cancel
The node segment is gone: a deal id is unique within a token contract, so the token is the precise scope and the node is derived from it. The call takes no request body.
Parameters
| Name | Type | In | Description |
|---|---|---|---|
token_id | string | path | Required. The ID of the token the offer is on |
deal_id | integer | path | Required. The deal ID of the offer to cancel |
Headers
| Name | Type | Description |
|---|---|---|
Authorization | Required. Bearer token for authentication | |
Content-Type | Required. application/json |
Example
curl --location --request POST '\{\{baseUrl\}\}/v2/admin/otcs/tokens/68ae06cfcccf4e8fc19362d1/deals/2/cancel' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'
Response
{
"transaction_id": "6a8b5e13f9129816a6cc7a13"
}
Response Fields
| Field | Type | Description |
|---|---|---|
transaction_id | string | The OTC transaction started by this call. Poll it with Get Otc Transaction to see whether the cancellation settled |
Status Codes
| Status Code | Description |
|---|---|
| 200 | Success - the cancellation has been started |
| 400 | Bad Request - unknown token or deal, or the offer is not in a cancellable state |
| 401 | Unauthorized - invalid or missing authentication token |
| 500 | Internal Server Error |
Notes
- This endpoint requires admin privileges.
- A
200means the transaction was started, not that the offer is cancelled. The offer reaches its final state only when the transaction reportsstatus: 3(Done). - This call used to answer
200with an empty body, which left no way to follow the settlement. - The offer's full history is available at List Otc Transactions.