Skip to main content

Documentation

Everything you need to integrate Settler into your application. Get started in minutes.

Settler API Documentation Interface - Complete API reference with interactive examples and code snippets

Getting Started

New to Settler? Start here

Quickstart

Create your first reconciliation in 5 minutes

API Reference

Complete API documentation

Auth & Security

Authentication and security best practices

Quick Example

import { Settler } from '@settler/sdk';

const client = new Settler({
  apiKey: process.env.SETTLER_API_KEY,
});

// Create a reconciliation job
const job = await client.jobs.create({
  name: "Shopify-Stripe Reconciliation",
  source: {
    adapter: "shopify",
    config: { apiKey: "..." }
  },
  target: {
    adapter: "stripe",
    config: { apiKey: "..." }
  },
  rules: {
    matching: [
      { field: "order_id", type: "exact" },
      { field: "amount", type: "exact", tolerance: 0.01 }
    ]
  }
});

// Run the job
const report = await client.jobs.run(job.id);
console.log(`Matched: ${report.summary.matched}/${report.summary.total}`);

How Data Flows

Understand how Settler processes data from source to target platforms.

Settler data flow diagram showing how data moves from source platforms through adapters to reconciliation engine and target platforms