Get settlement details, aggregates and recovery eligibility

The legs and attempts describe only the current snapshot. overview.summary aggregates confirmed money
across every snapshot, including contributions retained after REFRESH_PLAN and consumed after finalization.
For a session costing 50, a successful wallet attempt of 20 and card attempt of 30 both have state=SUCCEEDED.
attempt.amount is the requested operation amount. A FAILED_FINAL attempt of 30 does not mean 30 was collected.
Use overview.summary for collected/remaining amounts, never sum visible attempt.amount values on the frontend.
Use overview.actions[].enabled for recovery buttons. requiresExecutionCheck means provider/source or plan
checks will happen during POST. A GET never calls the provider. All POSTs revalidate state and authorization.
The settlement processingStatus differs from the CDR payment state. UTC timestamps show processing progress.
A positive coverageExcess records overcollection, not a refund. Historical reads remain available after
switching the configured engine. No persisted settlement record means HTTP 404. Aggregation and eligibility
are calculated exclusively on this endpoint. Ordinary CDR details include only a cheap
settlementDetailsAvailable existence flag.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 0 and 255
Responses

404

No persisted async settlement exists for this CDR.
The CDR itself may still exist, absence alone does not prove a legacy payment.
This response has no body.

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json