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.

PHP

$collection = $gateway->transaction()->search([
  BraintreeTransactionSearch::customerId()->is('the_customer_id'),
]);

foreach($collection as $transaction) {
    echo $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::TOKEN
Braintree\Transaction::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.

'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.

'debitNetwork'multiple

The debit network to search for.

'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.

'merchantAccountIdFragment'

A fragment of the merchant account ID to search for.

'contains'text

A part of the merchant account ID to search for.

'endsWith'text

A postfix for the merchant account ID to search for.

'is'text

An exact merchant account ID to search for.

'isNot'text

A merchant account ID to be excluded from the search.

'startsWith'text

A prefix for the merchant account ID to search for.

'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

'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
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

'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

PHP

$collection = $gateway->transaction()->search([
  BraintreeTransactionSearch::creditCardCardholderName()->is("Tom Smith"),
  BraintreeTransactionSearch::creditCardExpirationDate()->is("05/2012"),
  BraintreeTransactionSearch::creditCardNumber()->endsWith("1111"),
]);

Searching On Customer Details

PHP

$collection = $gateway->transaction()->search([
  BraintreeTransactionSearch::customerCompany()->is("Braintree"),
  BraintreeTransactionSearch::customerEmail()->is("[email protected]"),
  BraintreeTransactionSearch::customerFax()->is("5551231234"),
  BraintreeTransactionSearch::customerFirstName()->is("Tom"),
  BraintreeTransactionSearch::customerLastName()->is("Smith"),
  BraintreeTransactionSearch::customerPhone()->is("5551231234"),
  BraintreeTransactionSearch::customerWebsite()->is("http://example.com"),
]);

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

PHP

$collection = $gateway->transaction()->search([
    BraintreeTransactionSearch::creditCardCardholderName()->endsWith('m smith'),
]);

Billing address

PHP

$collection = $gateway->transaction()->search([
    BraintreeTransactionSearch::billingCompany()->is("Braintree"),
    BraintreeTransactionSearch::billingCountryName()->is("United States of America"),
    BraintreeTransactionSearch::billingExtendedAddress()->is("Suite 123"),
    BraintreeTransactionSearch::billingFirstName()->is($firstName),
    BraintreeTransactionSearch::billingLastName()->is("Smith"),
    BraintreeTransactionSearch::billingLocality()->is("Chicago"),
    BraintreeTransactionSearch::billingPostalCode()->is("12345"),
    BraintreeTransactionSearch::billingRegion()->is("IL"),
    BraintreeTransactionSearch::billingStreetAddress()->is("123 Main St"),
]);

Shipping address

PHP

$collection = $gateway->transaction()->search([
    BraintreeTransactionSearch::shippingCompany()->is("Braintree P.S."),
    BraintreeTransactionSearch::shippingCountryName()->is("Mexico"),
    BraintreeTransactionSearch::shippingExtendedAddress()->is("Apt 456"),
    BraintreeTransactionSearch::shippingFirstName()->is("Thomas"),
    BraintreeTransactionSearch::shippingLastName()->is("Smithy"),
    BraintreeTransactionSearch::shippingLocality()->is("Braintree"),
    BraintreeTransactionSearch::shippingPostalCode()->is("54321"),
    BraintreeTransactionSearch::shippingRegion()->is("MA"),
    BraintreeTransactionSearch::shippingStreetAddress()->is("456 Road"),
]);

Other top-level attributes

PHP

$collection = $gateway->transaction()->search([
    BraintreeTransactionSearch::orderId()->is("myorder"),
    BraintreeTransactionSearch::processorAuthorizationCode()->is($transaction->processorAuthorizationCode),
]);

Vault associations

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

PHP

$collection = $gateway->transaction()->search([
    BraintreeTransactionSearch::paymentMethodToken()->is('the_token'),
]);

How the transaction was created

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

PHP

$collection = $gateway->transaction()->search([
    BraintreeTransactionSearch::createdUsing()->is(Braintree\Transaction::TOKEN)
]);

Or transactions that were created using full credit card information.

PHP

$collection = $gateway->transaction()->search([
    BraintreeTransactionSearch::createdUsing()->is(Braintree\Transaction::FULL_INFORMATION)
]);

Those are the only two choices for created_using.

Customer location

Customers in the US.

PHP

$collection = $gateway->transaction()->search([
    BraintreeTransactionSearch::creditCardCustomerLocation()->is(Braintree\CreditCard::US)
]);

Or international customers.

PHP

$collection = $gateway->transaction()->search([
    BraintreeTransactionSearch::creditCardCustomerLocation()->is(Braintree\CreditCard::INTERNATIONAL)
]);

Merchant account

A specific one.

PHP

$collection = $gateway->transaction()->search([
    BraintreeTransactionSearch::merchantAccountId()->is('my_merchant_account')
]);

Or any of several.

PHP

$collection = $gateway->transaction()->search([
    BraintreeTransactionSearch::merchantAccountId()->in(['account_1', 'account_2'])
]);

Credit card type

A specific one.

PHP

$collection = $gateway->transaction()->search([
    BraintreeTransactionSearch::creditCardCardType()->is(Braintree\CreditCard::VISA)
]);

Or any of several.

PHP

$collection = $gateway->transaction()->search([
    BraintreeTransactionSearch::id()->is($transaction->id),
    BraintreeTransactionSearch::creditCardCardType()->in([
        Braintree\CreditCard::VISA,
        Braintree\CreditCard::MASTER_CARD,
        Braintree\CreditCard::DISCOVER
    ])
]);

Transaction status

Another one or many search field.

PHP

$collection = $gateway->transaction()->search([
    BraintreeTransactionSearch::id()->is($transaction->id),
    BraintreeTransactionSearch::status()->in([
        Braintree\Transaction::SUBMITTED_FOR_SETTLEMENT,
        Braintree\Transaction::SETTLED
    ])
]);

Transaction source

API, Control Panel, or Recurring Billing.

PHP

$collection = $gateway->transaction()->search([
    BraintreeTransactionSearch::id()->is($transaction->id),
    BraintreeTransactionSearch::source()->in([
        Braintree\Transaction::API,
        Braintree\Transaction::RECURRING,
        Braintree\Transaction::CONTROL_PANEL
    ])
]);

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.

PHP

$collection = $gateway->transaction()->search([
    BraintreeTransactionSearch::type()->is(Braintree\Transaction::SALE)
]);

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

PHP

$collection = $gateway->transaction()->search([
    BraintreeTransactionSearch::type()->is(Braintree\Transaction::CREDIT)
]);

If you only want the refunds:

PHP

$collection = $gateway->transaction()->search([
    BraintreeTransactionSearch::type()->is(Braintree\Transaction::CREDIT),
    BraintreeTransactionSearch::refund()->is(True)
]);

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

PHP

$collection = $gateway->transaction()->search([
    BraintreeTransactionSearch::type()->is(Braintree\Transaction::CREDIT),
    BraintreeTransactionSearch::refund()->is(False)
]);

Amount

It's a range field .

PHP

$collection = $gateway->transaction()->search([
    BraintreeTransactionSearch::amount()->between('100.00', '200.00')
]);
$collection = $gateway->transaction()->search([
    BraintreeTransactionSearch::amount()->greaterThanOrEqualTo('100.00')
]);
$collection = $gateway->transaction()->search([
    BraintreeTransactionSearch::amount()->lessThanOrEqualTo('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:

createdAt
authorizedAt
submittedForSettlementAt
settledAt
voidedAt
processorDeclinedAt
gatewayRejectedAt
failedAt
authorizationExpiredAt

A few examples:

PHP

$now = new Datetime();
$past = clone $now;
$past = $past->modify("-1 hour");
$collection = $gateway->transaction()->search([
    BraintreeTransactionSearch::createdAt()->between($past, $now)
]);

PHP

$now = new Datetime();
$collection = $gateway->transaction()->search([
    BraintreeTransactionSearch::settledAt()->lessThanOrEqualTo($now)
]);

PHP

$past = new Datetime();
$past = $past->modify("-1 hour");
$collection = $gateway->transaction()->search([
    BraintreeTransactionSearch::processorDeclinedAt()->greaterThanOrEqualTo($past)
]);

Dispute date range

PHP

$now = new Datetime();
$collection = $gateway->transaction()->search([
    BraintreeTransactionSearch::disputeDate()->lessThanOrEqualTo($now)
]);

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.