Payments API Guide
Get Started
The Ozow Payment API allows you to build Ozow's real-time EFT functionality directly into your website or app. This integration method gives you more flexibility but would require more effort than using the Ozow hosted method.
Before getting started you require the following:
- Your Ozow merchant details:
- Site code
- Private key
- API key
- Your Ozow merchant account has been granted API access
API Access
This API will only be made available to selected merchants, so make sure you apply for access before commencing development. Always ensure that you adhere to the API guidelines to avoid having your access revoked.
Overview
The diagram below outlines the process flow that a standard payment will follow. These steps are explained in detail in the next few sections of this guide.
API Endpoints
Common Headers
All requests excluding the "Get Token" request require the following HTTP headers.
| Name | Type | Req | Description |
|---|---|---|---|
| Authorization | string (500) | Y | The token generated using the get token method. eg. Authorization: Bearer [token] |
| Content-Type | string (50) | N | The format the response should be returned in e.g. Accept: application/json Accept: application/x-www-form-urlencoded |
| Accept | string (50) | Y | The format the response should be returned in e.g. Accept: application/json Accept: application/xml |
Error Object
All requests return the same error object to indicate if an error has occurred.
| Name | Type | Description |
|---|---|---|
| Message | string | The error message |
| CanContinue | bool | Whether or not the process can continue. |
Continue to Step 1: Get API Token
Updated 7 months ago