Track settlements

Monitor pending settlement amounts, inspect settlement batches, and drill into the payins inside each batch.

Before you start

• Generate a Client Secret Key in your Starks dashboard.
• Review Authentication so your requests are ready before you query settlement data.
• Decide whether you need an aggregate view, a batch-level view, or the underlying payins.

1. Check pending settlement payins

Use Get pending settlement payins when you need the aggregated pending settlement amounts by organization and currency.

Start here when you want a quick view of what is still waiting to settle.

2. Review settlement batches

Use Get settlement batches when you need paginated batch records with filtering options.

Move to this endpoint when you need to inspect settlements as grouped batches instead of aggregate totals.

3. Inspect settlement payins

Use Get settlement payins when you need the paginated payins that make up settlement activity.

This is the endpoint to use when you need transaction-level detail inside a settlement flow.

Optional: Tie settlement activity back to payins

Use Get payin transaction history when you need to compare settlement activity with the broader payin record for reconciliation.

Optional: Which endpoint should you use?

• Use Get pending settlement payins for aggregate pending amounts.
• Use Get settlement batches for grouped settlement records.
• Use Get settlement payins for the underlying payins inside settlement activity.