NAME

WebService::Braintree::TransactionSearch

PURPOSE

This class represents a search for transactions.

This class should never be instantiated directly. Instead, you will access objects of this class through the search interface.

FIELDS

amount

This is a range field. It will restrict the search to subscriptions created between the two values.

authorization_expired_at

This is a range field. It will restrict the search to subscriptions created between the two values.

authorized_at

This is a range field. It will restrict the search to subscriptions created between the two values.

billing_company

This is a text field. It will restrict the search to transactions matching a specific billing company.

billing_country_name

This is a text field. It will restrict the search to transactions matching a specific billing country name.

billing_extended_address

This is a text field. It will restrict the search to transactions matching a specific billing extended address.

billing_first_name

This is a text field. It will restrict the search to transactions matching a specific billing first name.

billing_last_name

This is a text field. It will restrict the search to transactions matching a specific billing last name.

billing_locality

This is a text field. It will restrict the search to transactions matching a specific billing locality.

billing_postal_code

This is a text field. It will restrict the search to transactions matching a specific billing postal code.

billing_region

This is a text field. It will restrict the search to transactions matching a specific billing region.

billing_street_address

This is a text field. It will restrict the search to transactions matching a specific billing street address.

created_at

This is a range field. It will restrict the search to subscriptions created between the two values.

created_using

This is a multiple-values field. It will restrict the search to a list of specific values regarding how this transaction was created.

This list is restricted to the values defined by "All" in WebService::Braintree::Transaction::CreatedUsing

credit_card_cardholder_name

This is a text field. It will restrict the search to transactions matching a specific credit card cardholder name.

credit_card_customer_location

This is a multiple-values field. It will restrict the search to a list of specific location types.

This list is restricted to the values defined by "All" in WebService::Braintree::CreditCard::Location

credit_card_expiration_date

This is an equality field. It will restrict the search to transactions with credit cards with a specific expiration date.

credit_card_number

This is a partial-match field. It will restrict the search to transactions with credit cards containing a specific card number.

credit_card_card_type

This is a multiple-values field. It will restrict the search to a list of specific credit card card-types.

This list is restricted to the values defined by "All" in WebService::Braintree::CreditCard::CardType

currency

This is a text field. It will restrict the search to transactions matching a specific currency.

customer_company

This is a text field. It will restrict the search to transactions matching a specific customer company.

customer_email

This is a text field. It will restrict the search to transactions matching a specific customer email.

customer_fax

This is a text field. It will restrict the search to transactions matching a specific customer fax.

customer_first_name

This is a text field. It will restrict the search to transactions matching a specific customer first name.

customer_id

This is a text field. It will restrict the search to transactions matching a specific customer ID.

customer_last_name

This is a text field. It will restrict the search to transactions matching a specific customer last name.

customer_phone

This is a text field. It will restrict the search to transactions matching a specific customer phone number.

customer_website

This is a text field. It will restrict the search to transactions matching a specific customer website.

failed_at

This is a range field. It will restrict the search to subscriptions created between the two values.

gateway_rejected_at

This is a range field. It will restrict the search to subscriptions created between the two values.

id

This is a text field. It will restrict the search to transactions matching a specific ID.

ids

This is a multiple-values field. It will restrict the search to a list of specific ids.

merchant_account_id

This is a multiple-values field. It will restrict the search to a list of specific merchant account IDs.

order_id

This is a text field. It will restrict the search to transactions matching a specific order ID.

payment_method_token

This is a text field. It will restrict the search to transactions matching a specific payment method token.

paypal_payment_id

This is a text field. It will restrict the search to transactions matching a specific PayPal payment ID.

paypal_authorization_id

This is a text field. It will restrict the search to transactions matching a specific PayPal authorization ID.

paypal_payer_email

This is a text field. It will restrict the search to transactions matching a specific PayPal payer email.

processor_authorization_code

This is a text field. It will restrict the search to transactions matching a specific processor authorization code.

processor_declined_at

This is a range field. It will restrict the search to subscriptions created between the two values.

refund

This is a key-value field. It will restrict the search to transactions that match the specified value.

settled_at

This is a range field. It will restrict the search to subscriptions created between the two values.

settlement_batch_id

This is a text field. It will restrict the search to transactions matching a specific settlement batch ID.

shipping_company

This is a text field. It will restrict the search to transactions matching a specific shipping company.

shipping_country_name

This is a text field. It will restrict the search to transactions matching a specific shipping address country name.

shipping_extended_address

This is a text field. It will restrict the search to transactions matching a specific shipping address extended address.

shipping_first_name

This is a text field. It will restrict the search to transactions matching a specific shipping address first name.

shipping_last_name

This is a text field. It will restrict the search to transactions matching a specific shipping address last name.

shipping_locality

This is a text field. It will restrict the search to transactions matching a specific shipping address locality.

shipping_postal_code

This is a text field. It will restrict the search to transactions matching a specific shipping address postal code.

shipping_region

This is a text field. It will restrict the search to transactions matching a specific shipping address region.

shipping_street_address

This is a text field. It will restrict the search to transactions matching a specific shipping address street address.

source

This is a multiple-values field. It will restrict the search to a list of specific transaction sources.

This list is restricted to the values defined by "All" in WebService::Braintree::Transaction::Source

status

This is a multiple-values field. It will restrict the search to a list of specific transaction statuses.

This list is restricted to the values defined by "All" in WebService::Braintree::Transaction::Status

submitted_for_settlement_at

This is a range field. It will restrict the search to subscriptions created between the two values.

ids

This is a multiple-values field. It will restrict the search to a list of specific transaction types.

This list is restricted to the values defined by "All" in WebService::Braintree::Transaction::Type

voided_at

This is a range field. It will restrict the search to subscriptions created between the two values.