Submit defense plan evidences

post

https://api.staging.payrails.io/dispute/disputes/{disputeId}/evidences/submit-plan

Store selected evidences in the defense plan and generate defense sections.

Path Params

disputeId

uuid

required

Identifier of the resource in Payrails.

Body Params

selectedDefenseReasonCode

string

The provider reason code the merchant wants to defend with. If omitted, the LLM-suggested code from plan generation remains in effect.

evidences

array of objects

required

length ≥ 1

List of selected defense plan evidence items and target positions. Each position must be unique.

evidences*

evidenceId

uuid

required

Unique identifier of an uploaded evidence linked to this dispute.

position

integer

required

≥ 0

Target defense plan evidence position to associate with evidenceId.

labels

array of strings

Labels to assign to this evidence for the dispute, used to categorise the document during representment.

labels

userPrompt

string

Additional user prompt to generate defense sections. If not provided, the system will use a default prompt.

Headers

x-idempotency-key

uuid

required

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

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Choose an example:

application/json

200Defense plan evidences submitted and defense sections generated.

400Bad Request.

401Unauthorized.

403Forbidden.

404Not Found.

429Too Many Requests.

500Internal Server Error.