Introduction

Learn how to integrate our APIs into your application.

Palremit Issuing has two types of environments, a production and sandbox environment. Here’s the difference between both environments.

ENVIRONMENTS USE

Production: This environment is for live apps, they issue real cards that can be used online.

baseURL: https://business-api.palremit.com

Sandbox: Use this environment while you are still developing, they are free to call, provide you with live-like data and they have the same implementation as the production environment so you don’t have to write two different codes.

baseURL: https://business-api-testnet.palremit.com

For each of the environments on Palremit Issuing, you will require an access token and a secret key.

API Basics

The Palremit API gives you access to pretty much 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 organized around the main resources you would be interacting with - with a few notable exceptions.

Sample Request

A sample request in an API typically consists of an HTTP request made to a specific endpoint using a certain HTTP method (such as GET, POST, PUT, DELETE) along with any required headers, parameters, and/or request body.

Response

Response refers to the data and information that the server sends back to the client after processing a request. This response typically includes an HTTP status code, headers, and optionally a response body.

Keys	Descriptions
Status	This lets you know if your request was succesful or not. We recommend that you use this in combination with HTTP status codes to determine the result of an API call.
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.

Authentication

Authenticate your API calls by including your secret key in the Authorization header of every request you make.

Authorization headers should be in the following format: Authorization: Bearer SECRET_KEY

Sample Authorization Header

Authorization: Bearer 6aba9f88dceaee673e511c6046e72ae4b5f9e7b3

Errors

Palremit's API is RESTful and as such, uses conventional HTTP response codes to indicate the success or failure of requests.

HTTP Codes	Description
200	The request was successful and the intended action was carried out. Note that we will always send a 200 if a charge or verification request is made. Do check the status value to know how the charge went (i.e. success or pending).
400	A validation or client-side error occurred and the request was not fulfilled.
401	The request was not authorized. This can be triggered by passing an invalid secret key in the authorization header or the lack of one.
500 501 502 504	These HTTP status codes represent errors encountered during requests, including issues with client acceptance, server errors, unimplemented functionality, gateway problems, and timeouts.