Overview

Introduction

The Zone Payment Funds Transfer API is a single API, leveraging our decentralized switching system that makes it easy for you to receive payments, send payments via ZIFT with an organized UI interface for tracking. Use cases range from platform business to Baas, SaaS, and everything else in between.

It is organized around REST. Our API has predictable resource-oriented URLs, accepts json request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

You can use the Zone Payment Gateway API in test mode, which does not affect your live data or interact with the banking networks. The API key you use to authenticate the request determines whether the request is in live, or test mode and these keys are available on the dashboard interface appropriately.

Making Requests

We provide sample API calls next to each endpoint, Request and response bodies are json encoded and require
the application/json value in the Content-Type request header. For example, a valid cURL request would look like the following

cURL

   curl https://my/dedicated/url -H "Content-Type: application/json"...

For testing, you may choose to use a tool such as Postman or use the sample tests on this document as it is. Simply click on an endpoint on the right pane to expand a usable test link.

Currency

All API requests expect amounts to be provided in a currency’s smallest unit. For example, to transfer 10 NGN, provide an amount value of 1000 (that is, 1000 kobo).