Ozow Hub

Refund

A complete representation of a refund in Ozow's systems.

On this page2 sections

Fields

  • id string uuid required

    The identifier for the refund.

  • createdDate string date-time required

    The date the refund was created.

  • createdDateUtc string date-time required

    The UTC date the refund was created.

  • merchantCode string required

    Corresponding merchant code of the refund.

  • siteCode string required

    Corresponding site codeSite code The unique code for a site registered under a merchant. A site is a place to transact: a website, or a branch of a store. A merchant can have several, and each transaction names the one it belongs to, so sending the wrong code files the payment against the wrong place. of the refund.

  • siteName string required

    Corresponding site name of the refund.

  • bankToName string required

    Bank the refund was sent to.

  • currencyCode string required

    Refund currency.

    max length3
  • amount number double required

    Refund amount.

  • statementReference string required

    Bank reference of the refund for the payer.

  • status integer required

    Refund status. Possible values are:

    • 0 - Pending - The refund request has been submitted and accepted.
    • 1 - Complete - The refund has been paid successfully.
    • 2 - Submitted - The refund has been assigned to a batch and is being processed.
    • 3 - Failed - The refund payment has failed.
    • 4 - Cancelled - The refund has been cancelled before it was submitted.
    • 5 - Returned - The refund payment has been returned because the account that was being refunded no longer exists.
  • toAccount string required

    Account number refund was sent to.

  • paymentDate string date-time required

    Payment date of the refund.

  • transactionReference string required

    Reference of the transaction which was refunded.

  • customer string

    Refunded transaction customer.

  • lastEvent string required

    Most recent log activity of the refund.

  • refundCompletedDate string date-time

    The date the refund was completed.

  • createdBy string required

    Name of the user who created the refund.

  • isRtc boolean required

    True if the refund was paid via 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.

Used by