New Chargeflow docs. Everything for merchants, platforms, and the API in one place.
Current (2025-04-01)Merchants APIDisputes

Get Dispute by ID

GET
/public/2025-04-01/disputes/{disputeId}
x-api-key<token>

Your Chargeflow API key. Generate it in the Developer Hub under Settings.

In: header

Path Parameters

disputeId*string

The unique Chargeflow object identifier of the dispute.

Match^[0-9a-fA-F]{24}$

Query Parameters

expand?array<>

Available Expansions

Use the expand parameter to include additional resource details in the response.

Available options:

ParameterDescription
transactionFull payment transaction details including amount, currency, payment method and more
orderComplete order details including products, shipping, and fulfillment and more
subscriptionComplete subscription details including plan, frequency, cancellation reason and more
customer_communicationComplete customer communication details including messages, sender, and more

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/public/2025-04-01/disputes/string"
{  "id": "string",  "source": "paypal",  "source_id": "string",  "account_id": "string",  "ext_account_id": "string",  "created_at": "2019-08-24T14:15:22Z",  "reason": "fraud",  "due_by": "2019-08-24T14:15:22Z",  "amount": 0,  "currency": "str",  "status": "needs_response",  "stage": "Chargeback",  "closed_at": "2019-08-24T14:15:22Z",  "transaction": "string",  "subscription": "string",  "order": "string"}
Was this page helpful?