PApayrails
Disputes

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.

get/dispute/disputes/runs/{runId}

Request

Path parameters

runIdstring uuid required

Identifier of the resource in Payrails.

Response

Success.

idstring uuid required

Unique identifier of the run.

workspaceIdstring uuid

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

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

status'queued' | 'dispatched' | 'done' required

Lifecycle state of the run.

resolution'success' | 'failed' | 'cancelled'

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

errorsstring[]

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

paramsobject

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.

summaryobject

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

inputobject

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

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

startedAtstring date-time

Date and time when the run started executing.

completedAtstring date-time

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

createdAtstring date-time required

Date and time when the run was created.

updatedAtstring date-time required

Date and time when the run was last updated.

Example response

{
  "runType": "dispute-pull-controller"
}

Changes

No recorded changes to this operation across all 1 revision of this API.