Ozow – A South African fintech platform offering instant, secure, card-free EFT payments, refunds, and payouts to businesses through seamless API and plug-in integrations.
Supported Transaction Types
Authorisation
Capture
Purchase
Refund
Withdrawal
Void
Integrations Supported
Hosted Payment Page (For deposits)
Direct Connect ( server-to-server - For Refunds and Withdrawals)
Currencies & Countries Supported
Title | Description |
---|---|
Currencies Supported | ZAR |
Additional attributes to process via Ozow
You must include the following JSON Attributes to the payload. These attributes inform us to proceed with the redirection to Ozow in order to finalise the payment process.
For more details on the integration, you can also refer to our API reference documentation here.
Description | Hosted Payment Page |
---|---|
Force Transaction Routing | "Routing": { "ForcePayment": "OZOW" } |
Client Account Details* | "Client" : { "Email": "Apco@Test.com", "FirstName": "Apco", "LastName": "Test", "Country": "ZA", "MobileNo": "3561234567", "Street": "Street", "City": "City", "ZIPCode": "12345", "State": "N/A", "IPAddress": "127.0.0.0" } |
Payment Destination | "PaymentDestination": { "PaymentMethodData": { "BankBranchCode": "198765", "BeneficiaryAccountNumber": "1148172386", "BankGroupId": "bf0561fd-4203-4a0c-9174-cb26fcd87a60", "BankReferenceCode": "0123456789", "IsRTC": "true" } |
Test Indicator (required in Sandbox Environment only) | "isTest”: true |
Sample Deposit Request below
{
"TransactionType": "ORIGINALCREDIT",
"Currency": "ZAR",
"Amount": "1.00",
"OrderReference": "MerchantOrder1",
"RedirectionURL": "https://www.yourURLhere.com/Redirect",
"CallBackURL": "https://www.yourURLhere.com/Listener",
"FailRedirectionURL": "https://yourURLhere.com/FailRedirect/",
"Language": "en",
"IsTest": "False",
"Routing": {
"ForcePayment": "OZOW"
},
"Client" : {
"Email": "Apco@Test.com",
"ClientAccount": "testing",
"FirstName": "Apco",
"LastName": "Test",
"Country": "ZA",
"MobileNo": "3561234567",
"Street": "Street",
"City": "City",
"ZIPCode": "ZIP",
"State": "N/A",
"IPAddress": "127.0.0.0"
},
"PaymentDestination": {
"PaymentMethodData": {
"BankBranchCode": "198765",
"BeneficiaryAccountNumber": "1148172386",
"BankGroupId": "bf0561fd-4203-4a0c-9174-cb26fcd87a60",
"BankReferenceCode": "0123456789",
"IsRTC": "true"
},
"Configuration" : {
"Profile": "showandedit"
}
}
Additional attributes are needed for Withdrawals - Direct Connect
Description | Direct Connect |
---|---|
Force Transaction Routing | "Routing": { "ForcePayment": "OZOW" } |
Client Account Details* | "Client" : { "Email": "Apco@Test.com", "ClientAccount": "testing", "FirstName": "Apco", "LastName": "Test", "Country": "ZA", "MobileNo": "3561234567", "Street": "Street", "City": "City", "ZIPCode": "ZIP", "State": "N/A", "IPAddress": "127.0.0.0" } |
Test Indicator (required in Sandbox Environment only) | "isTest”: true |
Sample request below:
{
"TransactionType": "ORIGINALCREDIT",
"Amount": "0.01",
"Currency": "EUR",
"RedirectionURL": "https://www.yourURLhere.com/Redirect",
"CallBackURL": "https://www.yourURLhere.com/Listener",
"FailRedirectionURL": "https://yourURLhere.com/FailRedirect/",
"IsTest": "True",
"Client": {
"email": "apcotest@test.com",
"firstName": "Joe",
"lastName": "Bloggs",
"city": "MagicCity",
"IPAddress": "127.0.0.1"
},
"Routing": {
"ForcePayment": "SKRILL"
},
"PspId": "845235"
}
Attributes needed for Refunds - Direct Connect
Description | Direct Connect |
---|---|
Force Transaction Routing | "Routing": { "ForcePayment": "OZOW" } |
Test Indicator (required in Sandbox Environment only) | "isTest”: true |
Sample request below:
{
"TransactionType": "PARTIALREFUND",
"Amount": "1",
"Currency": "ZAR",
"OrderReference": "Ozow - Refund",
"RedirectionURL": "https://api.dev.apspglobal.com/technicalsupporttool-fe/Redirect/",
"CallBackURL": "https://api.dev.apspglobal.com/technicalsupporttool-fe/Listener",
"IsTest": false,
"PspId": "8736335"
}