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.

Java

DisputeSearchRequest request = new DisputeSearchRequest()
    .id()
    .is("dispute_id");

ResourceCollection<dispute> collection = gateway.dispute().search(request);
for (Dispute dispute : collection) {
    System.out.println(dispute.getId());
}

Parameters

.amountDisputed(…)range

The decimal value representing the disputed amount.

.amountWon(…)range

The decimal value representing the reserved amount.

.caseNumber(…)text

The case number of the dispute.

.chargebackProtectionLevel(…)multiple

The chargeback protection level of the dispute. Possible values:

EFFORTLESS
STANDARD
NOT_PROTECTED

.customerId(…)text

The unique customer identifier associated with the disputed transaction.

.disbursementDate(…)range

The disbursement date of the dispute history event.

.effectiveDate(…)range

The effective date of the dispute history event.

.id(…)text

The unique dispute identifier.

.kind(…)multiple

The kind of dispute.

.merchantAccountId(…)multiple

The ID of the merchant account this dispute is for.

.merchantAccountIdFragment(…)

A fragment of the merchant account ID to search for.

.contains(…)text

A part of the merchant account ID to search for.

.endsWith(…)text

A postfix for the merchant account ID to search for.

.is(…)text

An exact merchant account ID to search for.

.isNot(…)text

A merchant account ID to be excluded from the search.

.startsWith(…)text

A prefix for the merchant account ID to search for.

.preDisputeProgram(…)multiple

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

VISA_RDR
NONE

.reason(…)multiple

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

.reasonCode(…)multiple

The raw reason code provided by the processor (e.g. 83).

.receivedDate(…)range

The date the dispute was received by the merchant.

.referenceNumber(…)text

The reference number of the dispute.

.replyByDate(…)range

The merchant Reply By date that is referenced in the gateway.

.status(…)multiple

The status of the dispute. Possible values:

ACCEPTED
AUTO_ACCEPTED
DISPUTED
EXPIRED
OPEN
LOST
WON

See dispute statuses for more details.

.transactionId(…)text

The unique identifier for the disputed transaction.

.transactionSource(…)multiple

How a transaction was created. Possible values:

API
CONTROL_PANEL
RECURRING
OAuth application client ID of the transaction facilitator

Examples

Multiple kinds

This example shows searches on the kind parameter:

Java

DisputeSearchRequest searchRequest = new DisputeSearchRequest()
    .kind()
    .in(Dispute.Kind.CHARGEBACK, Dispute.Kind.RETRIEVAL);

Amount disputed range

This example shows searches on the amountDisputed parameter:

Java

DisputeSearchRequest searchRequest = new DisputeSearchRequest()
    .amountDisputed()
    .between(new BigDecimal("100.00"), new BigDecimal("200.00"));