Endpoint
Cancel a conversion request
POST
/v1/conversions/{id}/cancelCancels a conversion that is waiting for approval, so nothing is converted.
Allowed while awaiting_approval.
- Scope a restricted key needs
conversions:write- Publishable key
- Not allowed: secret or restricted key only
- Idempotency-Key
- Recommended. It makes a retry safe.
Parameters
| Parameter | Type and place | Meaning |
|---|---|---|
idrequired | stringpath | The id of the conversion. |
Orrerie-Version | stringheader | API version date. Default: the version the key was created with. Example 2026-10-11. |
Idempotency-Key | stringheader | Makes a retry safe. Kept 24 hours. 1 to 255 characters. |
Request body
A JSON object. The body may be left out. A field the call does not list is refused with parameter_unknown.
Example request
curl
curl https://api.orrerie.com/v1/conversions/cv_ban2ezvpwf4j4d09h4htv42j/cancel \
-H "Authorization: Bearer $ORRERIE_SECRET_KEY" \
-H "Content-Type: application/json" \
-d '{}'JavaScript
const response = await fetch("https://api.orrerie.com/v1/conversions/cv_ban2ezvpwf4j4d09h4htv42j/cancel", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.ORRERIE_SECRET_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const result = await response.json();
if (!response.ok) throw new Error(`${result.error.code}: ${result.error.message}`);
console.log(result);Python
import os
import requests
response = requests.post(
"https://api.orrerie.com/v1/conversions/cv_ban2ezvpwf4j4d09h4htv42j/cancel",
headers={"Authorization": f"Bearer {os.environ['ORRERIE_SECRET_KEY']}"},
json={},
timeout=30,
)
result = response.json()
if not response.ok:
raise RuntimeError(f"{result['error']['code']}: {result['error']['message']}")
print(result)PHP
<?php
$request = curl_init('https://api.orrerie.com/v1/conversions/cv_ban2ezvpwf4j4d09h4htv42j/cancel');
curl_setopt_array($request, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('ORRERIE_SECRET_KEY'),
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode(new stdClass()),
]);
$body = curl_exec($request);
if ($body === false) {
throw new RuntimeException(curl_error($request));
}
$result = json_decode($body, true);
if (curl_getinfo($request, CURLINFO_HTTP_CODE) >= 400) {
throw new RuntimeException($result['error']['code'] . ': ' . $result['error']['message']);
}
print_r($result);Responses
200 OK
The answer is the conversion object. Headers: Orrerie-Request-Id.
Example response, 200
{
"id": "cv_ban2ezvpwf4j4d09h4htv42j",
"object": "conversion",
"livemode": true,
"created": "2026-10-12T11:00:30.000Z",
"updated": "2026-10-12T11:00:30.000Z",
"status": "cancelled",
"pending_reason": null,
"venue": "relay",
"venue_progress": null,
"from": {
"wallet": "wal_zjdztygt4g73zm0cdcjjf43k",
"asset": "bitcoin:btc",
"amount": "0.01000000"
},
"to": {
"wallet": "wal_bsfw07hymawmda7gg8jsyy3g",
"asset": "base:usdc",
"amount_estimated": "1168.420000",
"amount_minimum": "1162.577900",
"amount_received": null
},
"rate": "116842.00",
"max_slippage_bps": 50,
"fees": [
{
"kind": "route_fee",
"amount": "1.38",
"currency": "USD"
},
{
"kind": "network_fee",
"amount": "0.61",
"currency": "USD"
}
],
"in_transit_notice": "While a conversion is being routed it is held by Relay, a separate company. Orrerie never holds it.",
"requested_by": {
"type": "api_key",
"id": "key_6e3gg2c6ea176xxdek2nar6v"
},
"approved_by": null,
"approval_url": null,
"approval_expires_at": "2026-10-19T11:00:30.000Z",
"send_transaction_hash": null,
"receive_transaction_hash": null,
"failure_code": null,
"cancellation_reason": "cancelled_by_api",
"approved_at": null,
"sent_at": null,
"confirmed_at": null,
"metadata": {}
}Any other status: an error
A status of 400 or above answers with the error object. Branch on its code, never on its message.
Errors
Beside the errors every call can answer with (a bad key, a missing scope, the rate limit), this call answers with:
| Code | HTTP | Meaning |
|---|---|---|
money_out_not_cancellable | 409 | The request is signed or later. A signed transaction cannot be withdrawn. |