Current (2025-04-01)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
The unique Chargeflow object identifier of the dispute.
^[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
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/public/2025-04-01/disputes/66e6ea9ecd94925a9f8060d9/evidence" \ -F file="string" \ -F evidenceUploadCategory="invoice"{ "requestId": "string", "evidenceId": "string"}apiKey Your Chargeflow API key, sent on every request. Generate one in the Chargeflow App, or see API keys.
In: header
The unique Chargeflow object identifier of the dispute.
^[0-9a-fA-F]{24}$Use the expand parameter to include additional resource details in the response.
Available options:
| Parameter | Description |
|---|---|
transaction | Full payment transaction details including amount, currency, payment method and more |
order | Complete order details including products, shipping, and fulfillment and more |
subscription | Complete subscription details including plan, frequency, cancellation reason and more |
customer_communication | Complete customer communication details including messages, sender, and more |
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/public/2025-04-01/disputes/66e6ea9ecd94925a9f8060d9"{ "id": "66e6ea9ecd94925a9f8060d9", "source": "stripe", "source_id": "du_123456789", "account_id": "66e6ea9ecd94925a9f8060d9", "ext_account_id": "acc_123456", "created_at": "2024-02-10T12:00:00Z", "reason": "fraud", "due_by": "2024-02-20T12:00:00Z", "amount": 100, "currency": "USD", "status": "needs_response", "stage": "Chargeback", "closed_at": "2025-01-27T10:00:00Z", "transaction": "66e6ea9ecd94925a9f8060d9", "subscription": "66e6ea9ecd94925a9f8060d9", "order": "ord_1234567890"}apiKey Your Chargeflow API key, sent on every request. Generate one in the Chargeflow App, or see API keys.
In: header
The unique Chargeflow object identifier of the dispute.
^[0-9a-fA-F]{24}$application/json
TypeScript Definitions
Use the request body type in TypeScript.
A transaction represents a money exchange between a buyer and a merchant in return for a physical product, digital product, service, booking, or other goods and offerings.
An order is a record of a customer's purchase request, detailing the items bought, payment information, fulfillment status, and more.
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/public/2025-04-01/disputes/66e6ea9ecd94925a9f8060d9" \ -H "Content-Type: application/json" \ -d '{ "transaction": { "source_id": "tx_1234567890", "created_at": "2024-02-10T12:00:00Z", "type": "paid", "amount": 100, "currency": "USD", "payment_method": { "type": "card", "name": "John Doe", "last4": "1234", "expiry_month": 1, "expiry_year": 2025, "brand": "visa" } } }'{ "id": "66e6ea9ecd94925a9f8060d9", "source": "stripe", "source_id": "du_123456789", "account_id": "66e6ea9ecd94925a9f8060d9", "ext_account_id": "acc_123456", "created_at": "2024-02-10T12:00:00Z", "reason": "fraud", "due_by": "2024-02-20T12:00:00Z", "amount": 100, "currency": "USD", "status": "needs_response", "stage": "Chargeback", "closed_at": "2025-01-27T10:00:00Z", "transaction": "66e6ea9ecd94925a9f8060d9", "subscription": "66e6ea9ecd94925a9f8060d9", "order": "ord_1234567890"}apiKey Your Chargeflow API key, sent on every request. Generate one in the Chargeflow App, or see API keys.
In: header
The unique Chargeflow object identifier of the dispute.
^[0-9a-fA-F]{24}$application/json
TypeScript Definitions
Use the request body type in TypeScript.
Creates a new Chargeflow subscription.
The unique subscription identifier appears on the source from which the subscription originated.
length <= 128The unique Chargeflow account identifier to which the subscription belongs. This field is required for platform users.
^[0-9a-fA-F]{24}$The time at which the subscription was created at the source in ISO 8601 format.
date-timeThe time at which the subscription was started at the source in ISO 8601 format.
date-timeThe frequency at which a subscription is billed.
Value in
The number of intervals per billing cycle. For example, if frequency = month and frequency_count = 1, the subscription renews every month. If frequency_count = 3, the subscription renews every three months.
1 <= valueThe billing method for the subscription.
"automatically"Value in
The time at which the subscription was updated at the source in ISO 8601 format.
date-timeThe time at which the subscription was ended at the source in ISO 8601 format.
date-timeThe time at which the subscription was requested to be canceled at the source in ISO 8601 format. Returns null if a cancellation is never requested.
date-timeapplication/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/public/2025-04-01/disputes/66e6ea9ecd94925a9f8060d9/subscription" \ -H "Content-Type: application/json" \ -d '{ "source_id": "source_sub_1234567890", "created_at": "2024-02-10T12:00:00Z", "start_date": "2024-02-10T12:00:00Z", "frequency": "month", "frequency_count": 1 }'{ "id": "66e6ea9ecd94925a9f8060d9", "source_id": "source_sub_1234567890", "account_id": "66e6ea9ecd94925a9f8060d9", "ext_account_id": "acc_123456", "created_at": "2024-02-10T12:00:00Z", "updated_at": "2024-02-15T12:00:00Z", "start_date": "2024-02-10T12:00:00Z", "end_date": "2024-08-10T12:00:00Z", "cancellation_date": "2024-07-10T12:00:00Z", "frequency": "month", "frequency_count": 1, "cancellation_reason": "too_expensive", "collection_method": "automatically", "trial_start": "2024-02-10T12:00:00Z", "trial_end": "2024-03-10T12:00:00Z", "renews_at": "2024-03-10T12:00:00Z", "plan_name": "Pro Plan", "pricing_model": "fixed_price", "status": "active"}apiKey Your Chargeflow API key, sent on every request. Generate one in the Chargeflow App, or see API keys.
In: header
The page number of the current response
0 <= value0The number of disputes per page
1 <= value <= 10025application/json
application/json
application/json
application/json
curl -X GET "https://example.com/public/2025-04-01/disputes?offset=0&limit=10"{ "disputes": [], "pagination": { "totalCount": 0, "offset": 0, "limit": 25, "totalPages": 0 }}