Ozow Hub
POSThttps://api.ozow.com/secure/banktransfer/singleProduction

Create a unique reference for a single deposit.

Authentication

Request body

  • siteCode string required

    A unique code for the site currently in use. A 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. is generated when adding a site in the Ozow merchant admin section.

    max length50
  • countryCode string required

    The ISO 3166-1 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 user's country. The country code will determine which banks will be displayed to the customer. Please note only South African (ZA) banks are currently supported by Ozow.

    max length2pattern^[A-Z]+
  • currencyCode string required

    The ISO 4217ISO 4217 The three-letter currency codes, such as ZAR for the South African rand. Always uppercase.Wikipedia three-letter code for the transaction currency. Please note only the South African 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. (ZAR) is currently supported by Ozow, so any currency conversion must take place before posting to the Ozow site.

    max length3pattern^[A-Z]+
  • amount number double required

    The transaction amount. The amount is in the currency specified by the currency codeISO 4217 The three-letter currency codes, such as ZAR for the South African rand. Always uppercase.Wikipedia posted.

    • Accepted but not applicable for static references (multi-deposit)
  • transactionReference string required

    The merchant's reference for the transaction.

    max length50
  • bankReference string required

    The reference that will be pre-populated in the "their reference" field in the customers online banking site. This is the payment reference that appears on the merchant’s bank statement and can be used for recon purposes. Only alphanumeric characters, spaces, and dashes are allowed.

    max length20
  • optional1 string

    Optional field the merchant can post for additional information they would need passed back in the response. These are also stored with the transaction details by Ozow, and can be useful for filtering transactions in the merchant admin section.

    max length50
  • optional2 string

    Optional field the merchant can post for additional information they would need passed back in the response. These are also stored with the transaction details by Ozow, and can be useful for filtering transactions in the merchant admin section.

    max length50
  • optional3 string

    Optional field the merchant can post for additional information they would need passed back in the response. These are also stored with the transaction details by Ozow, and can be useful for filtering transactions in the merchant admin section.

    max length50
  • optional4 string

    Optional field the merchant can post for additional information they would need passed back in the response. These are also stored with the transaction details by Ozow, and can be useful for filtering transactions in the merchant admin section.

    max length50
  • optional5 string

    Optional field the merchant can post for additional information they would need passed back in the response. These are also stored with the transaction details by Ozow, and can be useful for filtering transactions in the merchant admin section.

    max length50
  • customer string

    The customer’s name or identifier.

    max length100
  • cancelUrl string uri

    The URL to which the 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. result should be posted to if the customer cancels the payment. This is also the page the customer will be redirected to. This URL can also be set for the applicable merchant site in the merchant admin section. If a value is set in the merchant admin and sent in the post, the posted value will be redirected to if the payment is cancelled.

    max length150
  • successUrl string uri

    The URL to which the 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. result should be posted to if the payment is successful. This is also be the page the customer gets redirected to. This URL can also be set for the applicable merchant site in the merchant admin section. If a value is set in the merchant admin and sent in the post, the posted value will be redirected to if the payment was successful.

    Please note that it is not sufficient to assume that the payment was successful simply because the customer has been redirected back to this page. It is highly recommended that you check the response fields as well as the transaction status using our check transaction status API call.

    max length150
  • notifyUrl string uri

    The URL that the notification result should be posted to. The result will post regardless of the outcome of the transaction. This URL can also be set for the applicable merchant site in the merchant admin section. If a value is set in the merchant admin and sent in the post, the notification result will be sent to the posted value. Find out more in the notification response section in step 2.

    max length150
  • bankId string uuid

    Ozow’s identifier for the bank, while this is not required it will help in future to make sure we return the correct instructions for the user.

    See Payment method identifiers for the value to send.

  • expiryDateUtc string

    Payment will not be allowed to be made after this date. Date should be UTC and value should be formatted as yyyy-MM-dd HH:mm

    max length19
  • customerCell string

    Merchant can provide customer cellphone number for faster login on certain banks. DO NOT include in the hash check string, just ignore instead.

    max length10pattern^[0-9]+
  • hashCheck string required

    SHA512SHA-512 A hashing algorithm. Ozow uses it to sign the values in a request or a notification so you can tell that they arrived unaltered and came from us. Hashing is one-way: the hash cannot be turned back into what produced it.Wikipedia hash used to ensure that certain fields in the message have not been altered after the hash was generated. See Generate the hash check for the field order and a worked example.

    max length250

Responses

200 OK
  • transactionId string uuid required

    Ozow transaction identifier. Transaction will be in a pending state after it is created and will be updated to complete after the payment has been received in our account

  • bankingDetails BankingDetails required
    Fields of BankingDetails
    • bankName string required

      Name of the bank the account is held at.

      max length50
    • branchCode string required

      The destination 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. for the account

      max length10
    • accountNumber string required

      The Ozow account number to use for deposit

      max length20
    • publicRecipientName string

      The name of the public recipient if applicable (depending whether a bankId was passed in the original request)

      max length50
    • beneficiaryReference string required

      The reference to be used for the deposit

      max length20
    Open BankingDetails on its own page
  • url string uri required

    A URL that the user can be directed to where they will be displayed the banking details and instructions to use for the deposit

  • errorMessage string

    Error message generated when validating the request.

    max length150