Errors - Orki Money Documentation

Partner API errors use the HTTP status code that describes the failure and return a JSON body. Error responses never include exception messages or stack traces.

Standard error response

{
  "msg": "Invalid or revoked API key.",
  "code": 401,
  "success": false
}

Field	Type	Description
`msg`	string	A safe, human-readable explanation of the error.
`code`	integer	The HTTP status code.
`success`	boolean	Always `false` for an error response.

Validation errors

Validation failures also include errors grouped by request field and a flattened error_list:

{
  "msg": "The type field is required.",
  "code": 422,
  "success": false,
  "errors": {
    "type": [
      "The type field is required."
    ]
  },
  "error_list": [
    "The type field is required."
  ]
}

HTTP status codes

Status	Meaning	Common causes
`400 Bad Request`	The request cannot be processed.	Incomplete parameters, an invalid transaction type, an unsupported route, or a provider that cannot serve the requested combination.
`401 Unauthorized`	API-key authentication failed.	The `X-ORKI-API-KEY` header is missing, invalid, revoked, expired, or belongs to another environment.
`402 Payment Required`	The account does not have an active subscription.	The subscription has expired or must be renewed.
`403 Forbidden`	The authenticated account cannot perform the operation.	Partner API access is not included in the production plan, the account is suspended, or the requested country or currency is restricted.
`404 Not Found`	The requested resource was not found.	An unknown transaction ID or endpoint was requested.
`405 Method Not Allowed`	The path exists but does not support the HTTP method used.	For example, sending `POST` to a `GET`-only endpoint.
`415 Unsupported Media Type`	The request body format is unsupported.	A JSON endpoint was called with an incompatible `Content-Type`.
`422 Unprocessable Content`	Request validation failed.	A required field is absent or a field has an invalid type or value.
`429 Too Many Requests`	The request limit has been exceeded.	More than the allowed number of requests were sent during the current minute.
`500 Internal Server Error`	An unexpected server error occurred.	Retry only when it is safe to do so, and contact support if the problem continues.
`503 Service Unavailable`	A required upstream service could not be reached.	A provider or supporting service is temporarily unavailable.

Provider availability can change between discovery, quoting, and checkout. Treat a provider-unavailable response as transient and allow the user to select another returned quote.