increase-test
POST/simulations/card_disputes/{card_dispute_id}/action

Advance a card dispute in the sandbox

Advances a Card Dispute through simulated states in the sandbox, where no review or further action occurs automatically. Supply the dispute's network and the corresponding network-specific action details. For the Visa network, choose an action and include the matching action object when that action requires parameters.

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

1 parameter · 2 body fields
card_dispute_idstringrequired
The identifier of the Card Dispute to advance.

The network and network-specific action to simulate for the Card Dispute.

networkstringrequired
The network of the Card Dispute. 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 taking action on the dispute. Required if and only if `network` is `visa`.

3 status codes
200Returns the updated Card Dispute object, including its current status and network 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 cannot be processed because of a client-side error.
5XXReturned when the service encounters a server-side error.

Error handling

The body requires network set to visa and a visa.action value from the supported actions; include the matching action object, with explanation for reject or reason for request_further_information. The card_dispute_id path parameter must identify the Card Dispute to advance.