Nemuru's APIs use HTTP status codes together with error objects to handle errors. When an API call fails, the response will include a 4xx or 5xx status code together with a response body.

The error object MUST contain an exception and an error property. ONLY in case of 400 Bad Request error, the schema_errors property will also be present:

• The exception is a path referring to the unique and enumerable error that occurred in Nemuru. The intent of this property is that it is machine readable and so that you can act properly on its value.
• The error is the message that accompanies Nemuru's exception. It's value is a human readable message to aid in debugging.
• The schema_errors returns an object indicating invalid fields in the request. This property is ONLY available when an API call returns a status 400 Bad Request —the request data do not comply with the scheme validation.

Examples

A few examples of error response bodies:

400 Bad Request

{
    "status": "ko",
    "exception": "Nemuru\\SharedKernel\\Domain\\Exception\\SchemaValidatorException",
    "error": "Schema validation failed",
    "schema_errors": {
        "/product": "The product you selected is not a valid. Possible choices: {'split_pay', 'instalments'}.",
        "/merchant/notification_auth": "The required properties (content_type) are missing",
        "/customer/birth_date": "The data must match the 'date-time-atom' format",
        "/customer/logged_in": "The data (string) must match the type: boolean",
        "/cart": "The required properties (currency) are missing"
    }
}

404 Not Found

{
    "status": "ko",
    "exception": "Nemuru\\Module\\Financial\\Domain\\Loan\\Exception\\LoanNotFoundByIdException",
    "error": "\\Loan\\ with id \\c7d07661-8644-425e-91e0-afdcaef6f8d9\\ not found"
}

Status codes