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.

var request = new DisputeSearchRequest().Id.Is("dispute_id");
ResourceCollection<Dispute> collection = gateway.Dispute.Search(request);
foreach (Dispute dispute in collection) {
    Console.WriteLine(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

Examples

Multiple kinds

This example shows searches on the Kind parameter:

var searchRequest = new DisputeSearchRequest().Kind.IncludedIn(DisputeKind.CHARGEBACK, DisputeKind.RETRIEVAL);

Amount disputed range

This example shows searches on the AmountDisputed parameter:

var searchRequest = new DisputeSearchRequest().AmountDisputed.Between(100.00M, 200.00M);