Ozow Hub

RequiredAction

On this page2 sections

Fields

  • action string required

    The action if any that is required next.

    values"redirect""api""websocket"
  • uri string uri

    The URI to redirectRedirect Sending the payer to the Ozow payment page to complete the payment, and returning them to your site afterwards. The alternative is embedding the checkout in your own page, where the payer never leaves it., connect to the WebSocket or make the POST API call if required.

  • inputRequired InputResponse
    Fields of InputResponse
    • 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
    Open InputResponse on its own page

Used by