API Status Codes

The following codes are used in the status field to provide information about the logical result of a specific API call. Status codes provide additional information with respect to HTTP response codes: for example, an HTTP/1.1 200 (OK) response code may still contain a KO status code to indicate that the call was successful on the protocol layer, but it actually failed from the business logic perspective.

• OK The operation was successful. The payload response element may provide additional response data.
• KO The operation failed. The error or errors response element may provide additional information about the occurred error.
• PENDING The operation requires additional information to be executed (for example, the response to an authorization challenge).

The following table provides a quick reference to the supported status codes in each API version.