Get a dispute service run by ID
Retrieve a single dispute service run by its ID, including its execution attempts. A run that exists but belongs to a workspace you cannot access returns 404. Use this to inspect the outcome of a backfill, including its window, the disputes and payments it loaded, and any unsupported operations.
Authorizations
You can use an OAuth2 JWT bearer token in the Authorization header of your API requests for supported endpoints: Authorization: Bearer <YOUR_JWT_HERE>.
These tokens are valid for 10 minutes and can be requested via the access token endpoint endpoint.
Path Parameters
Identifier of the resource in Payrails.
Response
Success.
An asynchronous run in the dispute service. A run is created when an operation is enqueued (for example a backfill) and tracks its lifecycle and outcome. Status and resolution are derived from the run's latest execution attempt.
Unique identifier of the run.
The kind of work the run performs, for example dispute-pull-controller (owns the cursor for one provider configuration) or dispute-pull-window (pulls disputes and their related payments for one time window).
"dispute-pull-controller"
Lifecycle state of the run.
queued, dispatched, done Date and time when the run was created.
Date and time when the run was last updated.
Workspace the run belongs to. Omitted for runs that are not scoped to a single workspace.
Outcome of a completed run. Absent until the run reaches done.
success, failed, cancelled Error messages collected during execution, when the run did not fully succeed.
The arguments the run was started with. The shape depends on runType; a dispute-pull run carries providerConfigId, optional paymentProviderConfigId, and the dateFrom / dateTo window.
Aggregate result of the run. The shape depends on runType; a dispute-pull window reports disputesPulled, disputesUpserted, paymentsPulled, paymentsUpserted and any unsupportedOps.
Trigger metadata for the run, such as the resolved window or cursor.
For a child run, the identifier of the run that spawned it (for example a dispute-pull window's controller). Absent for top-level runs.
Date and time when the run started executing.
Date and time when the run finished. Absent until the run reaches done.
The run's execution attempts, most recent first. Included only when a single run is retrieved by id.