Customer

Customer: Search

Returns a collection of Customer response objects.

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

  1. Ruby
collection = gateway.customer.search do |search|
  search.id.is "the_customer_id"
end

collection.each do |customer|
  puts customer.first_name
end
Parameters
:address_country_nametext
The country on an address associated with the customer.
:address_extended_addresstext
The extended address on an address associated with the customer.
:address_first_nametext
The first name on an address associated with the customer.
:address_last_nametext
The last name on an address associated with the customer.
:address_localitytext
The locality (e.g. city) on an address associated with the customer.
:address_postal_codetext
The postal code on an address associated with the customer.
:address_regiontext
The region (e.g. state) on an address associated with the customer.
:address_street_addresstext
The street address on an address associated with the customer.
:cardholder_nametext
The name on a credit card associated with the customer.
:companytext
The customer's company.
:created_atrange
The date/time the customer was created.
:credit_card_expiration_datetext
The expiration date of a credit card associated with the customer.
:credit_card_numbertext

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.
:first_nametext
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.
:last_nametext
The customer's last name.
:payment_method_tokentext
The payment method token of a payment method associated with the customer.
:payment_method_token_with_duplicatestext

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.

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

Examplesanchor

Customer fieldsanchor

  1. Ruby
search_results = gateway.customer.search do |search|
  search.company.is "Acme Inc."
  search.email.is "john.doe@example.com"
  search.fax.is "555-123-1234"
  search.first_name.is "John"
  search.id.is "the_customer_id"
  search.last_name.is "Doe"
  search.phone.is "555-321-4321"
  search.website.is "http://www.example.com"
end

Address fieldsanchor

  1. Ruby
search_results = gateway.customer.search do |search|
  search.address_first_name.is "John"
  search.address_last_name.is "Doe"
  search.address_street_address.is "111 First St."
  search.address_extended_address.is "Suite #3"
  search.address_locality.is "Chicago"
  search.address_region.is "IL"
  search.address_postal_code.is "12345"
  search.address_country_name.is "USA"
end

Credit card fieldsanchor

  1. Ruby
search_results = gateway.customer.search do |search|
  search.cardholder_name.is "John Doe"
  search.payment_method_token.is "the_payment_method_token"
end

Credit card numberanchor

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. Ruby
search_results = gateway.customer.search do |search|
  search.credit_card_number.starts_with "510510"
end

search_results = gateway.customer.search do |search|
  search.credit_card_number.ends_with "5100"
end

Expiration dateanchor

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

  1. Ruby
search_results = gateway.customer.search do |search|
  search.credit_card_expiration_date.is "12/13"
end

search_results = gateway.customer.search do |search|
  search.credit_card_expiration_date.is_not "12/13"
end

Created atanchor

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. Ruby
search_results = gateway.customer.search do |search|
  search.created_at >= Time.now - 60*60*24 # a day ago
end

Payment method token with duplicatesanchor

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

An example:

  1. Ruby
search_results = gateway.customer.search do |search|
  search.payment_method_token_with_duplicates.is "payment_method_token"
end

All customersanchor

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. Ruby
customers = gateway.customer.all

See also