Ozow Hub

SubscriptionTransactionListItem

One charge instruction under a subscription. Instruction level only, so the underlying payment identifiers are not exposed here.

Fields

  • amount Amount required

    The currency and amount of the charge.

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

    The merchant's reference for this individual charge.

  • bankReference string

    The reference that appears on the merchant's bank statement for this charge.

  • actionDate string date-time

    When the charge is or was due to be actioned.

  • isPayableNow boolean

    True when this is the immediate first charge requested with payableNow rather than a scheduled one.

  • createdDate string date-time

    When the instruction was created.