Returns a collection of Transaction response objects.

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

Node.js 
const stream = gateway.transaction.search((search) => {
  search.customerId().is("the_customer_id");
}, (err, response) => {
  response.each((err, transaction) => {
    console.log(transaction.amount);
  });
});
Parameters
amount range

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

The date/time the transaction's authorization expired.
authorizedAt range

The date/time the transaction was authorized.
billingCompany text

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

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

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

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

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

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

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

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

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

The date/time at which the transaction was created.
createdUsing multiple

The data used to create the transaction. Possible values:

  • braintree.Transaction.CreatedUsing.Token
  • braintree.Transaction.CreatedUsing.FullInformation
creditCardCardType multiple

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

  • "American Express"
  • "Discover"
  • "Maestro"
  • "JCB"
  • "MasterCard"
  • "UnionPay"
  • "Visa"
creditCardCardholderName text

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

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

  • international
  • us
creditCardExpirationDate text

The expiration date of the card used in the transaction. This only applies to credit card transactions.
creditCardNumber 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.
creditCardUniqueIdentifier text

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

The currency of the transaction.
customerCompany text

The customer's company associated with the transaction.
customerEmail text

The customer's email address associated with the transaction.
customerFax text

The customer's fax number associated with the transaction.
customerFirstName text

The customer's first name associated with the transaction.
customerId text

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

The customer's last name associated with the transaction.
customerPhone text

The customer's phone number associated with the transaction.
customerWebsite text

The customer's website associated with the transaction.
disbursementDate 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.
disputeDate 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.
failedAt range

The date/time the transaction failed.
gatewayRejectedAt 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.
merchantAccountId multiple

The merchant account IDs associated with transactions.
orderId 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.
paymentInstrumentType multiple

The method of payment used to process the transaction. Possible values:

  • "android_pay_card"
  • "apple_pay_card"
  • "credit_card"
  • "masterpass_card"
  • "paypal_account"
  • "samsung_pay_card"
  • "us_bank_account"
  • "venmo_account"
  • "visa_checkout_card"
paymentMethodToken text

The payment method token used in the transaction.
paypalAuthorizationId text

The Authorization ID for a PayPal transaction.
paypalPayerEmail text

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

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

The authorization code returned by the processor for the transaction.
processorDeclinedAt 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.
settledAt range

The date/time the transaction finished settling.
settlementBatchId text

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

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

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

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

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

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

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

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

The region (e.g. state) on the shipping address used for the transaction.
shippingStreetAddress 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
submittedForSettlementAt 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.
voidedAt range

The date/time the transaction was voided.

Examples

Credit card

Node.js 
const stream = gateway.transaction.search((search) => {
  search.creditCardCardholderName().is("Patrick Smith");
  search.creditCardExpirationDate().is("05/2012");
  search.creditCardNumber().endsWith("1111");
});

Searching On Customer Details

Node.js 
const stream = gateway.transaction.search((search) => {
  search.customerCompany().is("Braintree");
  search.customerEmail().is("jen@example.com");
  search.customerPhone().is("312.555.1234");
  search.customerFax().is("614.555.5678");
  search.customerWebsite().is("www.example.com");
});

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

Node.js 
const stream = gateway.transaction.search((search) => {
  search.customerEmail().endsWith("example.com");
});

Billing address

Node.js 
const stream = gateway.transaction.search((search) => {
  search.billingFirstName().is("Paul");
  search.billingLastName().is("Smith");
  search.billingCompany().is("Braintree");
  search.billingStreetAddress().is("123 Main St");
  search.billingExtendedAddress().is("Suite 123");
  search.billingLocality().is("Chicago");
  search.billingRegion().is("Illinois");
  search.billingPostalCode().is("12345");
  search.billingCountryName().is("United States of America");
});

Shipping address

Node.js 
const stream = gateway.transaction.search((search) => {
  search.shippingFirstName().is("Paul");
  search.shippingLastName().is("Smith");
  search.shippingCompany().is("Braintree");
  search.shippingStreetAddress().is("123 Main St");
  search.shippingExtendedAddress().is("Suite 123");
  search.shippingLocality().is("Chicago");
  search.shippingRegion().is("Illinois");
  search.shippingPostalCode().is("12345");
  search.shippingCountryName().is("United States of America");
});

Other top-level attributes

