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

Create Dispute

Authorization

Request Body

Response Body

200application/json

`application/json`