Transaction

Transaction: Search

Returns a collection of Transaction response objects.

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

  1. Node
const stream = gateway.transaction.search((search) => {
  search.customerId().is("the_customer_id");
}, (err, response) => {
  response.each((err, transaction) => {
    console.log(transaction.amount);
  });
});
Parameters
amountrange
The amount of the transaction. The amount must be formatted like xx or x.xx.
authorizationExpiredAtrange
The date/time the transaction's authorization expired.
authorizedAtrange
The date/time the transaction was authorized.
billingCompanytext
The company name on the billing address used for the transaction.
billingCountryNametext
The country name on the billing address used for the transaction.
billingExtendedAddresstext
The extended address on the billing address used for the transaction.
billingFirstNametext
The first name on the billing address used for the transaction.
billingLastNametext
The last name on the billing address used for the transaction.
billingLocalitytext
The locality (e.g. city) on the billing address used for the transaction.
billingPostalCodetext
The postal code on the billing address used for the transaction.
billingRegiontext
The region (e.g. state) on the billing address used for the transaction.
billingStreetAddresstext
The street address on the billing address used for the transaction.
createdAtrange
The date/time at which the transaction was created.
createdUsingmultiple

The data used to create the transaction. Possible values:

  • braintree.Transaction.CreatedUsing.Token
  • braintree.Transaction.CreatedUsing.FullInformation
creditCardCardTypemultiple

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

  • "American Express"
  • "Discover"
  • "Maestro"
  • "JCB"
  • "MasterCard"
  • "UnionPay"
  • "Visa"
creditCardCardholderNametext
The cardholder name in the transaction. This only applies to credit card transactions.
creditCardCustomerLocationmultiple

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

  • international
  • us
creditCardExpirationDatetext
The expiration date of the card used in the transaction. This only applies to credit card transactions.
creditCardNumbertext

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.

creditCardUniqueIdentifiertext

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

currencytext
The currency of the transaction.
customerCompanytext
The customer's company associated with the transaction.
customerEmailtext
The customer's email address associated with the transaction.
customerFaxtext
The customer's fax number associated with the transaction.
customerFirstNametext
The customer's first name associated with the transaction.
customerIdtext
A string value representing an existing customer in your Vault that is associated with the transaction.
customerLastNametext
The customer's last name associated with the transaction.
customerPhonetext
The customer's phone number associated with the transaction.
customerWebsitetext
The customer's website associated with the transaction.
debitNetworkmultiple
The debit network to search for.
disbursementDaterange

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.

disputeDaterange

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

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

failedAtrange
The date/time the transaction failed.
gatewayRejectedAtrange
The date/time the transaction was rejected by the gateway.
idtext
The ID of the transaction.
idsmultiple
The list of transaction IDs to search for.
merchantAccountIdmultiple

The merchant account IDs associated with transactions.

merchantAccountIdFragment

A fragment of the merchant account ID to search for.

containstext
A part of the merchant account ID to search for.
endsWithtext
A postfix for the merchant account ID to search for.
istext
An exact merchant account ID to search for.
isNottext
A merchant account ID to be excluded from the search.
startsWithtext
A prefix for the merchant account ID to search for.
orderIdtext
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.
paymentMethodTokentext
The payment method token used in the transaction.
paypalAuthorizationIdtext
The Authorization ID for a PayPal transaction.
paypalPayerEmailtext
The PayPal account holder's email for a PayPal transaction.
paypalPaymentIdtext
The identification value of the payment in PayPal's API for a PayPal transaction.
processorAuthorizationCodetext
The authorization code returned by the processor for the transaction.
processorDeclinedAtrange
The date/time the transaction was declined by the processor
refundmultiple

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.

settledAtrange
The date/time the transaction finished settling.
settlementBatchIdtext
ID of the batch the transaction was submitted for settlement under.
shippingCompanytext
The company name on the shipping address used for the transaction.
shippingCountryNametext
The country name on the shipping address used for the transaction.
shippingExtendedAddresstext
The extended address on the shipping address used for the transaction.
shippingFirstNametext
The first name on the shipping address used for the transaction.
shippingLastNametext
The last name on the shipping address used for the transaction.
shippingLocalitytext
The locality (e.g. city) on the shipping address used for the transaction.
shippingPostalCodetext
The postal code on the shipping address used for the transaction.
shippingRegiontext
The region (e.g. state) on the shipping address used for the transaction.
shippingStreetAddresstext
The street address on the shipping address used for the transaction.
sourcemultiple

How a transaction was created. Possible values:

  • Api
  • ControlPanel
  • Recurring
  • OAuth application client ID of the transaction facilitator
statusmultiple

The list of statuses to search for. Possible statuses:

  • Authorizing
  • Authorized
  • AuthorizationExpired
  • SubmittedForSettlement
  • Settling
  • SettlementPending
  • SettlementDeclined
  • Settled
  • Voided
  • ProcessorDeclined
  • GatewayRejected
  • Failed
submittedForSettlementAtrange
The date/time the transaction was submitted for settlement.
typemultiple

Possible values:

  • Sale
  • Credit
usermultiple
A list of user IDs used to create the transaction. Specifically refers to Control Panel users and/or API users.
voidedAtrange
The date/time the transaction was voided.

Examplesanchor

Credit cardanchor

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

Searching On Customer Detailsanchor

  1. Node
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:

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

Billing addressanchor

  1. Node
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 addressanchor

  1. Node
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 attributesanchor

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

Vault associationsanchor

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

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

How the transaction was createdanchor

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

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

Or transactions that were created using full credit card information.

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

Those are the only two choices for created_using.

Customer locationanchor

Customers in the US.

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

Or international customers.

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

Merchant accountanchor

A specific one.

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

Or any of several.

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

Credit card typeanchor

A specific one.

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

Or any of several.

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

Transaction statusanchor

Another one or many search field.

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

Transaction sourceanchor

API, Control Panel, or Recurring Billing.

  1. Node
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 typeanchor

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

  1. Node
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.

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

If you only want the refunds:

  1. Node
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:

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

Amountanchor

It's a range field .

  1. Node
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 changesanchor

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:

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

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

const stream = gateway.transaction.search((search) => {
  search.settledAt().min(yesterday);
});
  1. Node
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 rangeanchor

  1. Node
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