Raise Disputes

Raise a dispute

Changed on

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.

post/disputes

Request

  • Base URL
    https://balanceplatform-api-live.adyen.com/btl/api/v4
  • URL
    https://balanceplatform-api-live.adyen.com/btl/api/v4/disputes
  • Auth
    none declared

Request body

descriptionstring

Your description for the dispute.

status'draft' | 'submitted' | 'chargeback' | 'secondPresentment' | 'won' | 'closed'
transactionIdstring required

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

typestring required

Response

OK - the request has succeeded.

arnstring

The unique Acquirer Reference Number (arn) generated by the card scheme for each capture. You can use the arn to trace the transaction through its lifecycle.

descriptionstring

Your description for the dispute.

idstring

The unique identifier of the raised dispute.

status'draft' | 'submitted' | 'chargeback' | 'secondPresentment' | 'won' | 'closed'
transactionIdstring required

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

typestring required

Changes

    • breaking

      the / request property's minLength was increased from 0 to 1

    • breaking

      the request property's minLength was increased from 0 to 1

    • info

      added the new optional request property

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status