Searching

Search Fieldsanchor

We support three types of search fields:

  • Text fields
  • Multiple value fields
  • Range fields

Learn more about working with search results.

Text fieldsanchor

Text Fields can be searched using 5 operators: is, is_not, starts_with, ends_with, and contains. Each search Text Field can't exceed 255 characters. Here is an example searching for customer email on a transaction.

  1. Ruby
search_results = gateway.transaction.search do |search|
  search.customer_email.is "john.smith@example.com"
end

search_results = gateway.transaction.search do |search|
  search.customer_email.is_not "john.smith@example.com"
end

search_results = gateway.transaction.search do |search|
  search.customer_email.starts_with "john.smith"
end

search_results = gateway.transaction.search do |search|
  search.customer_email.ends_with "example.com"
end

search_results = gateway.transaction.search do |search|
  search.customer_email.contains "smith"
end

Multiple value fieldsanchor

Search fields that accept multiple values support two operators: is and in.

  1. Ruby
search_results = gateway.transaction.search do |search|
  search.status.is Braintree::Transaction::Status::Authorized
end

search_results = gateway.transaction.search do |search|
  search.status.in(
    Braintree::Transaction::Status::Authorized,
    Braintree::Transaction::Status::SubmittedForSettlement
  )
end

Range fieldsanchor

Ranges support four operators: is, between, >=, and <=. between is inclusive.

  1. Ruby
search_results = gateway.transaction.search do |search|
  search.amount.is("15.00")
end

search_results = gateway.transaction.search do |search|
  search.amount >= "10.00"
end

search_results = gateway.transaction.search do |search|
  search.amount <= "20.00"
end

search_results = gateway.transaction.search do |search|
  search.amount.between("10.00", "20.00")
end

search_results = gateway.transaction.search do |search|
  search.created_at.between("12/17/2015 17:00", "12/17/2015 17:00")
end
note

Ranges with a date/time value are precise to the minute; the results of search for transactions created between 12/17/2015 17:00 and 12/17/2015 17:00 will include a transaction created at 12/17/2015 17:00:59.