increase-test
POST/card_disputes

Create a card dispute

Creates a card dispute for a transaction, providing details for review by the card network. Supply disputed_transaction_id and network, then include the Visa-specific category details and any supporting attachments required for the dispute. The transaction must have a card_settlement source type.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

6 body fields

Card dispute details. disputed_transaction_id and network are required; provide the Visa-specific details when network is visa.

amountintegeroptional
The monetary amount of the part of the transaction that is being disputed. This is optional and will default to the full amount of the transaction if not provided. If provided, the amount must be less than or equal to the amount of the transaction.
attachment_filesarray<object>optional
The files to be attached to the initial dispute submission.
disputed_transaction_idstringrequired
The Transaction you wish to dispute. This Transaction must have a `source_type` of `card_settlement`.
explanationstringoptional
The free-form explanation provided to Increase to provide more context for the user submission. This field is not sent directly to the card networks.
networkstringrequired
The network of the disputed transaction. Details specific to the network are required under the sub-object with the same identifier as the network.
Allowed:visa
visaobjectoptional
The Visa-specific parameters for the dispute. Required if and only if `network` is `visa`.

3 status codes
200Returns the created card dispute, including its identifier, amount, status, network, and associated transaction, account, and card identifiers.
account_idstringrequired
The Account that the Card Dispute is associated with.
amountintegerrequired
The amount of the dispute.
card_idstringrequired
The Card that the Card Dispute is associated with.
created_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Card Dispute was created.
disputed_transaction_idstringrequired
The identifier of the Transaction that was disputed.
idstringrequired
The Card Dispute identifier.
idempotency_keystringrequired
The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).
lossobjectrequired
If the Card Dispute's status is `lost`, this will contain details of the lost dispute.
networkstringrequired
The network that the Card Dispute is associated with.
Allowed:visapulse
rejectionobjectrequired
If the Card Dispute has been rejected, this will contain details of the rejection.
statusstringrequired
The status of the Card Dispute.
Allowed:user_submission_requiredpending_user_submission_reviewingpending_user_submission_submittingpending_user_withdrawal_submittingpending_responselostwonrejected
typestringrequired
A constant representing the object's type. For this resource it will always be `card_dispute`.
Allowed:card_dispute
user_submission_required_bystringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the user submission is required by. Present only if status is `user_submission_required` and a user submission is required by a certain time. Otherwise, this will be `nil`.
visaobjectrequired
Card Dispute information for card payments processed over Visa's network. This field will be present in the JSON response if and only if `network` is equal to `visa`.
winobjectrequired
If the Card Dispute's status is `won`, this will contain details of the won dispute.
withdrawalobjectrequired
If the Card Dispute has been withdrawn, this will contain details of the withdrawal.
4XXReturned when the request results in a client error.
5XXReturned when the request results in a server error.

Error handling

disputed_transaction_id and network are required; the transaction must have a card_settlement source type, and network must be visa. If provided, amount must be at least 1 and no greater than the transaction amount, and explanation must contain 1 to 200 characters. Each attachment's file_id must refer to a file with the card_dispute_attachment purpose.