SettlementRunStateDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Whether a manually triggered settlement run has finished.
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 | ||||||
|---|---|---|---|---|---|---|---|---|
merchantId
required |
string (uuid) | The merchant the run was triggered for.
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 run the state is about.
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.
| ||||||
state
required |
SettlementRunState SettlementRunState | Whether the run is still going, has finished, or could not be determined. Only
`Finished` means every settlement batch the run will produce
has reached its final status.
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.
| ||||||
queriedAtUtc
required |
string (date-time) | When the state was read, in UTC.
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.