Disputes

Upload Evidence

Authorization

apiKey

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}$

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

file*file

Formatbinary

evidenceUploadCategory*string

The category of the evidence upload

Value in

"tracking_information"
"customer_communication"
"invoice"

Response Body

`application/json`

curl -X POST "https://example.com/public/2025-04-01/disputes/string/evidence" \  -F file="string" \  -F evidenceUploadCategory="tracking_information"

{  "requestId": "string",  "evidenceId": "string"}

Get Dispute by ID

Authorization

apiKey

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:

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

Response Body

`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"}

Enrich Dispute

Authorization

apiKey

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}$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

transaction?

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.

order?

An order is a record of a customer's purchase request, detailing the items bought, payment information, fulfillment status, and more.

Response Body

`application/json`

curl -X PATCH "https://example.com/public/2025-04-01/disputes/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "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"}

Get Disputes

Authorization

apiKey

x-api-key<token>

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

In: header

Query Parameters

offset?integer

The page number of the current response

Range0 <= value

Default0

limit?integer

The number of disputes per page

Range1 <= value <= 100

Default25

Response Body

`application/json`

curl -X GET "https://example.com/public/2025-04-01/disputes"

{  "disputes": [],  "pagination": {    "totalCount": 0,    "offset": 0,    "limit": 25,    "totalPages": 0  }}

Update Dispute Order

Authorization

apiKey

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}$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

orderReference?string

A field that can hold the name of the order as identified in your system, which could be an invoice ID or any other reference

Lengthlength <= 10000

creationDate?string

The date and time when the order was created, recorded in ISO 8601 format

Formatdate-time

checkoutId?string

An optional identifier for the checkout process associated with the order

Lengthlength <= 10000

orderStatusUrl?string

An optional URL that directs to a page where the status of the order can be reviewed

Formaturi

amount?

financialStatus?string

An enum value represents the current financial status of the order. Possible values include paid, partially_refunded, and refunded, which indicate the payment stage of the order

Value in

"paid"
"partially_refunded"
"refunded"

customer?

An object that represents the customer’s details under this order

billingAddress?

An object that represents the billing address of the order's payer

shippingAddress?

An object that represents the shipping address of the order's payer

products?array<>

An array of objects that represent the products included in this order

transactions?array<>

An array of objects that represent the transactions related to this order

shipments?array<>

An array of objects that represent the shipments related to shipments this order

subscriptions?array<>

An array of objects that represent the subscriptions related to this order

pastOrders?array<>

An array of objects that represent the past orders related to this order

Response Body

`application/json`

curl -X POST "https://example.com/public/2025-04-01/disputes/string/order" \  -H "Content-Type: application/json" \  -d '{}'

{  "requestId": "string"}

Disputes

200application/json

400application/json

403application/json

404application/json

500application/json

Available Expansions

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

401application/json

403application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`