Skip to main content
POST
Generate representment PDF

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.

Body

application/json
caseDetails
object[]
includeTimeline
boolean
default:false

When true, renders the "Timeline of Events" section in the PDF if the dispute has timeline events. Omitted or false leaves the timeline out.

Response

Representment PDF compiled and attached to the dispute.

representmentPlan
object

Updated representment plan after representment PDF was generated.

generatedEvidence
object

Generated representment PDF evidence metadata.

Last modified on October 1, 2026