Search

Transaction: Search

Note Results are limited according to the PayPal Data Protection Addendum For Card Processing Products policy.

Returns a collection of Transaction response objects.

For operators available on search fields, see the search fields page.

Python

collection = gateway.transaction.search(
    braintree.TransactionSearch.customer_id == "the_customer_id"
)

for transaction in collection.items:
    print transaction.amount

;

Parameters

'amount'range

The amount of the transaction. The amount must be formatted like xx or x.xx.

'authorization_expired_at'range

The date/time the transaction's authorization expired.

'authorized_at'range

The date/time the transaction was authorized.

'billing_company'text

The company name on the billing address used for the transaction.

'billing_country_name'text

The country name on the billing address used for the transaction.

'billing_extended_address'text

The extended address on the billing address used for the transaction.

'billing_first_name'text

The first name on the billing address used for the transaction.

'billing_last_name'text

The last name on the billing address used for the transaction.

'billing_locality'text

The locality (e.g. city) on the billing address used for the transaction.

'billing_postal_code'text

The postal code on the billing address used for the transaction.

'billing_region'text

The region (e.g. state) on the billing address used for the transaction.

'billing_street_address'text

The street address on the billing address used for the transaction.

'created_at'range

The date/time at which the transaction was created.

'created_using'multiple

The data used to create the transaction. Possible values:

braintree.Transaction.CreatedUsing.Token
braintree.Transaction.CreatedUsing.FullInformation

'credit_card_card_type'multiple

The type of credit card used in the transaction. Possible values:

"American Express"
"Discover"
"Maestro"
"JCB"
"MasterCard"
"UnionPay"
"Visa"

'credit_card_cardholder_name'text

The cardholder name in the transaction. This only applies to credit card transactions.

'credit_card_customer_location'multiple

The location of the customer in the transaction. Possible values:

international
us

'credit_card_expiration_date'text

The expiration date of the card used in the transaction. This only applies to credit card transactions.

'credit_card_number'text

The number of the card used in the transaction.

Card number search is restricted: starts with searches up to the first 6 digits, ends with searches last 4 digits, and contains is not allowed.

'credit_card_unique_identifier'text

The unique identifier of the card number. See the transaction response reference for more details.

'currency'text

The currency of the transaction.

'customer_company'text

The customer's company associated with the transaction.

'customer_email'text

The customer's email address associated with the transaction.

'customer_fax'text

The customer's fax number associated with the transaction.

'customer_first_name'text

The customer's first name associated with the transaction.

'customer_id'text

A string value representing an existing customer in your Vault that is associated with the transaction.

'customer_last_name'text

The customer's last name associated with the transaction.

'customer_phone'text

The customer's phone number associated with the transaction.

'customer_website'text

The customer's website associated with the transaction.

'debit_network'multiple

The debit network to search for.

'disbursement_date'range

Only available for certain account types; contact us for details.

The date the transaction was disbursed to your bank account. This field does not include a time value.

'dispute_date'range

Only available for certain account types; contact us for details.

The date the transaction was disputed. This field does not include a time value.

'failed_at'range

The date/time the transaction failed.

'gateway_rejected_at'range

The date/time the transaction was rejected by the gateway.

'id'text

The ID of the transaction.

'ids'multiple

The list of transaction IDs to search for.

'merchant_account_id'multiple

The merchant account IDs associated with transactions.

'merchant_account_id_fragment'

A fragment of the merchant account ID to search for.

'contains'text

A part of the merchant account ID to search for.

'ends_with'text

A postfix for the merchant account ID to search for.

'is'text

An exact merchant account ID to search for.

'is_not'text

A merchant account ID to be excluded from the search.

'starts_with'text

A prefix for the merchant account ID to search for.

'order_id'text

The order ID of the transaction. On PayPal transactions, this field maps to the PayPal invoice number. PayPal invoice numbers are unique in your PayPal business account. Maximum 255 characters or 127 for PayPal transactions.

'payment_instrument_type'multiple

'payment_method_token'text

The payment method token used in the transaction.

'paypal_authorization_id'text

The Authorization ID for a PayPal transaction.

'paypal_payer_email'text

The PayPal account holder's email for a PayPal transaction.

'paypal_payment_id'text

The identification value of the payment in PayPal's API for a PayPal transaction.

'processor_authorization_code'text

The authorization code returned by the processor for the transaction.

'processor_declined_at'range

The date/time the transaction was declined by the processor

'refund'multiple

Whether or not the transaction is a refund. The value may be either True or False. This parameter must be used in conjunction with type.

'settled_at'range

The date/time the transaction finished settling.

'settlement_batch_id'text

ID of the batch the transaction was submitted for settlement under.

'shipping_company'text

The company name on the shipping address used for the transaction.

