Sign in

v1

latestOpenAPI 3.1.0Payrails GmbH2026-07-2614905.7 MB
Disputes

Generate representment plan

Generate a representment plan for a dispute.

post/dispute/disputes/{disputeId}/evidences/generate-plan

Path parameters

disputeIdstring uuid required

Identifier of the resource in Payrails.

Headers

x-idempotency-keystring uuid required

Idempotency key to be used. Sending again the same key would return the same result without re-executing the update.

Response

Dispute representment plan generated.

disputeIdstring uuid required

Unique identifier of the dispute in Payrails.

providerResponseIdstring

Provider response identifier for representment plan generation.

createdAtstring date-time required

Date and time when the representment plan was created in Payrails.

updatedAtstring date-time required

Date and time when the representment plan was last updated in Payrails.

status'GeneratingPlan' | 'PlanReady' | 'StoringEvidences' | 'LabelingEvidences' | 'EvidencesReady' | 'GeneratingRepresentment' | 'RepresentmentReady' | 'Submitted' required

Status of the representment plan lifecycle.

recommendationstring

Recommended action for the merchant (e.g. "defend" or "accept").

rationalestring

Explanation supporting the recommendation.