Ozow Hub
On this page2 sections

Fields

  • links PaginationLinks required

    Links related to this resource.

    Fields of PaginationLinks
    • self string uri

      The current page of data.

    • first string uri

      The first page of data.

    • last string uri nullable

      The last page of data. Null when the whole collection fits on one page.

    • prev string uri nullable

      The previous page of data. Null on the first page.

    • next string uri nullable

      The next page of data. Null on the last page.

    Open PaginationLinks on its own page
  • The settlementSettlement Ozow paying the money you have collected into your bank account. Payins arrive at Ozow first and are settled to you on a schedule, so what a customer paid you today and what has been settled to you today are different amounts. line items.

    Fields of SettlementLineItem
    • id string uuid required

      The unique identifier for this record.

    • siteCode string required

      A unique code for the Ozow site this record relates to.

      max length50
    • reference string required

      The merchant’s reference for the record (transaction, refund or payoutPayout Money sent from a merchant to a bank account. Unlike a refund, a payout is not tied to a payment anyone made you, so you can pay anyone with a bank account. Payouts draw on your float rather than on your incoming payments, and they are not self-service: they need approval from Ozow and testing in staging first.). Ozow will generate a reference for adjusts where applicable.

      max length50
    • description string

      The description of the line item, this will be populated primarily on adjustment line items.

    • amount Amount required

      The original amount for the record.

      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
    • fee Amount required

      The Ozow fee relating to the record. Fee for the record is rounded.

      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
    • settlementAmount Amount required

      The nett settlementSettlement Ozow paying the money you have collected into your bank account. Payins arrive at Ozow first and are settled to you on a schedule, so what a customer paid you today and what has been settled to you today are different amounts. amount for this record. Amount – Fee, only rounded after calculating.

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

      The UTC date the record applies to.

    • type string required

      The line type for the record.

      values"transaction""refunds""payouts""adjustment""returnedrefund""returnedpayout""fee""chargebackwithheld""reservewithheld""chargebackreleased""reservereleased"
    Open SettlementLineItem on its own page
  • meta PaginationMeta required
    Fields of PaginationMeta
    • totalPages integer required

      The total number of pages available.

    • totalItems integer required

      The total number of items available.

    Open PaginationMeta on its own page

Used by