Specification

Introduction

Welcome to Kwik's API documentation

Notes

  • API endpoints are RESTful GET/POST HTTP requests
  • Body type must be application/json
  • All API calls made must include the authorization key in the header of the call.
  • Requests to the API will be limited to 100 requests per second to reduce the load on the platform.
  • Dates are to be specified as 'YYYY-MM-DD'
  • Timestamps are specified as 'YYYY-MM-DD HH:mm:ss' GMT+2 (South African Standard Time)

Path

Staging

https://staging.app.kwik.co.za/1.0/

Live

https://api.kwik.co.za/1.0/

Authentication

Follow the ‘Basic Authorization’ standard, below is an example:

const hexString = Buffer.from(`${api_key}:${api_secret}`).toString('base64');
const headers = {
 'Authorization': `Basic ${hexString}`,
};

Copyright © 2024 Kwik