Disputes

Get Disputes

Authorization

apiKey

x-api-key<token>

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

In: header

Query Parameters

limit?number

Maximum number of disputes to return in a single response

Range1 <= value <= 100

Default15

offset?number

Number of disputes to skip for pagination

Range0 <= value

Default0

dateCreatedFrom?string

Filter disputes created after this date (ISO 8601 format)

dateCreatedTo?string

Filter disputes created before this date (ISO 8601 format)

amountFrom?number

Filter disputes with amount greater than or equal to this value

Range0 <= value

Default0

amountTo?number

Filter disputes with amount less than or equal to this value

Range0 <= value

Default1000

statusNames?string

Filter disputes by status (comma-separated values)

Value in

"won"
"lost"
"refunded"
"under_review"
"warning_under_review"
"needs_response"
"warning_needs_response"
"warning_awaiting_response"
"awaiting_response"
"warning_won"
"appealable"
"insured"
"open"
"action_required"
"processing"

reason?string

Filter disputes by reason (comma-separated values)

Value in

"bank_cannot_process"
"check_returned"
"credit_not_processed"
"customer_initiated"
"debit_not_authorized"
"duplicate"
"general"
"incorrect_account_details"
"insufficient_funds"
"product_not_received"
"product_unacceptable"
"not_received"
"not_as_described"
"subscription_canceled"
"canceled"
"duplicate_charge"
"payment_by_other_means"
"unrecognized"
"incorrect_amount"
"fraud"
"canceled_recurring_billing"
"other"
"problem_with_remittance"
"unauthorized"

processorNames?string

Filter disputes by payment processor (comma-separated values)

Value in

"stripe"
"shopify"
"klarna"
"afterpay"
"paypal"
"adyen"

Response Body

`application/json`

curl -X GET "https://example.com/public/2024-03-18/disputes"

{  "totalCount": 0,  "hasMore": true,  "data": [    {      "chargeflowDisputeId": "string",      "dispute": {        "processorId": "string",        "processor": "string",        "amount": {          "value": 0,          "currency": "string"        },        "status": "under_review",        "reason": "bank_cannot_process",        "responseDueDate": "2019-08-24T14:15:22Z"      },      "transaction": {        "id": "string",        "creationDate": "2019-08-24T14:15:22Z",        "source": "string",        "orderId": "string",        "customerEmail": "user@example.com"      }    }  ]}

Create Dispute

Authorization

apiKey

x-api-key<token>

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

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

disputeId*string

The id of the dispute in your payment processor.

Lengthlength <= 10000

creationDate*string

ISO 8601 timestamp - when the charge was disputed.

Formatdate-time

due_by*string

ISO 8601 timestamp - when dispute evidence needs to be disputed by.

Formatdate-time

charge?string

The id of the disputed charge in your payment processor.

Lengthlength <= 10000

transactionId?string

The id of the transaction in your payment processor.

Lengthlength <= 128

transactionDate?string

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

Formatdate-time

reason?string

The bank provided reason for the dispute.

Value in

"general"
"fraudulent"
"duplicate"
"subscription_canceled"
"product_unacceptable"
"product_not_received"
"unrecognized"
"credit_not_processed"
"incorrect_account_details"
"insufficient_funds"
"bank_cannot_process"
"debit_not_authorized"
"goods_services_returned_or_refused"
"goods_services_cancelled"
"transaction_amount_differs"
"retrieved"

disputeAmount*number

The amount of the disputed charge. Amounts are in cents (or other minor currency unit.)

Range0 <= value

currency*string

The currency code of the disputed charge. e.g. 'USD'.

Lengthlength <= 10

processor*string

The payment processor for the charge.

Lengthlength <= 128

status?string

The status of the dispute.

Value in

"needs_response"
"warning_needs_response"

isChargeRefundable*boolean

Is the disputed charge refundable.

addressLine1Check?string

State of address check (if available). One of pass, fail, unavailable, unchecked.

Value in

"pass"
"fail"
"unavailable"
"unchecked"

addressZipCheck?string

State of address zip check (if available). One of pass, fail, unavailable, unchecked.

Value in

"pass"
"fail"
"unavailable"
"unchecked"

cvcCheck?string

State of cvc check (if available). One of pass, fail, unavailable, unchecked.

Value in

"pass"
"fail"
"unavailable"
"unchecked"

products?array<>

List of products the customer purchased.

pastPayments?array<string>

History of the customer's valid, non-disputed transactions using the same card.

handleByChargeflow*boolean

Whether you wish Chargeflow to handle the dispute or not. If True - Chargeflow will submit evidence for the dispute. If False - Chargeflow will not handle the dispute.

Response Body

`application/json`

curl -X POST "https://example.com/public/2024-03-18/disputes" \  -H "Content-Type: application/json" \  -d '{    "disputeId": "string",    "creationDate": "2019-08-24T14:15:22Z",    "due_by": "2019-08-24T14:15:22Z",    "disputeAmount": 0,    "currency": "string",    "processor": "string",    "isChargeRefundable": true,    "handleByChargeflow": true  }'

{  "requestId": "string"}

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 Chargeflow dispute id

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/2024-03-18/disputes/string/order" \  -H "Content-Type: application/json" \  -d '{}'

{  "requestId": "string"}

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 Chargeflow dispute id

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/2024-03-18/disputes/string/evidence" \  -F file="string" \  -F evidenceUploadCategory="tracking_information"

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

Disputes

200application/json

200application/json

200application/json

200application/json

`application/json`

`application/json`

`application/json`

`application/json`