Get Started - Pepay

This page is designed for first success quickly:

install the SDK → 2) authenticate → 3) create an invoice → 4) observe status via REST or WebSockets.

1) Get API keys (dashboard)

Pepay Dashboard Login

Create API keys for server-to-server integrations.

You’ll see two key types in the dashboard:

Merchant API keys: use x-api-key for /api/v1/* merchant endpoints (invoices, tokens, events).
Commerce API keys: use x-commerce-api-key for /api/commerce/* endpoints (search, carts, checkout, orders).

If you need access or onboarding support, email support@pepay.io.

2) Install the SDK

npm install pepay

3) Configure your environment variables

export PEPAY_API_URL="https://api-beta.pepay.io"
export PEPAY_API_KEY="sk_live_..."  # Merchant API key (x-api-key)

Defaults used in these docs:

Base URL: https://api-beta.pepay.io
Dashboard login: https://pepay.io/sign-in

4) Create an invoice (server)

import { Pepay } from 'pepay';

const pepay = new Pepay({
  apiKey: process.env.PEPAY_API_KEY!,
  baseUrl: process.env.PEPAY_API_URL ?? 'https://api-beta.pepay.io'
});

const invoice = await pepay.invoices.create({
  amount_usd: 49.99,
  description: 'Starter plan'
});

console.log(invoice);

Example response:

{
  "invoice_id": "550e8400-e29b-41d4-a716-446655440000",
  "payment_url": "https://<payment-iframe-host>/pay?session=pst_...&signature=sig_...",
  "expires_at": 1766322000,
  "session_token": "pst_...",
  "signature": "sig_...",
  "payment_session_headers": {
    "x-session-token": "pst_...",
    "x-signature": "sig_..."
  }
}

5) Observe status (REST)

const status = await pepay.invoices.status(invoice.invoice_id);
console.log(status);

6) Observe events (WebSockets)

For realtime delivery, mint a short-lived ws_token server-to-server and connect to the merchant stream:

Mint token: POST /api/v1/ws/token
Connect: wss://…/ws/merchant/events?token=<ws_token>

Next: Install

​1) Get API keys (dashboard)

Pepay Dashboard Login

​2) Install the SDK

​3) Configure your environment variables

​4) Create an invoice (server)

​5) Observe status (REST)

​6) Observe events (WebSockets)