Introduction
Kyshi MoR offers a contemporary financial infrastructure designed for businesses and developers, enabling international business to facilitate local collections from customers
API Basics
The Kyshi MOR API gives you access to all the features you can use on our dashboard and lets you extend them for use in your application. It strives to be RESTful and is organised around the main resources you would be interacting with - with a few notable exceptions.
Requests and Response
Both request body data and response data are formatted as JSON. Content type for responses will always be application/json. Generally, all responses will be in the following format:
Method | Description |
---|---|
status | This lets you know if your request was successful or not. We recommend that you use this in combination with HTTP status codes to determine the result of an API call. |
code | These are standard HTTP response codes |
message | This is a summary of the response and its status. For instance when trying to retrieve a list of customers, message might read “Customers retrieved”. In the event of an error, the message key will contain a description of the error as with the authorization header situation above. This is the only key that is universal across requests. |
data | This contain the results of your request. It can either be an object, or an array depending on the request made. For instance, a request to retrieve a single customer will return a customer object in the data key, while the key would be an array of customers if a list is requested instead. |
Supported Currency
Kyshi makes use of the ISO 4217 format for currency codes.
Currency code | Country Code | Description | Environment |
---|---|---|---|
KES | KEN | For collection in Kenya | sandbox/live |
NGN | NGA | For collection in Nigeria. | sandbox/live |
GHS | GHA | For collection in Ghana. | sandbox/live |
XOF | CIV | For collection in Cote D’Ivoire | sandbox/live |
Updated 6 days ago