Class Reconciliation

Read the settled money ledgers for reconciliation against your own books (scope: ledger:read).

Index

Constructors

Methods

payments withdrawals

Constructors

constructor

new Reconciliation(c: Requester): Reconciliation
Parameters
- c: Requester
Returns Reconciliation
- Defined in src/resources/reconciliation.ts:21

Methods

payments

payments(query?: ReconciliationQuery): Promise<ReconciliationPage>
List the settled pay-in ledger — collections that have completed and credited the workspace. Keyset-paginated (limit/before/order).
Parameters
- query: ReconciliationQuery = {}
  Time window + pagination; see ReconciliationQuery.
Returns Promise<ReconciliationPage>
The raw { items, total, nextCursor } — a ReconciliationPage.

Throws
On failure (e.g. 401/403 missing ledger:read, 429 rate limit).
- Defined in src/resources/reconciliation.ts:30

withdrawals

withdrawals(query?: ReconciliationQuery): Promise<ReconciliationPage>
List the settled withdrawal ledger — payouts/off-ramps that have completed and debited the workspace. Keyset-paginated (limit/before/order).
Parameters
- query: ReconciliationQuery = {}
  Time window + pagination; see ReconciliationQuery.
Returns Promise<ReconciliationPage>
The raw { items, total, nextCursor } — a ReconciliationPage.

Throws
On failure (e.g. 401/403 missing ledger:read, 429 rate limit).
- Defined in src/resources/reconciliation.ts:41