Ozow Hub

PaymentRequest

On this page2 sections

Fields

  • siteCode string required

    The merchant 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. in use for this payment. Site codes are available on the Ozow dashboard.

    max length50
  • region string

    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 originating country of the payment.

    Must be "ZA" for South Africa.

    If region is not specified IP geolocation will be used to determine the applicable region.

    min length2max length2
  • amount Amount required

    The currency and amount of the payment request.

    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
  • variableAmount VariableAmount

    If the payment amount can be changed by the payer, the variable amounts need to be passed in.

    Fields of VariableAmount
    • minimumValue number float required

      The minimum amount.

      min0.01
    • maximumValue number float required

      The maximum amount.

      min0.01
    Open VariableAmount on its own page
  • merchantReference string required

    The merchant's reference for the transaction. It is pre-populated in the payer's own reference field at their bank, shortened by banks that limit it, so it is not an internal-only value.

    max length50
  • beneficiaryReference string

    The reference that appears on the merchant's bank statement for the payment. Letters and numbers only. Rejected as missing unless the site is configured to let the payer supply the reference. A site prefix, where one is configured, counts towards the 20 characters.

    max length20pattern^[A-Za-z0-9]*$
  • payerReference string
    max length20
  • payer Payer

    Information on the payer used for identification and fraud purposes.

    Fields of Payer
    • id string required

      The merchant identifier for the payer.

      max length50
    • name string required
      max length200
    • identity Identification

      The identity of a payer. In high risk cases this information is required.

      Fields of Identification
      • type string required

        The type of identification for the person or business.

        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 identifier for the country of identification.

        min length2max length2
      • identifier string required

        The identifier for the consumer based on the identity type.

        max length20
      Open Identification on its own page
    • cellphone string

      The cellphone number for the payer.

      max length15
    • email string email

      The email address of the payer.

    Open Payer on its own page
  • returnUrl string uri

    The URI that Ozow needs to redirectRedirect Sending the payer to the Ozow payment page to complete the payment, and returning them to your site afterwards. The alternative is embedding the checkout in your own page, where the payer never leaves it. back to once the payment has reached a conclusion. Must be reachable from the internet. localhost is rejected with a 403, so a local integration needs a tunnel rather than the address the browser uses.

  • notifyUrl string uri

    Optional notify URL to send notifications of the status of the payment. The recommendation is to use webhooks instead of this method which are configurable via the webhooks endpoints of the API or via the Ozow Dashboard. Must be reachable from the internet. localhost is rejected with a 403, so a local integration needs a tunnel rather than the address the browser uses.

  • expireAt string date-time required

    The date and time the payment request should expire at and make the payment link unusable

  • institutionId string uuid

    The institution to send the payer straight to, skipping the payment method selection screen. The identifier for each payment method is on that method's page under Payment products.

Used by