OVERVIEW

We use standard HTTP response codes for success and failure notifications. In general, 200 HTTP codes correspond to success, 40X codes are for developer or user-related failures, and 50X codes are for Okra-related issues. We’re always working to minimise API errors related to Okra integrations and to address connectivity issues across bank infrastructure.

API	SINGLE_LINK
SOCKET_ID	USSD
SLA	SUSPENDED
RATE_LIMIT	FLAGGED_USER
ENV	EMPTY_QUEUE
QUEUE_FAILED	MAX_RETRY
DUPLICATED_QUEUE	FAILED_QUEUE
PLAN	SELECTOR
EXPIRED	CUSTOM
KILL	NO_RECORD_ID

Breakdown of an Okra error

Name	Description
`status`	The HTTP status code associated with the error. This will only be returned in the response body when the error information is provided via a webhook.
`message`	A user-friendly representation of the error code. null if the error is not related to user action. This may change over time and is not safe for programmatic use.
`data`	Response data from the API, including the details of the successful or failed response.
`method`	The method that performs the error function
`code`	The particular error code
`type`	A broad categorization of the error. Safe for programmatic use. Possible values: SUSPENDED, EMPTY_QUEUE, FLAGGED_USER, NO_RECORD_ID, RATE_LIMIT

API errors

Error Code	Description
404	The API Route you're using doesn't exist. Check our documentation and confirm the route.
400	The API call failed. Please check the message payload.
429	Too many requests. You can try again in 60 seconds. Check out more on Rate Limits
5XX	Something went wrong on our side.