API Basics

Sample Requests

We provide sample API calls next to each method using cURL. All you need to do is insert your specific parameters, and you can test the calls from the command line. See this tutorial on using cURL with APIs.

You can also use Postman if you aren't familiar with cURL. Postman is an easy to use API development environment for making HTTP requests. You can download the Kashier Postman Collection to make testing the API easier.

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:

Copy
Click here to expandClick here to shrink
1{
2  "response": [object], // contains actionable result of processing if present
3  "status": [string], // Only success if the details provided could be processed and no error occured while processing
4  "message": [string] // Explains why status is false... Entirely informational. Please only log this but do not use for your checks
5}

While we generally recommend that developers use HTTP status codes to determine the result of an API call, we have provided a handy status key to let you know upfront if the request was successful or not.

Message key

The message key is a string which will contain a summary of the response and its status. For instance when trying to retrieve a list of invoices, message might read The Payment Requests have been retrieved [success]. In the event of an error, the message key will contain a description of the error.

Response key

The response key is where you want to look at for the result of your request. It can either be an object, or an array depending on the request made. For instance, a request to retrieve a list invoices will return a array of invoices in the data key inside response object.

Pagination

The pagination key is used to provide context for the contents of the response key. For instance, if a list of transactions performed by a merchant is being retrieved, pagination parameters can be passed along to limit the result set. The pagination key will then contain an object with the following attributes:

Copy
Click here to expandClick here to shrink
1"pagination": {
2    "totalDocs": 211,
3    "limit": 1000000,
4    "totalPages": 1,
5    "page": 1,
6    "pagingCounter": 1,
7    "hasPrevPage": false,
8    "hasNextPage": false,
9    "prevPage": null,
10    "nextPage": null
11}

Keys