SettlementRunState
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
The lifecycle of one settlement run, as a caller waiting on it needs to see it.
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.
Running |
The run's workflow is still going, or it has finished and a batch it wrote still reads as pending. Its outcome is not final yet. |
Finished |
The run's workflow has ended and none of its batches is still pending, so its settlement batches are final. |
Unknown |
The state could not be determined. Either the run could not be found or read, or it has ended and none of its batches is visible among the merchant's batches from the last 48 hours. A run id the server does not recognize (a mistyped id, or the id of a scheduled or all-merchant run) reads as Unknown rather than as not found, so Unknown is not a verdict: keep polling only up to the run's expected duration, then stop and read the recent outcomes instead. |
Fields
| Field | Type | Description |
|---|
This model has no documented fields.