availability

Managing disputes via the API is only available to merchants who can access disputes in the Braintree Control Panel.

You can only finalize disputes that have a status of OPEN. This will submit the evidence to the banks and update the status to DISPUTED.

important

You must call this function in order for the evidence to be submitted on the dispute.

PHP
Copy
Copied
$result = $gateway->dispute()->finalize("a_dispute_id");
This code snippet now uses gateway instance methods instead of class-level methods. Learn more.

If the dispute is successfully finalized, the result will be successful. Otherwise, check for validation errors.

PHP
Copy
Copied
if ($result->success) {
  # dispute successfully finalized
} else {
    foreach($result->errors->deepAll() AS $error) {
        print_r($error->code . ": " . $error->message . "\n");
    }
}

If the dispute can't be found, you'll receive a Braintree_Exception_NotFound exception.

Arguments
disputeId required, string

The unique dispute identifier. You can only finalize disputes that have a status of OPEN.

Still have questions?

If you can’t find an answer, contact our Support team