Searching for Customers

Single Customer

If you want to look up a single customer using its ID, use the find method.

Customer customer = gateway.customer().find("the_customer_id");

If the customer cannot be found, it will throw a NotFoundException.

Other Customer Attributes

You can search for customers using a variety of criteria. For operators available on search fields, see the search fields page. For conciseness, we’re going to show searching on several fields at once, but you can search on as many or as few as you would like in a single search.

Customer Fields

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 Fields

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 Fields

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

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

Credit Card Number

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

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

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

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

Expiration Date

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

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

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

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

Created At

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:

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

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

All Customers

You can get a list of all customers stored in the vault. This will also return the customers addresses and masked credit card data. Search results are currently capped so this may not work for everybody.

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