Node.js 
const stream = gateway.transaction.search((search) => {
  search.orderId().is("myorder");
  search.processorAuthorizationCode().is("123456");
});

Vault associations

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

Node.js 
const stream = gateway.transaction.search((search) => {
  search.paymentMethodToken().is("theToken");
});

How the transaction was created

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

Node.js 
const stream = gateway.transaction.search((search) => {
  search.createdUsing().is(braintree.Transaction.CreatedUsing.Token);
});

Or transactions that were created using full credit card information.

Node.js 
const stream = gateway.transaction.search((search) => {
  search.createdUsing().is(braintree.Transaction.CreatedUsing.FullInformation);
});

Those are the only two choices for created_using.

Customer location

Customers in the US.

Node.js 
const stream = gateway.transaction.search((search) => {
  search.creditCardCustomerLocation().is(braintree.CreditCard.CustomerLocation.US);
});

Or international customers.

Node.js 
const stream = gateway.transaction.search((search) => {
  search.creditCardCustomerLocation().is(braintree.CreditCard.CustomerLocation.International);
});

Merchant account

A specific one.

Node.js 
const stream = gateway.transaction.search((search) => {
  search.merchantAccountId().is("the_merchant_account_id");
});

Or any of several.

Node.js 
const stream = gateway.transaction.search((search) => {
  search.merchantAccountId().in("account_1", "account_2");
});

Credit card type

A specific one.

Node.js 
const stream = gateway.transaction.search((search) => {
  search.creditCardCardType().is(braintree.CreditCard.CardType.Visa);
});

Or any of several.

Node.js 
const stream = gateway.transaction.search((search) => {
  search.creditCardCardType().in([
    braintree.CreditCard.CardType.Visa,
    braintree.CreditCard.CardType.MasterCard,
    braintree.CreditCard.CardType.Discover
  ]);
});

Transaction status

Another one or many search field.

Node.js 
const stream = gateway.transaction.search((search) => {
  search.status().is(braintree.Transaction.Status.Authorized);
});

Transaction source

API, Control Panel, or Recurring Billing.

Node.js 
const stream = gateway.transaction.search((search) => {
  search.source().is(braintree.Transaction.Source.Api);
});

const stream = gateway.transaction.search((search) => {
  search.source().in([
    Transaction.Source.Api,
    Transaction.Source.ControlPanel
  ]);
});

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.

Node.js 
const stream = gateway.transaction.search((search) => {
  search.type().is(braintree.Transaction.Type.Sale);
});

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

Node.js 
const stream = gateway.transaction.search((search) => {
  search.type().is(braintree.Transaction.Type.Credit);
});

If you only want the refunds:

Node.js 
const stream = gateway.transaction.search((search) => {
  search.type().is(braintree.Transaction.Type.Credit)
  search.refund().is(true);
});

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

Node.js 
const stream = gateway.transaction.search((search) => {
  search.type().is(braintree.Transaction.Type.Credit)
  search.refund().is(false);
});

Amount

It's a range field.

Node.js 
const stream = gateway.transaction.search((search) => {
  search.amount().between("100.00", "200.00");
});

const stream = gateway.transaction.search((search) => {
  search.amount().min("100.00");
});

const stream = gateway.transaction.search((search) => {
  search.amount().max("200.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:

  • createdAt
  • authorizedAt
  • submittedForSettlementAt
  • settledAt
  • voidedAt
  • processorDeclinedAt
  • gatewayRejectedAt
  • failedAt
  • authorizationExpiredAt

A few examples:

Node.js 
const today = new Date();
const yesterday = new Date();
yesterday.setDate(today.getDate() - 1);

const stream = gateway.transaction.search((search) => {
  search.createdAt().min(yesterday);
});
Node.js 
const today = new Date();
const yesterday = new Date();
yesterday.setDate(today.getDate() - 1);

const stream = gateway.transaction.search((search) => {
  search.settledAt().min(yesterday);
});
Node.js 
const today = new Date();
const yesterday = new Date();
yesterday.setDate(today.getDate() - 1);

const stream = gateway.transaction.search((search) => {
  search.declinedAt().min(yesterday);
});

Dispute date range

Node.js 
const today = new Date();
const yesterday = new Date();
yesterday.setDate(today.getDate() - 1);

const stream = gateway.transaction.search((search) => {
  search.disputeDate().min(yesterday);
});

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.

See also