v1

latestOpenAPI 3.1.0Payrails GmbH2026-07-2614905.7 MB
Disputes

Regenerate representment plan

Discard the current representment plan and generate a fresh one from scratch. Use this when the AI-generated plan does not meet your needs and you want to start over. Returns the new plan immediately. Not available after the defense has been submitted or while another operation is in progress.

post/dispute/disputes/{disputeId}/evidences/regenerate-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

Representment plan regenerated successfully.

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.