PaymentRequestLink
Request for creating a payment request link.
Fields
siteCodestring requiredA 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 length50countryCodestring requiredThe ISO 3166-1 alpha-2ISO 3166-1 alpha-2 The two-letter country codes published by the International Organization for Standardization, such as
ZAfor South Africa andGBfor 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]+currencyCodestring requiredThe ISO 4217ISO 4217 The three-letter currency codes, such as
ZARfor 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, so100.00is 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]+amountnumber double requiredThe transaction amount. The amount is in the currency specified by the currency codeISO 4217 The three-letter currency codes, such as
ZARfor the South African rand. Always uppercase.Wikipedia posted.transactionReferencestring requiredThe merchant's reference for the transaction.
max length50bankReferencestring requiredThe 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 length20isTestboolean requiredAccepted values are true or false. Send true to test your request posting and response handling. If set to true you will be redirected to select whether you would like a successful or unsuccessful 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. response sent back.
Please note that notification responses are sent for test transactions and the online banking payment is skipped.
cancelUrlstring uriThe 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 length150errorUrlstring uriThe 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 if an error occurs while trying to process 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 an error occurred while processing the payment.
max length150successUrlstring uriThe 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 length150notifyUrlstring uriThe 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 length150customerstringThe customer’s name or identifier.
max length100customerIdentifierstringMerchants classified as high-risk must provide a valid South African identity number. It's important to note that this is an optional field for all other merchants. For more details, please reach out to support@ozow.com.
max length13optional1stringOptional 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 length50optional2stringOptional 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 length50optional3stringOptional 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 length50optional4stringOptional 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 length50optional5stringOptional 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 length50bankIdstring uuidThe bank that the payment should be made to. Merchant needs to be enabled to send through banking details (BankId, BankAccountNumber, BranchCode, BankAccountName) in the post, for most merchants this is setup when creating the merchant account. See Payment method identifiers for the value to send.
max length20bankAccountNumberstringThe bank account number the payment should be made to.
max length20branchCodestringThe 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 bank account.
max length10branchNamestringThe branch name for the bank account.
max length10bankAccountNamestringThe name of the beneficiary account the payment is made into. Letters, digits and spaces only. Required, along with
bankAccountNumber,branchCodeandbankId, whenever any one of them is sent.max length50pattern^[a-zA-Z0-9\s]+$payeeDisplayNamestringThe name shown on the site as the entity being paid (not in banking screens).
max length50expiryDateUtcstringPayment 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 length19allowVariableAmountbooleanAllows the user to change the amount passed through before paying. This option must also be enabled for the site in the merchant admin portal to be used. Accepted values are true or false. DO NOT include false in the hash check string, just ignore instead.
variableAmountMinnumber doubleIf AllowVariableAmount is passed through as true, this will dictate the lowest acceptable amount the user can enter.
variableAmountMaxnumber doubleIf AllowVariableAmount is passed through as true, this will dictate the highest acceptable amount the user can enter.
recipientAddressstringWhere the payment link is sent, as either an email address or a cellphone number. A value containing
@is sent by email and anything else by SMS.min length1max length250paymentLinkstringOzow payment request URL (Only included in response)
max length250errorsstringContains error details for a specific record (Only included in response)
max length250sentUTCstringUTC Date and time the when request was sent (Only included in response and will not be set if RecipientAddress was not specified or was invalid)
max length250