Submit Dispute Response Action

post

https://api-test.qualpay.com/platform/dispute/{recId}/action

Submit dispute responses with supporting documentation. Response options are based on the 'response_options' provided when fetching a dispute with the 'response_options' URL parameter.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

recId

int64

required

The control number of the dispute case, returned as the rec_id value for a 'Create' or 'Get' query.

Body Params

A response to the dispute, performing the action specified. In addition to the properties listed below, all 'field' type dispute attributes along the branch of the dispute attribute tree may be included with their corresponding values.

action

string

enum

The action to take for this dispute. The available actions are based on the dispute's reason code and current status. The list of possible actions is provided in the dispute's 'response' attribute when fetched with the 'response_options' URL parameter. * accept - Accept the dispute as validated. * respond - Respond to the dispute with evidence. * edit - Edit the dispute response previously submitted. * challenge - [todo]. * arbitration - Send the dispute to arbitration. * withdraw - Withdraw from pre-arbitration. * retry - (ACH Only) Retry the payment. * block - (ACH Only) [todo]. description: The action to take for this dispute.

response_code

string

The response code being submitted. Required if the action is 'respond'.

amt_dispute

double

The amount being disputed in the response.

ce_code

string

The compelling evidence code being submitted, required if the response_code is 'CE'.

ce_indicators

array of strings

The compelling evidence indicators being submitted, may be required if the ce_code included indicators.

ce_indicators

id_code

string

The invalid dispute code being submitted, required if the response_code is 'ID'.

Responses

200Success

400Request Validation Failed

500Internal Error