Getting Started

npm install @keystoneos/sdk

import { KeystoneClient } from "@keystoneos/sdk";

const client = new KeystoneClient({
  clientId: process.env.KEYSTONE_CLIENT_ID!,
  clientSecret: process.env.KEYSTONE_CLIENT_SECRET!,
  environment: "production",
});

client.instructions   // Submit, get, list, cancel paired instructions
client.settlements    // Create, get, list, events, compliance decisions
client.templates      // List and get settlement templates (read-only)
client.webhooks       // CRUD + test, rotate secret, delivery logs, signature verification
client.environments   // CRUD + deactivate platform environments
client.compliance     // Convenience wrapper for compliance decisions

const key = client.generateIdempotencyKey(); // UUIDv4

// Safe to retry - same key returns existing resource, no double-creation
const settlement = await client.settlements.create({
  idempotencyKey: key,
  // ...
});

interface PaginatedResponse<T> {
  items: T[];
  total: number;
  limit: number;
  offset: number;
}

// Iterate through all pages
let offset = 0;
const limit = 50;

while (true) {
  const page = await client.settlements.list({ limit, offset });
  for (const settlement of page.items) {
    process(settlement);
  }
  offset += limit;
  if (offset >= page.total) break;
}