Dispute

Dispute: Search

Returns a collection of Dispute response objects.

availability

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

For operators available on search fields, see the search fields page.

  1. Node
gateway.dispute.search((search) => {
  search.id().is("dispute_id");
}, (err, response) => {
  response.forEach((dispute) => {
    console.log(dispute.id);
  });
});
Parameters
amountDisputedrange
The decimal value representing the disputed amount.
amountWonrange
The decimal value representing the reserved amount.
caseNumbertext
The case number of the dispute.
chargebackProtectionLevelmultiple

The chargeback protection level of the dispute. Possible values:

  • EFFORTLESS
  • STANDARD
  • NOT_PROTECTED
customerIdtext
The unique customer identifier associated with the disputed transaction.
disbursementDaterange
The disbursement date of the dispute history event.
effectiveDaterange
The effective date of the dispute history event.
idtext
The unique dispute identifier.
kindmultiple
The kind of dispute.
merchantAccountIdmultiple
The ID of the merchant account this dispute is for.
merchantAccountIdFragment

A fragment of the merchant account ID to search for.

containstext
A part of the merchant account ID to search for.
endsWithtext
A postfix for the merchant account ID to search for.
istext
An exact merchant account ID to search for.
isNottext
A merchant account ID to be excluded from the search.
startsWithtext
A prefix for the merchant account ID to search for.
preDisputeProgrammultiple

The pre-dispute program of the dispute. Possible values:

  • VISA_RDR
  • NONE
reasonmultiple

The reason for the dispute. See reasons on the dispute response object for possible values.

reasonCodemultiple
The raw reason code provided by the processor (e.g. 83).
receivedDaterange
The date the dispute was received by the merchant.
referenceNumbertext
The reference number of the dispute.
replyByDaterange
The merchant Reply By date that is referenced in the gateway.
statusmultiple

The status of the dispute. Possible values:

  • ACCEPTED
  • AUTO_ACCEPTED
  • DISPUTED
  • EXPIRED
  • OPEN
  • LOST
  • WON

See dispute statuses for more details.

transactionIdtext
The unique identifier for the disputed transaction.
transactionSourcemultiple

How a transaction was created. Possible values:

  • API
  • CONTROL_PANEL
  • RECURRING
  • OAuth application client ID of the transaction facilitator

Examplesanchor

Multiple kindsanchor

This example shows searches on the kind parameter:

  1. Node
gateway.dispute.search((search) => {
  search.kind().in([
    braintree.Dispute.Kind.Chargeback,
    braintree.Dispute.Kind.Retrieval
  ]);
}, (err, response) => {
});

Amount disputed rangeanchor

This example shows searches on the amountDisputed parameter:

  1. Node
gateway.dispute.search((search) => {
  search.amountDisputed().between("100.00", "200.00");
}, (err, response) => {
});