Introduction

Inkress takes card payments for Jamaican businesses. The API lets you take those payments in your own product, build apps merchants install, and run merchants on your platform.

Three ways to build

• Accept payments. Create an order, send the customer to Inkress's payment page, and hear about it by webhook. Start with Accept a payment.
• Build an app. Merchants install your app and approve what it can see. You act for each of them with their own token. Start with OAuth and scopes.
• Run merchants. Platforms create or link their businesses' Inkress accounts and set what they pay. Start with Run merchants.

Test and live

Inkress has two environments. They share paths and responses, and keep separate data and keys.

A test key only works on the test API and a live key only on the live API. Every sample in these docs uses the test API.

Requests and responses

Send JSON with Authorization: Bearer <key>. Every response is a JSON envelope with state set to ok or error and the payload in result. Lists come back as result.entries with result.pagination.

The API reference lists every endpoint with its fields, the scope an app needs and the errors it returns.