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. Node
const stream = gateway.customer.search((search) => {
  search.id().is("the_customer_id");
}, (err, response) => {
  response.each((err, customer) => {
    console.log(customer.firstName);
  });
});

;
Parameters
addressCountryNametext
The country on an address associated with the customer.
addressExtendedAddresstext
The extended address on an address associated with the customer.
addressFirstNametext
The first name on an address associated with the customer.
addressLastNametext
The last name on an address associated with the customer.
addressLocalitytext
The locality (e.g. city) on an address associated with the customer.
addressPostalCodetext
The postal code on an address associated with the customer.
addressRegiontext
The region (e.g. state) on an address associated with the customer.
addressStreetAddresstext
The street address on an address associated with the customer.
cardholderNametext
The name on a credit card associated with the customer.
companytext
The customer's company.
createdAtrange
The date/time the customer was created.
creditCardExpirationDatetext
The expiration date of a credit card associated with the customer.
creditCardNumbertext

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.

emailtext
The customer's email.
faxtext
The customer's fax number.
firstNametext
The customer's first name.
idtext
A string value representing an existing customer in your Vault.
idsmultiple
A list of customer IDs to search for.
lastNametext
The customer's last name.
paymentMethodTokentext
The payment method token of a payment method associated with the customer.
paymentMethodTokenWithDuplicatestext

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.

paypalAccountEmailtext
The email of a PayPal account associated with the customer.
phonetext
The customer's phone number.
websitetext
The customer's website.
;

ExamplesAnchorIcon

Customer fieldsAnchorIcon

  1. Node
const stream = gateway.customer.search((search) => {
  search.company().is("Acme Inc.");
  search.email().is("[email protected]");
  search.fax().is("555-123-1234");
  search.firstName().is("John");
  search.id().is("theCustomerId");
  search.lastName().is("Doe");
  search.phone().is("555-321-4321");
  search.website().is("http://www.example.com");
});

Address fieldsAnchorIcon

  1. Node
const stream = gateway.customer.search((search) => {
  search.addressFirstName().is("John");
  search.addressLastName().is("Doe");
  search.addressStreetAddress().is("111 First St.");
  search.addressExtendedAddress().is("Suite #3");
  search.addressLocality().is("Chicago");
  search.addressRegion().is("IL");
  search.addressPostalCode().is("12345");
  search.addressCountryName().is("USA");
});

Credit card fieldsAnchorIcon

  1. Node
const stream = gateway.customer.search((search) => {
  search.cardholderName().is("John Doe");
  search.paymentMethodToken().is("thePaymentMethodToken");
});

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. Node
const stream = gateway.customer.search((search) => {
  search.creditCardNumber().startsWith("510510");
});
  1. Node
const stream = gateway.customer.search((search) => {
  search.creditCardNumber().endsWith("5100");
});

Expiration dateAnchorIcon

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

  1. Node
const stream = gateway.customer.search((search) => {
  search.creditCardExpirationDate().is("12/13");
});
  1. Node
const stream = gateway.customer.search((search) => {
  search.creditCardExpirationDate().isNot("12/13");
});

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. Node
const today = new Date();
const yesterday = new Date();
yesterday.setDate(today.getDate() - 1);

const stream = gateway.customer.search((search) => {
  search.createdAt().min(yesterday);
});

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. Node
const stream = gateway.customer.search((search) => {
  search.paymentMethodTokenWithDuplicates().is("paymentMethodToken");
});

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. Node
// this call is not implemented in node