Ozow Hub

Input required

Ozow asks for the next input

On this page3 sections
Ozow sends application/json

Sent once the connection is established and again after each step. displayType says what to do: form means collect the fields in inputFields, prompt means tell the payer to perform an action such as accepting a push message, and busy means ask them to wait.

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

  • transactionId string uuid required

    The transaction id of the payment being processed.

  • paymentStep string required

    The name of the payment step being performed.

  • pageTitle string required

    The title of the page, this will be a user friendly message and can be displayed to the end user.

  • pageInstructions string required

    Instructions for the end user to perform, this will be a user friendly message and can be displayed to the end user.

  • pageActionText string required

    The action type, this could typically be used as the text for a button or link. This will be a user friendly message and can be displayed to the end user.

  • displayType string required

    The display type which indicates what sort of action should be taken. form will require asking the user for input, prompt will require instructing the user to perform an action (e.g. accept a push message) and busy will require asking the user to wait.

    values"form""prompt""busy"
  • inputFields array of InputField

    If the object is of the form display type the input fields the user would need to complete will be returned in this array.

    Fields of InputField
    Open InputField on its own page

Examples

A login step asking for a mobile number
{
  "transactionId": "5ecaafc2-354f-47d9-822d-d0bd8b77eab3",
  "paymentStep": "Login",
  "pageTitle": "Login Details",
  "pageInstructions": "Log in using your internet banking profile.",
  "pageActionText": "Login",
  "displayType": "form",
  "inputFields": [
    {
      "name": "MobileNumber",
      "label": "Enter Mobile Number",
      "fieldType": "text",
      "properties": {
        "maxLength": 10,
        "isOptional": false,
        "isSensitive": false
      }
    }
  ]
}