Skip to main content
GET
Get a dispute service run by ID

Authorizations

Authorization
string
header
required

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

runId
string<uuid>
required

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.

id
string<uuid>
required

Unique identifier of the run.

runType
string
required

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).

Example:

"dispute-pull-controller"

status
enum<string>
required

Lifecycle state of the run.

Available options:
queued,
dispatched,
done
createdAt
string<date-time>
required

Date and time when the run was created.

updatedAt
string<date-time>
required

Date and time when the run was last updated.

workspaceId
string<uuid>

Workspace the run belongs to. Omitted for runs that are not scoped to a single workspace.

resolution
enum<string>

Outcome of a completed run. Absent until the run reaches done.

Available options:
success,
failed,
cancelled
errors
string[]

Error messages collected during execution, when the run did not fully succeed.

params
object

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.

summary
object

Aggregate result of the run. The shape depends on runType; a dispute-pull window reports disputesPulled, disputesUpserted, paymentsPulled, paymentsUpserted and any unsupportedOps.

input
object

Trigger metadata for the run, such as the resolved window or cursor.

parentRunId
string<uuid>

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.

startedAt
string<date-time>

Date and time when the run started executing.

completedAt
string<date-time>

Date and time when the run finished. Absent until the run reaches done.

jobs
object[]

The run's execution attempts, most recent first. Included only when a single run is retrieved by id.

Last modified on October 1, 2026