Settlements

A settlement is a batch of transfers (charges and refunds) grouped for payout — the unit of reconciliation between Easy Labs and your bank. Read-only on the SDK side, plus a close action.

Accessed via client.settlements.

Methods

list(limit: nil, offset: nil, ids: nil)

GET /settlements.

client.settlements.list(limit: 50)

retrieve(id)

GET /settlements/:id.

client.settlements.retrieve("st_…")

close(id)

PATCH /settlements/:id. Closes an open settlement so the payout can be initiated.

client.settlements.close("st_…")

Object shape

:id, :state (OPEN, CLOSED, PAID, …), :total_amount, :net_amount, :fees, :transfers, :created_at, :closed_at, …

Webhook events

Subscribe to settlement.created to react when a new settlement opens.

Examples

Daily reconciliation export

client.settlements
      .list(limit: 100)[:data]
      .select { |s| s[:state] == "CLOSED" }
      .each   { |s| ReconciliationJob.perform_later(s[:id]) }

Manually close an open settlement

client.settlements.close("st_…")