Transaction

Transaction: Search

Returns a collection of Transaction response objects.

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

  1. PHP
$collection = $gateway->transaction()->search([
  Braintree\TransactionSearch::customerId()->is('the_customer_id'),
]);

foreach($collection as $transaction) {
    echo $transaction->amount;
}
Parameters
The amount of the transaction. The amount must be formatted like xx or x.xx.
The date/time the transaction's authorization expired.
The date/time the transaction was authorized.
The company name on the billing address used for the transaction.
The country name on the billing address used for the transaction.
The extended address on the billing address used for the transaction.
The first name on the billing address used for the transaction.
The last name on the billing address used for the transaction.
The locality (e.g. city) on the billing address used for the transaction.
The postal code on the billing address used for the transaction.
The region (e.g. state) on the billing address used for the transaction.
The street address on the billing address used for the transaction.
The date/time at which the transaction was created.

The data used to create the transaction. Possible values:

  • Braintree\Transaction::TOKEN
  • Braintree\Transaction::FULL_INFORMATION

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

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

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

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

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.

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

The currency of the transaction.
The customer's company associated with the transaction.
The customer's email address associated with the transaction.
The customer's fax number associated with the transaction.
The customer's first name associated with the transaction.
A string value representing an existing customer in your Vault that is associated with the transaction.
The customer's last name associated with the transaction.
The customer's phone number associated with the transaction.
The customer's website associated with the transaction.
The debit network to search for.

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.

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

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

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

The merchant account IDs associated with transactions.

A fragment of the merchant account ID to search for.

A part of the merchant account ID to search for.
A postfix for the merchant account ID to search for.
'is'text
An exact merchant account ID to search for.
A merchant account ID to be excluded from the search.
A prefix for the merchant account ID to search for.
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.
The payment method token used in the transaction.
The Authorization ID for a PayPal transaction.
The PayPal account holder's email for a PayPal transaction.
The identification value of the payment in PayPal's API for a PayPal transaction.
The authorization code returned by the processor for the transaction.
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.

The date/time the transaction finished settling.
ID of the batch the transaction was submitted for settlement under.
The company name on the shipping address used for the transaction.
The country name on the shipping address used for the transaction.
The extended address on the shipping address used for the transaction.
The first name on the shipping address used for the transaction.
The last name on the shipping address used for the transaction.
The locality (e.g. city) on the shipping address used for the transaction.
The postal code on the shipping address used for the transaction.
The region (e.g. state) on the shipping address used for the transaction.
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
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.
The date/time the transaction was voided.

Examplesanchor

Credit cardanchor

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

Searching On Customer Detailsanchor

  1. PHP
$collection = $gateway->transaction()->search([
  BraintreeTransactionSearch::customerCompany()->is("Braintree"),
  BraintreeTransactionSearch::customerEmail()->is("smith@example.com"),
  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:

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

Billing addressanchor

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

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

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

Vault associationsanchor

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

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

How the transaction was createdanchor

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

  1. PHP
$collection = $gateway->transaction()->search([
  BraintreeTransactionSearch::createdUsing()->is(BraintreeTransaction::TOKEN)
]);

Or transactions that were created using full credit card information.

  1. PHP
$collection = $gateway->transaction()->search([
  BraintreeTransactionSearch::createdUsing()->is(BraintreeTransaction::FULL_INFORMATION)
]);

Those are the only two choices for created_using.

Customer locationanchor

Customers in the US.

  1. PHP
$collection = $gateway->transaction()->search([
  BraintreeTransactionSearch::creditCardCustomerLocation()->is(BraintreeCreditCard::US)
]);

Or international customers.

  1. PHP
$collection = $gateway->transaction()->search([
  BraintreeTransactionSearch::creditCardCustomerLocation()->is(BraintreeCreditCard::INTERNATIONAL)
]);

Merchant accountanchor

A specific one.

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

Or any of several.

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

Credit card typeanchor

A specific one.

  1. PHP
$collection = $gateway->transaction()->search([
  BraintreeTransactionSearch::creditCardCardType()->is(BraintreeCreditCard::VISA)
]);

Or any of several.

  1. PHP
$collection = $gateway->transaction()->search([
  BraintreeTransactionSearch::id()->is($transaction->id),
  BraintreeTransactionSearch::creditCardCardType()->in(
    [
      BraintreeCreditCard::VISA,
      BraintreeCreditCard::MASTER_CARD,
      BraintreeCreditCard::DISCOVER
    ]
  )
]);

Transaction statusanchor

Another one or many search field.

  1. PHP
$collection = $gateway->transaction()->search([
  BraintreeTransactionSearch::id()->is($transaction->id),
  BraintreeTransactionSearch::status()->in(
    [
      BraintreeTransaction::SUBMITTED_FOR_SETTLEMENT,
      BraintreeTransaction::SETTLED
    ]
  )
]);

Transaction sourceanchor

API, Control Panel, or Recurring Billing.

  1. PHP
$collection = $gateway->transaction()->search([
  BraintreeTransactionSearch::id()->is($transaction->id),
  BraintreeTransactionSearch::source()->in(
    [
      BraintreeTransaction::API,
      BraintreeTransaction::RECURRING,
      BraintreeTransaction::CONTROL_PANEL
    ]
  )
]);

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. PHP
$collection = $gateway->transaction()->search([
  BraintreeTransactionSearch::type()->is(BraintreeTransaction::SALE)
]);

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

  1. PHP
$collection = $gateway->transaction()->search([
  BraintreeTransactionSearch::type()->is(BraintreeTransaction::CREDIT)
]);

If you only want the refunds:

  1. PHP
$collection = $gateway->transaction()->search([
  BraintreeTransactionSearch::type()->is(BraintreeTransaction::CREDIT),
  BraintreeTransactionSearch::refund()->is(True)
]);

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

  1. PHP
$collection = $gateway->transaction()->search([
  BraintreeTransactionSearch::type()->is(BraintreeTransaction::CREDIT),
  BraintreeTransactionSearch::refund()->is(False)
]);

Amountanchor

It's a range field .

  1. 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 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. PHP
$now = new Datetime();
$past = clone $now;
$past = $past->modify("-1 hour");

$collection = $gateway->transaction()->search([
  BraintreeTransactionSearch::createdAt()->between($past, $now)
]);
  1. PHP
$now = new Datetime();

$collection = $gateway->transaction()->search([
  BraintreeTransactionSearch::settledAt()->lessThanOrEqualTo($now)
]);
  1. PHP
$past = new Datetime();
$past = $past->modify("-1 hour");

$collection = $gateway->transaction()->search([
  BraintreeTransactionSearch::processorDeclinedAt()->greaterThanOrEqualTo($past)
]);

Dispute date rangeanchor

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

See also