Inkress for developers

Build on the payments Jamaican businesses already use.

Take card payments in your product, build apps merchants install from their dashboard, or run merchants on your own platform. Start in test mode with keys you get in a minute.

Get your test keys Read the quick start

checkout.tsTest mode

NodecURLPHPElixir

import { InkressSDK } from "@inkress/admin-sdk";
 
const inkress = new InkressSDK({
  accessToken: process.env.INKRESS_KEY,
  mode: "sandbox",
});
 
const { result } = await inkress.orders.create({
  reference_id: "order_1042",
  kind: "online",
  total: 2500,
  currency_code: "JMD",
  customer: { email: "tanya@example.com" },
});
 
redirect(result.payment_urls.payment_url);

Response201 Created · 143 ms

{
  "state": "ok",
  "result": {
    "id": 88214,
    "reference_id": "order_1042",
    "total": 2500,
    "currency": "JMD",
    "payment_urls": {
      "payment_url": "https://inkress.com/pay/…",
      "short_link": "https://ink.rs/4Fq2"
    }
  }
}

Your customer paysinkress.com/pay

Kingston Klosetorder_1042

J$2,500.00

4012 0000 0002 0071

Pay J$2,500.00

Events→ api.kloset.shop/hooks

orders.paidorder_1042 · J$2,500.00

200 · 182 ms

Signature verifiedX-Inkress-Webhook-Signature

HMAC-SHA256

Three ways to build on Inkress

One account, one set of keys. Most teams start with payments and add the rest when they need it.

Order 88214 Paid

Total: J$2,500.00
Card: Visa •••• 0071
Webhook: orders.paid · 200

For shops, SaaS and booking tools

Accept payments

Card payments in your site or app. Inkress hosts the card page and tells your server when it's paid.

Accept payments

Bayside Bookings wants to connect

See your ordersorders:read

Create payment linkspayment_links:write

CancelAllow

For app makers

Build apps for merchants

Apps merchants install from their Inkress dashboard. They approve what you can see; you get a token for each.

Build an app

Your merchants 14

KEKingston EatsLive

MBMobay MobileVouched

OROcho Rios ToursLive

For platforms and marketplaces

Run merchants on Inkress

Create your merchants' accounts from your platform, set what they pay, and earn on every payment.

Run merchants

Test mode that behaves like live

Everything you build in test mode works the same way once you switch to live keys.

Test keys from the first minuteCreate an organisation and you get sk_test_ keys. Point the SDK at sandbox and every call goes to the test environment.
A sandbox merchant with sample dataOrders, customers and a subscription to read and play with, so your screens aren't empty.
Test cards for every outcomeApproved, 3-D Secure and declined, on the same payment page your customers will see.
Webhooks in test mode tooSigned and delivered like live ones, so you can check your signature code before launch.

Test mode

Secret keysk_test_••••••••••••3f9a

Sandbox merchantSandbox Shop · sample orders and customers

4012 0000 0002 0071	Approved
4012 0000 0002 0006	3-D Secure, password 3ds2
4012 0000 0002 0121	Declined

See every request and every delivery

When something breaks, the answer is in the portal, not in a support ticket.

Request logsEvery API call with its status, time and request ID. Paste an ID into search to jump straight to it.
Webhook deliveriesWhat we sent, what your server answered and how long it took. Failed deliveries retry on their own; replay any of them.
Secrets you can rollRoll a webhook signing secret from the portal whenever you need to, without contacting Inkress.

Deliveries api.kloset.shop/hooks

orders.paidorder_1042 · 10:42

200 · 182 ms

subscriptions.payment_successsub_311 · 10:31

200 · 96 ms

orders.paidorder_1039 · 10:12

500 · retrying

orders.shippedorder_1031 · 09:58

200 · 140 ms

Response: {"error":"db timeout"}Replay

SDKs for the stacks you use

Or call the REST API from anything that speaks HTTPS.

@inkress/admin-sdk1.1.52

Orders, payment links, subscriptions, merchants, payouts and webhooks. TypeScript, for Node, browsers and React Native.

npm install @inkress/admin-sdk

@inkress/storefront-sdk1.1.2

Everything a storefront needs: products, carts and checkout, in the browser or Node.

npm install @inkress/storefront-sdk

@inkress/app-bridge0.1.0

For apps embedded in the merchant dashboard: merchant identity, host-rendered UI and token exchange.

npm install @inkress/app-bridge

@inkress/app-kit0.1.0

Embedded apps on React Router 7: session and OAuth, an authenticated SDK in loaders, webhooks.

npm install @inkress/app-kit

inkress0.3.0

The Elixir client, for Phoenix and anything else on the BEAM.

{:inkress, "~> 0.3"}

REST APIv1

JSON over HTTPS with bearer tokens. Every guide shows cURL, Node, PHP and Elixir.

api.inkress.com/api/v1

Start with the docs

GuideQuick startA test order, paid with a test card, with the webhook arriving. About ten minutes.GuideWebhooksEvents, signatures and retries.GuideApps and OAuthScopes, the install screen and tokens per merchant.ReferenceAPI referenceEvery endpoint, with the scope it needs and its errors.

Already building on InkressFleekSiteBookervaCourier Portal

Get your test keys

Create an organisation and you get test keys and a sandbox merchant straight away. Switch to live once your business details are checked.

Get started Read the docs