SettlementRunOutcomeDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
One terminal settlement batch outcome. Carries only the identifiers and the already-sanitized operator-facing reason persisted on the batch row: no transaction detail, no processor payload.
Values
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
| Field | Type | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
settlementBatchId
required |
string (uuid) | The settlement batch document id, for linking to batch detail.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||
runId
required |
string (uuid) | The settlement run this batch belonged to.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||
processorKey
required |
string | Lower-cased processor key the batch was produced for. Null for legacy rows and for synthetic
rows written before a processor could be resolved.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||
openBatchId
required |
string | The gateway batch id this run settled. Null when the run failed before one existed.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||
status
required |
SettlementBatchStatus SettlementBatchStatus | The batch's terminal status. Never `Pending`.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||
errorMessage
required |
string | The persisted operator-facing reason (`SettlementBatch.ErrorMessage`). Already sanitized
at write time: raw exception text stays in the structured logs.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||
completedAtUtc
required |
string (date-time) | When the batch reached its terminal state, falling back to its creation time when the batch has
no recorded completion time. The lookback window and the newest-first order both use this value.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||
triggerType
required |
SettlementTriggerType SettlementTriggerType |
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||
correlationId
required |
string (uuid) |
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||
instanceId
required |
string |
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This model has no documented fields.