increase-test
POST/card_disputes/{card_dispute_id}/withdraw

Withdraw a Card Dispute

Withdraws a Card Dispute and records the reason you provide. Use explanation to describe why you are withdrawing the dispute; it can contain 1 to 2048 characters. The response contains the Card Dispute after the withdrawal.

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

1 parameter · 1 body field
card_dispute_idstringrequired
The identifier of the Card Dispute to withdraw.

The withdrawal details. You can provide an explanation for withdrawing the Card Dispute.

explanationstringoptional
The explanation for withdrawing the Card Dispute.

3 status codes
200Returns the Card Dispute object, including its identifier, amount, status, and withdrawal details.
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 encounters a client-side error.
5XXReturned when the request encounters a server-side error.

Error handling

The card_dispute_id path parameter must identify the Card Dispute to withdraw. If supplied, explanation must contain between 1 and 2048 characters.