Introduction

Lets get you familiar with the Payalat API

Basics

The Payalat API extends our dashboard. It grants you access to pretty much all the actions that can be performed on the dashboard and lets you extend them for use in your application.

Before using this API, please set up a Business or Agent Payalat account here that you can use in testing the API.

NOTE: Only Business and Agent accounts have access to the Payalat API

Once you are in, we would provide you with API keys to get started with. Jump to the Authentication section for more details on this.

Requests

All calls to the Payalat API can be tested using cURL and can be tested from the command line. If you aren't into cURL, you can use Postman. Postman is currently one of the most popular tools for API testing. We've even got a Postman collection to make your life easier and you can download that here. Who doesn't like easy stuff? 😉

Responses

All responses are in JSON format (This applies for all requests too).

The Payalat API strives for consistency and predictability. This implies that all responses would carry be of a uniform format.

Standard Response Format

{
"status": [boolean], // Only true if the action was successful
"message": [string], // Message describing the request
"data": [object] // Contains result of processing if present
}

While we advise developers to make checks based on the HTTP Status codes returned, we have provided a status key that can be used to check if an action was successful or not. Simply put, a false status means the action was not successful while a status of true means the action was successful. Jump to the errors section for more details on error checking.

The message key contains a summary of the response made. In the event of an error, it would contain a description of the error.

The data key contains the result of your request. this can be an array or an object depending on the request made. For instance, a request to fetch a single transaction would return a single object containing the transaction's details while a request to fetch multiple transactions would return an array of the fetched transactions.