'shipping_country_name'text

The country name on the shipping address used for the transaction.

'shipping_extended_address'text

The extended address on the shipping address used for the transaction.

'shipping_first_name'text

The first name on the shipping address used for the transaction.

'shipping_last_name'text

The last name on the shipping address used for the transaction.

'shipping_locality'text

The locality (e.g. city) on the shipping address used for the transaction.

'shipping_postal_code'text

The postal code on the shipping address used for the transaction.

'shipping_region'text

The region (e.g. state) on the shipping address used for the transaction.

'shipping_street_address'text

The street address on the shipping address used for the transaction.

'source'multiple

How a transaction was created. Possible values:

Api
ControlPanel
Recurring

OAuth application client ID of the transaction facilitator

'status'multiple

The list of statuses to search for. Possible statuses:

Authorizing
Authorized
AuthorizationExpired
SubmittedForSettlement
Settling
SettlementPending
SettlementDeclined
Settled
Voided
ProcessorDeclined
GatewayRejected
Failed

'submitted_for_settlement_at'range

The date/time the transaction was submitted for settlement.

'type'multiple

Possible values:

Sale
Credit

'user'multiple

A list of user IDs used to create the transaction. Specifically refers to Control Panel users and/or API users.

'voided_at'range

The date/time the transaction was voided.

;

Examples

Credit card

Python

search_results = gateway.transaction.search(
    braintree.TransactionSearch.credit_card_cardholder_name == "Patrick Smith",
    braintree.TransactionSearch.credit_card_expiration_date == "05/2012",
    braintree.TransactionSearch.credit_card_number.ends_with("1111")
)

Searching On Customer Details

Python

search_results = gateway.transaction.search(
    braintree.TransactionSearch.customer_company == "Braintree",
    braintree.TransactionSearch.customer_email == "smith@example.com",
    braintree.TransactionSearch.customer_fax == "5551231234",
    braintree.TransactionSearch.customer_first_name == "Tom",
    braintree.TransactionSearch.customer_last_name == "Smith",
    braintree.TransactionSearch.customer_phone == "5551231234",
    braintree.TransactionSearch.customer_website == "http://example.com"
)

See search fields for a list of available operators. They allow you to do nice things like this:

Python

search_results = gateway.transaction.search(
    braintree.TransactionSearch.customer_email.ends_with("example.com")
)

Billing address

Python

search_results = gateway.transaction.search(
    braintree.TransactionSearch.billing_first_name == "Paul",
    braintree.TransactionSearch.billing_last_name == "Smith",
    braintree.TransactionSearch.billing_company == "Braintree",
    braintree.TransactionSearch.billing_street_address == "123 Main St",
    braintree.TransactionSearch.billing_extended_address == "Suite 123",
    braintree.TransactionSearch.billing_locality == "Chicago",
    braintree.TransactionSearch.billing_region == "IL",
    braintree.TransactionSearch.billing_postal_code == "12345",
    braintree.TransactionSearch.billing_country_name == "United States of America"
)

Shipping address

Python

search_results = gateway.transaction.search(
    braintree.TransactionSearch.shipping_first_name == "Paul",
    braintree.TransactionSearch.shipping_last_name == "Smith",
    braintree.TransactionSearch.shipping_company == "Braintree",
    braintree.TransactionSearch.shipping_street_address == "123 Main St",
    braintree.TransactionSearch.shipping_extended_address == "Suite 123",
    braintree.TransactionSearch.shipping_locality == "Chicago",
    braintree.TransactionSearch.shipping_region == "IL",
    braintree.TransactionSearch.shipping_postal_code == "12345",
    braintree.TransactionSearch.shipping_country_name == "United States of America"
)

Other top-level attributes

Python

search_results = gateway.transaction.search(
    braintree.TransactionSearch.order_id == "myorder",
    braintree.TransactionSearch.processor_authorization_code == "123456"
)

Vault associations

You can search for transactions associated to a payment method token.

Python

search_results = gateway.transaction.search(
    braintree.TransactionSearch.payment_method_token == "the_token"
)

How the transaction was created

You can search for transactions that were created using a token.

Python

search_results = gateway.transaction.search(
    braintree.TransactionSearch.created_using == braintree.Transaction.CreatedUsing.Token
)

Or transactions that were created using full credit card information.

Python

search_results = gateway.transaction.search(
    braintree.TransactionSearch.created_using == braintree.Transaction.CreatedUsing.FullInformation
)

Those are the only two choices for created_using.

Customer location

Customers in the US.

Python

search_results = gateway.transaction.search(
    braintree.TransactionSearch.credit_card_customer_location == braintree.CreditCard.CustomerLocation.US
)

Or international customers.

Python

search_results = gateway.transaction.search(
    braintree.TransactionSearch.credit_card_customer_location == braintree.CreditCard.CustomerLocation.International
)

