Disputes

Generate representment PDF

Compile your representment sections into a PDF and attach it to the dispute. Call this after you are satisfied with the written sections and ready to finalize your representment.

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

Request

Base URL
https://api.staging.payrails.io
Auth
HTTP bearer
TypeScript
https://skmtc.dev/payrails/apis/payrails-api-reference/docs/dispute/disputes/:disputeId/evidences/generate-representment/post.ts
A function with typed inputs. Its response is checked against the schema.

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.

Request body

includeTimelineboolean

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.

Changes

No recorded changes to this operation across all 1 revision of this API.