Server-Side API Requests/
Dispute/
Search

Dispute: Search

Returns a collection of Dispute response objects. For operators available on search fields, see the search fields page.
  1. Ruby
collection = gateway.dispute.search do |search|
  search.id.is "dispute_id"
end

collection.disputes.each do |dispute|
  puts dispute.id
end
;
Parameters
:amount_disputedrange
The decimal value representing the disputed amount.
:amount_wonrange
The decimal value representing the reserved amount.
:case_numbertext
The case number of the dispute.
:chargeback_protection_levelmultiple

The chargeback protection level of the dispute. Possible values:

  • EFFORTLESS
  • STANDARD
  • NOT_PROTECTED
:customer_idtext
The unique customer identifier associated with the disputed transaction.
:disbursement_daterange
The disbursement date of the dispute history event.
:effective_daterange
The effective date of the dispute history event.
:idtext
The unique dispute identifier.
:kindmultiple
The kind of dispute.
:merchant_account_idmultiple
The ID of the merchant account this dispute is for.
:merchant_account_id_fragment

A fragment of the merchant account ID to search for.

:containstext
A part of the merchant account ID to search for.
:ends_withtext
A postfix for the merchant account ID to search for.
:istext
An exact merchant account ID to search for.
:is_nottext
A merchant account ID to be excluded from the search.
:starts_withtext
A prefix for the merchant account ID to search for.
:pre_dispute_programmultiple

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.

:reason_codemultiple
The raw reason code provided by the processor (e.g. 83).
:received_daterange
The date the dispute was received by the merchant.
:reference_numbertext
The reference number of the dispute.
:reply_by_daterange
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.

:transaction_idtext
The unique identifier for the disputed transaction.
:transaction_sourcemultiple

How a transaction was created. Possible values:

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

ExamplesAnchorIcon

Multiple kindsAnchorIcon

This example shows searches on the kind parameter:
  1. Ruby
search_results = gateway.dispute.search do |search|
    search.kind.in(
        Braintree::Dispute::Kind::Chargeback,
        Braintree::Dispute::Kind::Retrieval
    )
end

Amount disputed rangeAnchorIcon

This example shows searches on the amount_disputed parameter:
  1. Ruby
search_results = gateway.dispute.search do |search|
    search.amount_disputed.between "100.00", "200.00"
end