TypeScript SDK

The official TypeScript SDK provides a fully typed client for the OurPay API.

The new SDK is currently in public preview. Install it from the next tag to try it before the stable release.

Installation

npm
yarn
pnpm

Terminal

npm install @ourpay-dev/sdk@next

Terminal

yarn add @ourpay-dev/sdk@next

Terminal

pnpm add @ourpay-dev/sdk@next

Quickstart

Create an organization access token for server-side use, keep it out of browser bundles, store it in OURPAY_ACCESS_TOKEN, and make your first request:

index.js

import { createOurPay } from "@ourpay-dev/sdk/2026-10";

const ourpay = createOurPay({
  accessToken: process.env.OURPAY_ACCESS_TOKEN!,
});

const customerState = await ourpay.customers.getStateExternal("customer_external_id");
console.log(customerState);

The import path pins your client to the 2026-04 API version.

Sandbox environment

The client uses production by default. Pass environment: "sandbox" to use the isolated sandbox environment:

const ourpay = createOurPay({
  accessToken: process.env.OURPAY_ACCESS_TOKEN!,
  environment: "sandbox",
});

View the source code on GitHub.

Framework adapters

Implement Checkout & Webhook handlers in few lines of code.

Bootup

Features

Integrate

Merchant of Record (MoR)

TypeScript SDK

Installation

Quickstart

Sandbox environment

Framework adapters

​Installation

​Quickstart

​Sandbox environment

​Framework adapters

Installation

Quickstart

Sandbox environment

Framework adapters