Transaction processing

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.

• 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

  • name string required

    The name of the transaction input field.

  • label string

    The display name of the transaction input field, this will be a user friendly message and can be displayed to the end user.

  • fieldType string required
    values"text""select""imagecapture""iframe""partialtext"
  • properties any of required
    • InputFieldText
    • InputFieldSelect
    • InputFieldImageCapture
    • InputFieldIFrame
    • InputFieldPartialText

  Open InputField on its own page

Sent back once the payer has completed the fields. `paymentStep` and each field `name` must match the text and the case of the message Ozow sent, exactly. A message whose values differ is not read.

• paymentStep string required

  The name of the payment step being performed. Must match the paymentStep Ozow sent, exactly.

• inputFields array of InputFieldRequest required
  Fields of InputFieldRequest

  • name string required

    The name of the input field.

  • value string required

    The value of the input field.

  Open InputFieldRequest on its own page

Sent once all the payer input has been processed. It carries the final status.

• transactionId string uuid required

  The transaction id of the completed transaction.

• status TransactionStatus required

  The transaction's status. Error covers every unsuccessful outcome, and reason carries the detail.

  values"Incomplete""Successful""Error""Pending""Refunded"

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.

• 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.