Legacy (2024-03-18)Merchants API
Disputes
Disputes management endpoints
Was this page helpful?
Disputes management endpoints
apiKey Your Chargeflow API key, sent on every request. Generate one in the Chargeflow App, or see API keys.
In: header
Maximum number of disputes to return in a single response
1 <= value <= 10015Number of disputes to skip for pagination
0 <= value0Filter disputes created after this date (ISO 8601 format)
Filter disputes created before this date (ISO 8601 format)
Filter disputes with amount greater than or equal to this value
0 <= value0Filter disputes with amount less than or equal to this value
0 <= value1000Filter disputes by status (comma-separated values)
Value in
Filter disputes by reason (comma-separated values)
Value in
Filter disputes by payment processor (comma-separated values)
Value in
application/json
curl -X GET "https://example.com/public/2024-03-18/disputes?limit=10&offset=0"{ "totalCount": 100, "hasMore": true, "data": [ { "chargeflowDisputeId": "66e6ea9ecd94925a9f8060d9", "dispute": { "processorId": "PP-D-4012", "processor": "paypal", "amount": { "value": 100, "currency": "USD" }, "status": "won", "reason": "fraud", "responseDueDate": "2021-01-01T00:00:00Z" }, "transaction": { "id": "123e4567-e89b-12d3-a456-426614174000", "creationDate": "2021-01-01T00:00:00Z", "source": "stripe", "orderId": "4141404271159", "customerEmail": "john@example.com" } } ]}apiKey Your Chargeflow API key, sent on every request. Generate one in the Chargeflow App, or see API keys.
In: header
application/json
TypeScript Definitions
Use the request body type in TypeScript.
The id of the dispute in your payment processor.
length <= 10000ISO 8601 timestamp - when the charge was disputed.
date-timeISO 8601 timestamp - when dispute evidence needs to be disputed by.
date-timeThe id of the disputed charge in your payment processor.
length <= 10000The id of the transaction in your payment processor.
length <= 128The date and time when the transaction was created, in ISO 8601 format
date-timeThe bank provided reason for the dispute.
Value in
The amount of the disputed charge. Amounts are in cents (or other minor currency unit.)
0 <= valueThe currency code of the disputed charge. e.g. 'USD'.
length <= 10The payment processor for the charge.
length <= 128application/json
curl -X POST "https://example.com/public/2024-03-18/disputes" \ -H "Content-Type: application/json" \ -d '{ "disputeId": "dp_1MykdxFtDWhhyHE1BFAV3osZ", "creationDate": "2022-01-01T00:00:00Z", "due_by": "2022-01-01T00:00:00Z", "disputeAmount": 100, "currency": "USD", "processor": "Stripe, Shopify, Braintree etc.", "isChargeRefundable": true, "handleByChargeflow": true }'{ "requestId": "string"}apiKey Your Chargeflow API key, sent on every request. Generate one in the Chargeflow App, or see API keys.
In: header
The Chargeflow dispute id
^[0-9a-fA-F]{24}$multipart/form-data
TypeScript Definitions
Use the request body type in TypeScript.
Option 1: object
binaryThe category of the evidence upload
Value in
Option 2: object
binaryThe category of the evidence upload
Value in
The content of the evidence. Only required with additional_notes and additional_evidence categories
application/json
curl -X POST "https://example.com/public/2024-03-18/disputes/66e6ea9ecd94925a9f8060d9/evidence" \ -F file="string" \ -F evidenceUploadCategory="invoice"{ "requestId": "string", "evidenceId": "string"}