Ozow Hub

Fields

  • RefundId string uuid required

    The refund identifier.

  • TransactionId string uuid required

    The transaction identifier of the transaction that is being refunded.

  • CurrencyCode string required

    The refund currency. Will always be the same as the amount in the transaction.

    max length3
  • Amount number double required

    The refund amount, in the currency the currency codeISO 4217 The three-letter currency codes, such as ZAR for the South African rand. Always uppercase.Wikipedia names. Written with two decimal places, which is the form the hash is built from.

  • IsRtc string required

    An indication of whether RTCReal-Time Clearing Payments that clear immediately rather than waiting for a batch. A batch run settles at set times through the day; a Real-Time Clearing payment moves the funds between the two bank accounts as it is made, so the recipient can rely on them straight away.PayInc was used to pay the refund.

  • Status string required

    The refund status. Sent as the name, not as a number, because the notification is form encoded and the status is written out in full.

    values"Pending""Submitted""Complete""Failed""Cancelled""Returned""PendingInvestigation""Invalid""Error"
  • BankName string required

    The name of the bank the refund was paid to.

    max length50
  • AccountNumber string required

    The masked account number payment was made to. The hash is built from the masked value, so hash what you received rather than the number you sent.

    max length50
  • StatusMessage string

    Message regarding the status of the refund. This field will not always have a value.

    max length500
  • Hash string required

    SHA512SHA-512 A hashing algorithm. Ozow uses it to sign the values in a request or a notification so you can tell that they arrived unaltered and came from us. Hashing is one-way: the hash cannot be turned back into what produced it.Wikipedia hash used to ensure that certain fields in the message have not been altered after the hash was generated.

    max length128