Raise a dispute

post/disputes

Raise a dispute for an underlying transaction, providing a dispute type and the amount you want to dispute.

Raising a dispute returns a dispute ID, which you can use to update details about the dispute, provide supporting documentation, close the dispute, or submit the dispute for a chargeback. You can also use the dispute ID to view the status of the dispute.

Endpoint destination URL
Click to copy

Request Parameters

descriptionstring

Your description for the dispute.

disputedAmountobject

The amount for which you dispute the transaction. The disputed amount cannot be greater than the transaction amount. If you do not provide an amount, the entire transaction amount will be disputed.

fraudInfoobject

Additional information for raising a dispute of type fraud. Required for disputes of type fraud.

notDeliveredInfoobject

Additional information for raising a dispute of type notDelivered. Required for disputes of type notDelivered.

statusstring

The current status of the dispute.

You can update a dispute to submitted or closed.

Possible values: draft, submitted, closed, won, chargeback, secondPresentment.

transactionIdstringRequired

The unique reference of the transaction for which you are raising the dispute.

typestringRequired

The type of the dispute.

Possible values: notDelivered, fraud.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

  • 200 - OK

    The request has succeeded.

    Show moreShow less