Introduction to Settlement

This section provides a complete overview of how to access and monitor settlements using PhonePe’s APIs and webhooks. It includes methods to retrieve settlement IDs based on date ranges, check the real-time status of a settlement, and receive webhook notifications for key settlement events.

Date Range Based Settlement IDs

Fetch a list of settlement IDs by passing a date range.
Useful for retrieving recent settlements for reconciliation or status checks.

Supports pagination using limit and offset
Returns settlement ID, state, UTR, and date

Settlement Status API

Check the current status of any settlement using its settlementId.
Response includes:

Current state: INITIATED, PROCESSED, or ATTEMPT_FAILED
Amount, UTR, account details, and error (if any)

Settlement Webhooks

Webhooks are triggered for key settlement events:

settlement.initiated
settlement.processed
settlement.attempt.failed

Each webhook provides real-time updates with relevant settlement details.

UAT Sandbox Support

Use the UAT Sandbox to test settlement flows and webhook triggers without relying on UAT server availability.

Simulate states like Initiated, Processed, or Attempt Failed
Configure templates via the PhonePe Test App
Trigger Webhooks using a dedicated API