Ozow Hub

SettlementList

On this page2 sections

Fields

  • links PaginationLinks required

    Standard JSON API pagination links. Each link repeats the query that produced the collection and carries its own limit and offset. Follow the link rather than building the next URI. The example below is the second of three pages.

    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
  • results array of Settlement required
    Fields of Settlement
    • links object required

      Links related to this resource.

      • self string uri required

        The unique URI to this resource.

      • lineItems string uri required

        The URI to list the line items associated with this 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..

    • id string uuid required

      The unique id for this 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..

    • totalSettlement Amount required

      The total amount being settled.

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

      The total fees deducted from all corresponding transactions before calculating 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. amount. The fees for each line item record may not add up to this fee because of rounding and this fee will be calculated off total amounts or counts.

      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
    • lineItemCounts object required

      The line item counts for each type available. total is always present; a type with no line items in this 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. is left out rather than returned as zero.

      • total integer required

        The total number of line items in 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..

      • transaction integer

        The number of transaction line items in 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..

      • refund integer

        The number of refund line items in 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..

      • adjustment integer

        The number of adjustment line items in 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..

      • payout integer

        The number of 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. line items in 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..

    • reference string required

      The unique 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. reference that will be present in the reference on your bank statement.

      max length50
    • date string date required

      The UTC date 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. was created.

    • bank BankAccount
      Fields of BankAccount
      • institutionId string uuid required

        The unique identifier of the institution.

      • institutionName string

        The name of the institution.

      • accountNumber string required

        The bank account number.

      • branchCode string required

        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 BankAccount on its own page
    Open Settlement 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