Open Source Reconciliation Engine Docs
Use this page to get to first value fast: run a workflow, inspect mismatches, replay the same run, and export evidence you can share.
5-minute proof demo
Run pnpm demo to generate a deterministic run, then replay it to verify the same fingerprint.
pnpm demo
pnpm settler:replay examples/demo-output/evidence.jsonEvidence output: examples/demo-output/evidence.json.
Quick Example
import { SettlerClient } from '@settler/sdk';
const client = new SettlerClient({
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);
// eslint-disable-next-line no-console
console.log(`Matched: ${report.summary.matched}/${report.summary.total}`);How Data Flows
Understand how Settler processes data from source to target platforms.
