SDKs

Official SDKs for the stacks you use, or call the REST API from anything that speaks HTTPS.

Package	Version	What it's for
`@inkress/admin-sdk`	1.1.52	Orders, payment links, subscriptions, merchants, payouts and webhooks. TypeScript, for Node, browsers and React Native.
`@inkress/storefront-sdk`	1.1.2	Products, carts and checkout for storefronts, in the browser or Node.
`@inkress/app-bridge`	0.1.0	Embedded apps: merchant identity, Inkress's own UI and session tokens.
`@inkress/app-kit`	0.1.0	Embedded apps on React Router 7: session, OAuth, an authenticated SDK in loaders, webhooks.
`inkress` (Elixir)	0.3.0	Orders, payment links, products and webhooks for Phoenix and the BEAM.

Node

Install with npm install @inkress/admin-sdk. Pass your key as accessToken and mode: "sandbox" for test keys or "live" for live ones. Set mode yourself: without it the SDK sends requests to the live API. Errors throw an InkressApiError with status and result.

Elixir

Add {:inkress, "~> 0.3"} to your deps. Inkress.new(api_token: …, merchant_username: …, mode: :sandbox) makes a client; every call returns {:ok, _} or {:error, _}.

Anything else

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

Was this page helpful?Updated Oct 8, 2026