API Reference
Update a settlement instruction
Changes the details of an active settlement instruction, or makes it the default for its currency. To change the currency or type, delete it and create a new one. This route needs no Idempotency-Key.
Path Parameters
ID of the settlement instruction
Request Body
Request Examples
{
"account_name": "Acme Treasury Operating",
"is_default": true
}
Responses
| Status | Description |
|---|---|
200 |
The updated settlement instruction |
400 |
Invalid request, an unknown or deleted ID, or a failure. Not-found is a 400 here, not a 404. |
200 response
A settlement instruction. The response leaves out empty fields.
Use it as an FX order destination.id
The same value as instruction_type
Possible values: bank_account, crypto_wallet
Send it in lower case, exactly as listed
Possible values: bank_account, crypto_wallet
Always active; the API does not return deleted instructions
Possible values: active
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?