Bulk Payment Request API
Get Started
The Ozow bulk payment API allows a merchant to generate and/or send multiple payment request links in a single call. The request data is submitted in an API call and after the data has been processed the result is sent to the endpoint specified in the request.
Before getting started you require the following:
Your Ozow merchant details:
- Site code
- Private key
- API key
Sending Bulk SMS Links
Contact [email protected] should you wish to send bulk SMSes using this API as your account would need to be enabled to do so.
Sending WhatsApp links
Contact [email protected] should you wish to send WhatsApp messages using this API as your account would need to be enabled to do so.
Learn more: WhatsApp for Business
Overview
The diagram below outlines the process flow that a standard bulk payment request 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 |
Updated over 1 year ago