Returns a collection of Transaction response objects.
For operators available on search fields, see the search fields page.
TransactionSearchRequest request = new TransactionSearchRequest()
.customerId().is("the_customer_id");
ResourceCollection<Transaction> collection = gateway.transaction().search(request);
for (Transaction transaction : collection) {
System.out.println(transaction.getAmount());
}
Parameters
.billingExtendedAddress(…)
text
The extended address on the billing address used for the transaction.
.createdUsing(…)
multiple
The data used to create the transaction. Possible values:
Transaction.CreatedUsing.TOKEN
Transaction.CreatedUsing.FULL_INFORMATION
.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.
.customerId(…)
text
A string value representing an existing customer in your Vault that is 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.
.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"
.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.
.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().
.shippingExtendedAddress(…)
text
The extended address on the shipping address used for the transaction.
.shippingLocality(…)
text
The locality (e.g. city) on the shipping address used for the transaction.
.source(…)
multiple
How a transaction was created. Possible values:
API
CONTROL_PANEL
RECURRING
- OAuth application client ID of the transaction facilitator
.status(…)
multiple
The list of statuses to search for. Possible statuses:
AUTHORIZING
AUTHORIZED
AUTHORIZATION_EXPIRED
SUBMITTED_FOR_SETTLEMENT
SETTLING
SETTLEMENT_PENDING
SETTLEMENT_DECLINED
SETTLED
VOIDED
PROCESSOR_DECLINED
GATEWAY_REJECTED
FAILED
Examples
Credit card
TransactionSearchRequest request = new TransactionSearchRequest()
.creditCardCardholderName().is("Patrick Smith")
.creditCardExpirationDate().is("05/2012")
.creditCardNumber().endsWith("1111");
ResourceCollection<Transaction> collection = gateway.transaction().search(request);
Searching On Customer Details
TransactionSearchRequest request = new TransactionSearchRequest()
.customerCompany().is("Braintree")
.customerEmail().is("smith@example.com")
.customerFax().is("5551231234")
.customerFirstName().is("Tom")
.customerLastName().is("Smith")
.customerPhone().is("5551231234")
.customerWebsite().is("http://example.com");
ResourceCollection<Transaction> collection = gateway.transaction().search(request);
See search fields for a list of available operators. They allow you to do nice things like this:
TransactionSearchRequest request = new TransactionSearchRequest()
.customerEmail().endsWith("example.com");
ResourceCollection<Transaction> collection = gateway.transaction().search(request);
Billing address
TransactionSearchRequest request = new TransactionSearchRequest()
.billingFirstName().is("Paul")
.billingLastName().is("Smith")
.billingCompany().is("Braintree")
.billingStreetAddress().is("123 Main St")
.billingExtendedAddress().is("Suite 123")
.billingLocality().is("Chicago")
.billingRegion().is("Illinois")
.billingPostalCode().is("12345")
.billingCountryName().is("United States of America");
ResourceCollection<Transaction> collection = gateway.transaction().search(request);
Shipping address
TransactionSearchRequest request = new TransactionSearchRequest()
.shippingFirstName().is("Paul")
.shippingLastName().is("Smith")
.shippingCompany().is("Braintree")
.shippingStreetAddress().is("123 Main St")
.shippingExtendedAddress().is("Suite 123")
.shippingLocality().is("Chicago")
.shippingRegion().is("Illinois")
.shippingPostalCode().is("12345")
.shippingCountryName().is("United States of America");
ResourceCollection<Transaction> collection = gateway.transaction().search(request);
Other top-level attributes
TransactionSearchRequest request = new TransactionSearchRequest()
.orderId().is("myorder")
.processorAuthorizationCode().is("123456");
ResourceCollection<Transaction> collection = gateway.transaction().search(request);
Vault associations
You can search for transactions associated to a payment method token.
TransactionSearchRequest request = new TransactionSearchRequest()
.paymentMethodToken().is("the_token");
ResourceCollection<Transaction> collection = gateway.transaction().search(request);
How the transaction was created
You can search for transactions that were created using a token.
TransactionSearchRequest request = new TransactionSearchRequest()
.createdUsing().is(Transaction.CreatedUsing.TOKEN);
ResourceCollection<Transaction> collection = gateway.transaction().search(request);
Or transactions that were created using full credit card information.
TransactionSearchRequest request = new TransactionSearchRequest()
.createdUsing().is(Transaction.CreatedUsing.FULL_INFORMATION);
ResourceCollection<Transaction> collection = gateway.transaction().search(request);
Those are the only two choices for created_using.
Customer location
Customers in the US.
TransactionSearchRequest request = new TransactionSearchRequest()
.creditCardCustomerLocation().is(CreditCard.CustomerLocation.US);
ResourceCollection<Transaction> collection = gateway.transaction().search(request);
Or international customers.
TransactionSearchRequest request = new TransactionSearchRequest()
.creditCardCustomerLocation().is(CreditCard.CustomerLocation.INTERNATIONAL);
ResourceCollection<Transaction> collection = gateway.transaction().search(request);
Merchant account
A specific one.
TransactionSearchRequest request = new TransactionSearchRequest()
.merchantAccountId().is("the_merchant_account_id");
ResourceCollection<Transaction> collection = gateway.transaction().search(request);
Or any of several.
TransactionSearchRequest request = new TransactionSearchRequest()
.merchantAccountId().in("account_1", "account_2");
ResourceCollection<Transaction> collection = gateway.transaction().search(request);
Credit card type
A specific one.
TransactionSearchRequest request = new TransactionSearchRequest()
.creditCardCardType().is(CreditCard.CardType.VISA);
ResourceCollection<Transaction> collection = gateway.transaction().search(request);
Or any of several.
TransactionSearchRequest request = new TransactionSearchRequest()
.creditCardCardType().in(
CreditCard.CardType.VISA, CreditCard.CardType.MASTER_CARD, CreditCard.CardType.DISCOVER
);
ResourceCollection<Transaction> collection = gateway.transaction().search(request);
Transaction status
Another one or many search field.
TransactionSearchRequest request = new TransactionSearchRequest()
.status().is(Transaction.Status.AUTHORIZED);
TransactionSearchRequest request = new TransactionSearchRequest()
.status().in(
Transaction.Status.AUTHORIZED, Transaction.Status.SUBMITTED_FOR_SETTLEMENT
);
ResourceCollection<Transaction> collection = gateway.transaction().search(request);
Transaction source
API, Control Panel, or Recurring Billing.
TransactionSearchRequest request = new TransactionSearchRequest()
.source().is(Transaction.Source.API);
TransactionSearchRequest request = new TransactionSearchRequest()
.source().in(
Transaction.Source.API, Transaction.Source.CONTROL_PANEL
);
ResourceCollection<Transaction> collection = gateway.transaction().search(request);
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.
TransactionSearchRequest request = new TransactionSearchRequest()
.type().is(Transaction.Type.SALE);
ResourceCollection<Transaction> collection = gateway.transaction().search(request);
This will return all credits, regardless of whether they're refunds, or standalone credits.
TransactionSearchRequest request = new TransactionSearchRequest()
.type().is(Transaction.Type.CREDIT);
ResourceCollection<Transaction> collection = gateway.transaction().search(request);
If you only want the refunds:
TransactionSearchRequest request = new TransactionSearchRequest()
.type().is(Transaction.Type.CREDIT)
.refund().is(true);
ResourceCollection<Transaction> collection = gateway.transaction().search(request);
And if you only want the credits that aren't refunds:
TransactionSearchRequest request = new TransactionSearchRequest()
.type().is(Transaction.Type.CREDIT)
.refund().is(false);
ResourceCollection<Transaction> collection = gateway.transaction().search(request);
Amount
It's a range field.
TransactionSearchRequest request = new TransactionSearchRequest()
.amount().between(new BigDecimal("100.00"), new BigDecimal("200.00"));
TransactionSearchRequest request = new TransactionSearchRequest()
.amount().greaterThanOrEqualTo(new BigDecimal("100.00"));
TransactionSearchRequest request = new TransactionSearchRequest()
.amount().lessThanOrEqualTo(new BigDecimal("200.00"));
ResourceCollection<Transaction> collection = gateway.transaction().search(request);
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:
TransactionSearchRequest searchRequest = new TransactionSearchRequest()
.createdAt().lessThanOrEqual(Calendar.getInstance());
ResourceCollection<Transaction> collection = gateway.transaction().search(searchRequest);
TransactionSearchRequest searchRequest = new TransactionSearchRequest()
.settledAt().lessThanOrEqual(Calendar.getInstance());
ResourceCollection<Transaction> collection = gateway.transaction().search(searchRequest);
TransactionSearchRequest searchRequest = new TransactionSearchRequest()
.processorDeclinedAt().lessThanOrEqual(Calendar.getInstance());
ResourceCollection<Transaction> collection = gateway.transaction().search(searchRequest);
Dispute date range
TransactionSearchRequest searchRequest = new TransactionSearchRequest()
.disputeDate().lessThanOrEqual(Calendar.getInstance());
ResourceCollection<Transaction> collection = gateway.transaction().search(searchRequest);