Ozow Hub

Refund

On this page2 sections

Fields

  • links object required

    Links related to this resource.

    • self string uri required

      The unique URI to this resource.

    • cancel string
  • id string uuid required

    The unique identifier for this refund.

  • transactionId string uuid required

    The transactions identifier of the payment that is being refunded.

  • amount Amount required

    The refund amount.

    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
  • requested string date-time required

    The date and time the refund was requested.

  • completed string date-time

    The date and time the refund was completed.

  • status string required

    The refund status. Possible values are:

    • Pending - The refund request has been submitted and accepted.
    • Complete - The refund has been paid successfully.
    • Submitted - The refund has been assigned to a batch and is being processed.
    • Failed - The refund payment has failed.
    • Cancelled - The refund has been cancelled before it was submitted.
    • Returned - The refund payment has been returned because the account that was being refunded no longer exists.
    values"Pending""Complete""Submitted""Failed""Cancelled""Returned"
  • reason string

    The reason for the status of the refund.

  • paidTo RefundPaidTo

    The bank details of where the refund was paid to.

    Fields of RefundPaidTo
    • accountNumber string required

      The bank account number the refund was paid into.

    • institution string required

      The display name of the institution holding the account.

    • branchCode string nullable

      The branch codeBranch code The six-digit number identifying a South African bank branch, the equivalent of a sort code or a routing number elsewhere. Each bank publishes one universal branch code that works for every account it holds, which is the one to use unless you have been given another. of the account.

      max length10
    Open RefundPaidTo on its own page
  • 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