Sign in

v1

latestOpenAPI 3.1.02026-07-2663312285.4 KB
Dispute Reports

Create a dispute report

Triggers generation of a dispute report for the given merchant over the specified date range. The date range must be within the last 90 days and the end date must be before now.

post/v1/dispute-reports

Headers

Merchant-Idstring required

The merchant identifier.

Request-Referencestring

Optional Reference for the request. This is used to identify the request in debugging.

Request-Idempotency-Keystring

Optional Idempotency Key for the request. Sending duplicate requests will result in 409 HTTP status code.

Request body

startDatestring date-time required

Start of the reporting window. Must be within the last 90 days.

endDatestring date-time required

End of the reporting window.

Example request

{
  "startDate": "2026-06-17T00:00:00Z",
  "endDate": "2026-07-17T11:58:00Z"
}

Response

Report created successfully

idstring

Unique report identifier.

startDatestring date-time

Start of the reporting window.

endDatestring date-time

End of the reporting window.

status'PENDING' | 'PROCESSED' | 'FAILED' | 'EXPIRED'

Current processing status of the report.

downloadUrlstring

Pre-signed URL to download the generated report file. Present only when status is PROCESSED.

createdAtstring date-time

Timestamp when the report was created.

updatedAtstring date-time

Timestamp when the report was updated.

Example response

{
  "id": "report_a1b2c3d4e5f67890abcde",
  "startDate": "2026-06-17T00:00:00Z",
  "endDate": "2026-07-17T11:58:00Z",
  "status": "PENDING",
  "downloadUrl": "https://example.com/reports/report_a1b2c3d4e5f67890abcde.csv?expires=3600",
  "createdAt": "2026-07-17T12:00:00Z",
  "updatedAt": "2026-07-17T12:00:00Z"
}