This request searches for customers within your account.
Secure Payments' search functionality is customizable to allow for broad and narrow search queries. Here's what you need to know about searches:
Customer social security numbers are not returned in these results; as such, you cannot search for customer's via their social security number.
The"fields"
** array holds values that the query value will search through**. The usable values in this array are customer information fields. Here's a list of available values:
primary_zipcode | email |
first_name | phone_number |
mail_address1 | mail_address |
generation_code | updated |
primary_address1 | created |
middle_name | company_name |
primary_address | mail_zipcode |
mail_state | primary_address2 |
primary_city | mail_city |
primary_country | mail_country |
contact_name | id |
mail_address2 | last_name |
user_id | gender |
driver_license | primary_state |
credit_limit |
{
"search": {
"size": 100,
"from": 0,
"query": {
"query_string": {
"query": "*John*",
"default_operator": "OR",
"fields": [
"first_name",
"middle_name",
"last_name",
"email"
]
}
}
}
}
{
"search": {
"size": 100,
"from": 0,
"query": {
"query_string": {
"query": "*60602*",
"default_operator": "OR",
"fields": [
"primary_zipcode",
"mail_zipcode"
]
}
}
}
}
{
"search": {
"size": 100,
"from": 0,
"query": {
"query_string": {
"query": "8348928",
"default_operator": "OR",
"fields": [
"id"
]
}
}
}
}
Results
Returns customer information, matching the search query, on a success. An export set to false
will include all customer information, excluding the customer's ssn
(social security number), and be returned in the response.
An export set to true
will send a report (.csv file) containing the search results to the associated agent's email address. This report will include less customer information, returning the values for first_name
, middle_name
, last_name
, generation_code
, email
, company_name
, contact_name
, credit_limit
, created
date, and updated
date.
A 404 Not Found
error may occur if the request is missing the export boolean.