Skip to main content
POST
Regenerate representment plan

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.

Headers

x-idempotency-key
string<uuid>
required

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

Path Parameters

disputeId
string<uuid>
required

Identifier of the resource in Payrails.

Response

Representment plan regenerated successfully.

disputeId
string<uuid>
required

Unique identifier of the dispute in Payrails.

createdAt
string<date-time>
required

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

updatedAt
string<date-time>
required

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

status
enum<string>
required

Status of the representment plan lifecycle.

Available options:
GeneratingPlan,
PlanReady,
StoringEvidences,
LabelingEvidences,
EvidencesReady,
GeneratingRepresentment,
RepresentmentReady,
Submitted
providerResponseId
string

Provider response identifier for representment plan generation.

recommendation
string

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

rationale
string

Explanation supporting the recommendation.

defenseReasons
object[]

Defense reason codes with evidence options, grouped by provider reason code.

Last modified on October 7, 2026