Ozow Hub

RefundRequest

On this page2 sections

Fields

  • transactionId string uuid required
  • amount Amount required

    The amount that needs to be refunded. This can be less than the original transaction amount but not more. Note that only up to the transaction amount can be refunded.

    Fields of Amount
    • currency string required

      The ISO 4217ISO 4217 The three-letter currency codes, such as ZAR for the South African rand. Always uppercase.Wikipedia current code.

      min length3max length3
    • value number float required

      The amount in the currency specified.

      min0.01
    Open Amount on its own page
  • reason string required

    The reason for the refund.

  • notifyUrl string uri

    Optional notify URL to send notifications of the status of the refund. The recommendation is to use webhooks instead of this method which are configurable via the webhooks endpoints of the API.

  • realTimePayment boolean required

    Whether or not this payment should happen in real time. Please refer to the Ozow Pricing page for more information.

    defaultfalse

Used by