Errors and recovery

Error body

The standard error response contains a human-readable detail:

{
  "detail": "Description of the error"
}

Schema validation failures can instead return detail as an array. Each entry can include loc (for example ["body", "perf_fee", "rate"]), msg, and type. Handle both forms and report the affected field; do not assume detail is always a string.

HTTP codes

Code	Meaning	Integrator action
`200` / `201`	Operation accepted or resource created	Persist relevant identifiers and confirm asynchronous state when required.
`400`	Operational rule failed, such as balance, open positions, minimum, or state	Display or record `detail`; correct the state before trying again.
`401`	Missing or invalid CRM API key	Verify bearer formatting and the configured secret.
`403`	CRM key cannot access the route	Confirm the customer’s contracted endpoint set. Do not silently change credentials.
`404`	Account, Master, Investor, or subscription not found	Verify the internal ID or MT5 login and synchronize records.
`409`	Conflict or operation already in progress	Read current state; do not duplicate the command.
`422`	Invalid field, type, or range	Correct the payload or query parameters.
`500` / `503`	Operational failure or dependency unavailable	Record the incident and reconcile before repeating a financial request.

Recovery rules

Do not automatically retry a deposit, withdrawal, or unassignment whose outcome is uncertain.
On 409 during unassignment, query the subscription; it may already be PAUSED.
On 500 or 503, keep the CRM operation pending until balances and MT5 identifiers have been checked.
Record the UTC timestamp, method, route, non-secret request reference, status code, and response detail for support.
Never log bearer credentials or MT5 passwords while capturing diagnostics.

Previous: Financial safety

Return to safe financial sequences.

Next: API conventions

Review pagination, dates, money, and response compatibility.

Getting Started

Core Workflow

Reliability

Error body

HTTP codes

Recovery rules

Previous: Financial safety

Next: API conventions

​Error body

​HTTP codes

​Recovery rules

Previous: Financial safety

Next: API conventions

Error body

HTTP codes

Recovery rules