Skip to main content

Settlements API

Manage payment settlements and payouts.

Methods​

getSettlement​

Get a settlement by ID.

const settlement = await easy.getSettlement("set_123");

Parameters​

  • settlementId (string, required): The ID of the settlement

Returns​

Promise<ApiResponse<SettlementData>>;

getSettlements​

List all settlements with optional filtering.

// Get all settlements with pagination
const settlements = await easy.getSettlements({
  limit: 20,
  offset: 0,
});

// Get specific settlements by ID
const specificSettlements = await easy.getSettlements({
  ids: ["set_123", "set_456"],
});

Parameters​

  • params (object, optional)
    • ids (string[], optional): Filter by specific settlement IDs
    • limit (number, optional): Maximum number of settlements to return
    • offset (number, optional): Number of settlements to skip

Returns​

Promise<ApiResponse<SettlementData[]>>;

closeSettlement​

Close a settlement.

await easy.closeSettlement("set_123");

Parameters​

  • settlementId (string, required): The ID of the settlement to close

Returns​

Promise<ApiResponse<void>>;

Example: Settlement Reconciliation​

import { createClient } from "@easylabs/node";

const easy = await createClient({
  apiKey: process.env.EASY_API_KEY!,
});

// Get recent settlements
const settlements = await easy.getSettlements({ limit: 10 });

for (const settlement of settlements.data) {
  console.log(`Settlement ${settlement.id}:`);
  console.log(`  Amount: $${settlement.amount / 100}`);
  console.log(`  Status: ${settlement.status}`);
  console.log(`  Created: ${settlement.created_at}`);

  if (settlement.status === "OPEN") {
    // Close the settlement
    await easy.closeSettlement(settlement.id);
    console.log(`  ✓ Closed`);
  }
}

Type Definitions​

SettlementData​

interface SettlementData {
  id: string;
  amount: number;
  currency: string;
  status: "OPEN" | "CLOSED" | "PENDING";
  created_at: string;
  updated_at: string;
  closed_at?: string;
}