Ozow Hub

Error

Ozow reports an error

On this page3 sections
Ozow sends application/json

Sent when a step fails. canContinue says whether the transaction survives it.

When canContinue is true, send the last message again with the problem corrected. When it is false, the transaction is over.

Authentication

  • bearerTokenAuthorization header

    `Authorization: Bearer <access_token>`, using an access token from `POST /token` on the One API. Authentication or authorisation failure closes the connection with `403 Forbidden`.

Payload

  • title string required

    The title of the error response.

  • detail string required

    The details of the error response.

  • canContinue boolean required

    Whether processing on the particular transaction can continue. When true, send the last message again with the problem corrected.

Examples

A step failed and the transaction can continue
{
  "title": "Invalid credentials",
  "detail": "The username or password was not accepted by the bank.",
  "canContinue": true
}