Merchant account

A specific one.

Python

search_results = gateway.transaction.search(
    braintree.TransactionSearch.merchant_account_id == "the_merchant_account_id"
)

Or any of several.

Python

search_results = gateway.transaction.search(
    braintree.TransactionSearch.merchant_account_id.in_list("account_1", "account_2")
)

Credit card type

A specific one.

Python

search_results = gateway.transaction.search(
    braintree.TransactionSearch.credit_card_card_type == braintree.CreditCard.CardType.Visa
)

Or any of several.

Python

search_results = gateway.transaction.search(
    braintree.TransactionSearch.credit_card_card_type == braintree.CreditCard.CardType.Visa
)
search_results = gateway.transaction.search(
    braintree.TransactionSearch.credit_card_card_type.in_list(
        braintree.CreditCard.CardType.Visa,
        braintree.CreditCard.CardType.MasterCard,
        braintree.CreditCard.CardType.Discover
    )
)

Transaction status

Another one or many search field.

Python

search_results = gateway.transaction.search(
    braintree.TransactionSearch.status == braintree.Transaction.Status.ProcessorDeclined
)
search_results = gateway.transaction.search(
    braintree.TransactionSearch.status.in_list(
        braintree.Transaction.Status.ProcessorDeclined,
        braintree.Transaction.Status.GatewayRejected
    )
)

Transaction source

API, Control Panel, or Recurring Billing.

Python

search_results = gateway.transaction.search(
    braintree.TransactionSearch.source == braintree.Transaction.Source.Api
)
search_results = gateway.transaction.search(
    braintree.TransactionSearch.source.in_list(
        braintree.Transaction.Source.Api,
        braintree.Transaction.Source.ControlPanel,
        braintree.Transaction.Source.Recurring
    )
)

Transaction type

The two types of transactions are sale and credit. Refunds are a special kind of credit, so there are some extra options around them.

Python

search_results = gateway.transaction.search(
    braintree.TransactionSearch.type == braintree.Transaction.Type.Sale
)

This will return all credits, regardless of whether they're refunds, or standalone credits.

Python

search_results = gateway.transaction.search(
    braintree.TransactionSearch.type == braintree.Transaction.Type.Credit
)

If you only want the refunds:

Python

search_results = gateway.transaction.search(
    braintree.TransactionSearch.type == braintree.Transaction.Type.Credit,
    braintree.TransactionSearch.refund == True
)

And if you only want the credits that aren't refunds:

Python

search_results = gateway.transaction.search(
    braintree.TransactionSearch.type == braintree.Transaction.Type.Credit,
    braintree.TransactionSearch.refund == False
)

Amount

It's a range field .

Python

search_results = gateway.transaction.search(
    braintree.TransactionSearch.amount.between("100.00", "200.00")
)
search_results = gateway.transaction.search(
    braintree.TransactionSearch.amount >= "100.00"
)
search_results = gateway.transaction.search(
    braintree.TransactionSearch.amount <= "100.00"
)

Status changes

You can search for transactions that entered a given status at a certain date and time. For instance, you can find all transactions which were submitted for settlement in the past 3 days. You can search on these statuses:

created_at
authorized_at
submitted_for_settlement_at
settled_at
voided_at
processor_declined_at
gateway_rejected_at
failed_at
authorization_expired_at

A few examples:

Python

search_results = gateway.transaction.search(
    braintree.TransactionSearch.created_at.between(
        datetime.datetime(2009, 1, 1), 
        datetime.datetime(2011, 1, 1)
    )
)

Python

search_results = gateway.transaction.search(
    braintree.TransactionSearch.settled_at >= datetime.datetime(2009, 1, 1)
)

Python

search_results = gateway.transaction.search(
    braintree.TransactionSearch.processor_declined_at >= datetime.datetime(2009, 1, 1)
)

Dispute date range

Python

search_results = gateway.transaction.search(
    braintree.TransactionSearch.dispute_date >= datetime.datetime(2009, 1, 1)
)

## Searching prior to version Prior to version , literal lists must be passed as arguments to all search methods.

Python

search_results = gateway.transaction.search([
    braintree.TransactionSearch.merchant_account_id.in_list([
        "account_1",
        "account_2"
    ])
])

Note Time zones specified in the time value will be respected in the search; if you do not specify a time zone, the search will default to the time zone associated with your gateway account. Results will always be returned with time values in UTC.

Transaction: Search

Parameters

Examples

Credit card

Searching On Customer Details

Billing address

Shipping address

Other top-level attributes

Vault associations

How the transaction was created

Customer location

Merchant account

Credit card type

Transaction status

Transaction source

Transaction type

Amount

Status changes

Dispute date range

See Also

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more