API Reference
Delete a settlement instruction
Retires a settlement instruction. You can no longer read or use it, and you cannot restore it. Orders that used it keep its ID. Deleting the default leaves its currency with no default.
Path Parameters
ID of the settlement instruction
Responses
| Status | Description |
|---|---|
200 |
The settlement instruction is deleted |
400 |
Invalid request, an unknown or deleted ID, or a failure. Not-found is a 400 here, not a 404. |
200 response
Possible values: deleted
{
"data": {
"status": "deleted"
},
"error": null
}
400 response
{
"data": null,
"error": "settlement instruction b7e1c2d3-4f5a-4b6c-9d8e-7f6a5b4c3d2e: resource not found",
"code": "ERROR_CODE_NOT_FOUND"
}
Authorization
- ApiKeyAuth
Was this page helpful?