Ozow Hub

CreateSubscriptionRequest

The details required to create a recurring payment subscription. The customer authorises an amount band (see `amountConstraints`) on the hosted page returned in `redirectUrl`; charges are taken on the schedule defined by `frequency`, `firstPaymentDate` and `occurrences`.

On this page2 sections

Fields

  • siteCode string required

    The 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. the subscription belongs to.

    max length50
  • amount Amount required

    The recurring charge amount. Must be ZAR and fall within the authorised band [amountConstraints.min, amountConstraints.max].

    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
  • amountConstraints AmountConstraints required

    The per-payment authorisation band the customer approves.

    Fields of AmountConstraints
    • min Amount required

      The minimum authorised per-payment amount. Whole RandZAR The ISO 4217 code for the South African rand, and the currency every amount on this site is in unless a page says otherwise. Amounts are decimal rand rather than cents, so 100.00 is one hundred rand., greater than 0.

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

      The maximum authorised per-payment amount. Whole RandZAR The ISO 4217 code for the South African rand, and the currency every amount on this site is in unless a page says otherwise. Amounts are decimal rand rather than cents, so 100.00 is one hundred rand., greater than min, and not exceeding 100000.

      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
    Open AmountConstraints on its own page
  • payableNow PayableNow

    An optional once-off charge taken at sign-up. This charge is not bound by amountConstraints.

    Fields of PayableNow
    • amount Amount required

      The once-off charge amount. Must be ZAR.

      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 date the once-off charge is taken. Must be today or a future date.

    Open PayableNow on its own page
  • identity object

    An optional customer identifier used for matching. Treated as personal information: it is accepted on the request but is never returned on any response (POPIAPOPIA South Africa's data protection law. It governs how personal information about a payer may be collected, stored and shared.popia.co.za data minimisation).

    • type string required

      The type of identification for the customer.

      values"said""passport""registration""cellphone"
    • country string required

      The ISO 3166 alpha-2ISO 3166-1 alpha-2 The two-letter country codes published by the International Organization for Standardization, such as ZA for South Africa and GB for the United Kingdom. Always uppercase.Wikipedia code for the country of identification.

      min length2max length2
    • identifier string required

      The identifier value for the given identity type.

      max length20
  • description string required

    A short description of the subscription.

    max length20
  • merchantReference string required

    Your unique reference for the subscription. Must not contain spaces.

    max length50pattern^\S+$
  • bankReference string required

    The reference that appears on the merchant's bank statement for each payment in the subscription. Letters and numbers only. A site prefix, where one is configured, counts towards the 20 characters.

    max length20pattern^[a-zA-Z0-9]+$
  • frequency SubscriptionFrequency required

    The billing cadence of a subscription.

    values"Daily""Weekly""Fortnightly""Monthly""Biannually""Annually"
  • firstPaymentDate string date required

    The date of the first scheduled charge. Must be today or a future date.

  • occurrences integer required

    The total number of scheduled charges over the life of the subscription.

    min1max120
  • paymentMethod string

    Optional. The payment method (rail) used to collect charges. Defaults to capitec when omitted, which is currently the only supported method. Not returned on responses.

    values"capitec"

Used by