API Reference
List settlement instructions
Lists your active settlement instructions, defaults first, then newest. Filters match exactly, including case.
Query Parameters
Send it in lower case, exactly as listed
Possible values: bank_account, crypto_wallet
Responses
| Status | Description |
|---|---|
200 |
A page of settlement instructions |
400 |
Invalid request, an unknown or deleted ID, or a failure. Not-found is a 400 here, not a 404. |
200 response
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?