Server-Side API Requests/
Customer/
Search

Customer: Search

Returns a collection of Customer response objects.

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

  1. Java
CustomerSearchRequest request = new CustomerSearchRequest()
  .id().is("the_customer_id");

ResourceCollection<Customer> collection = gateway.customer().search(request);

for (Customer customer : collection) {
    System.out.println(customer.getFirstName());
}

;
Parameters
.addressCountryName(…)text
The country on an address associated with the customer.
.addressExtendedAddress(…)text
The extended address on an address associated with the customer.
.addressFirstName(…)text
The first name on an address associated with the customer.
.addressLastName(…)text
The last name on an address associated with the customer.
.addressLocality(…)text
The locality (e.g. city) on an address associated with the customer.
.addressPostalCode(…)text
The postal code on an address associated with the customer.
.addressRegion(…)text
The region (e.g. state) on an address associated with the customer.
.addressStreetAddress(…)text
The street address on an address associated with the customer.
.cardholderName(…)text
The name on a credit card associated with the customer.
.company(…)text
The customer's company.
.createdAt(…)range
The date/time the customer was created.
.creditCardExpirationDate(…)text
The expiration date of a credit card associated with the customer.
.creditCardNumber(…)text

The number of a credit card associated with the customer.

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.

.email(…)text
The customer's email.
.fax(…)text
The customer's fax number.
.firstName(…)text
The customer's first name.
.id(…)text
A string value representing an existing customer in your Vault.
.ids(…)multiple
A list of customer IDs to search for.
.lastName(…)text
The customer's last name.
.paymentMethodToken(…)text
The payment method token of a payment method associated with the customer.
.paymentMethodTokenWithDuplicates(…)text

Same as payment method token, except this will return all customers that have a credit card with the same number as the payment method being searched.

.paypalAccountEmail(…)text
The email of a PayPal account associated with the customer.
.phone(…)text
The customer's phone number.
.website(…)text
The customer's website.
;

ExamplesAnchorIcon

Customer fieldsAnchorIcon

  1. Java
CustomerSearchRequest request = new CustomerSearchRequest()
  .company().is("Acme Inc.")
  .email().is("john.doe@example.com")
  .fax().is("555-123-1234")
  .firstName().is("John")
  .id().is("the_customer_id")
  .lastName().is("Doe")
  .phone().is("555-321-4321")
  .website().is("http://www.example.com");

ResourceCollection<Customer> collection = gateway.customer().search(request);

Address fieldsAnchorIcon

  1. Java
CustomerSearchRequest request = new CustomerSearchRequest()
  .addressFirstName().is("John")
  .addressLastName().is("Doe")
  .addressStreetAddress().is("111 First St.")
  .addressExtendedAddress().is("Suite #3")
  .addressLocality().is("Chicago")
  .addressRegion().is("IL")
  .addressPostalCode().is("12345")
  .addressCountryName().is("USA");

ResourceCollection<Customer> collection = gateway.customer().search(request);

Credit card fieldsAnchorIcon

  1. Java
CustomerSearchRequest request = new CustomerSearchRequest()
  .cardholderName().is("John Doe")
  .paymentMethodToken().is("the_payment_method_token");

ResourceCollection<Customer> collection = gateway.customer().search(request);

Credit card numberAnchorIcon

Searching on credit card number has a few restrictions. If you search using "starts with" you can only enter up to the first 6 digits. If you search using "ends with" you can only enter the last 4 digits. And you can't search on "contains."

  1. Java
CustomerSearchRequest request = new CustomerSearchRequest()
  .creditCardNumber().startsWith("510510");

CustomerSearchRequest request = new CustomerSearchRequest()
  .creditCardNumber().endsWith("5100");

ResourceCollection<Customer> collection = gateway.customer().search(request);

Expiration dateAnchorIcon

Expiration date also has restrictions. "is" and "is not" work, while "starts with," "ends with," and "contains" do not.

  1. Java
CustomerSearchRequest request = new CustomerSearchRequest()
  .creditCardExpirationDate().is("12/13");

CustomerSearchRequest request = new CustomerSearchRequest()
  .creditCardExpirationDate().isNot("12/13");

ResourceCollection<Customer> collection = gateway.customer().search(request);

Created atAnchorIcon

You can search for customers that were created at a certain time. For instance, you can find all customers which were created in the past 3 days.

An example:

  1. Java
CustomerSearchRequest searchRequest = new CustomerSearchRequest()
  .createdAt().lessThanOrEqual(Calendar.getInstance());

ResourceCollection<Customer> collection = gateway.customer().search(searchRequest);

Payment method token with duplicatesAnchorIcon

You can search for customers that have duplicated credit card numbers using payment method token as a reference.

An example:

  1. Java
CustomerSearchRequest searchRequest = new CustomerSearchRequest()
  .paymentMethodTokenWithDuplicates().is("paymentMethodToken");

ResourceCollection<Customer> collection = gateway.customer().search(searchRequest);

All customersAnchorIcon

You can get a list of all customers stored in the Vault. This will return a resource collection of customer objects. Search results are currently capped so this may not work for everybody.

  1. Java
ResourceCollection<Customer> collection = gateway.customer().all();