Search customers

This request searches for customers within your account.

 Click to learn more about this request

Customer Searches

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_zipcdoe
    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

Sample Payloads

{
    "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"
                ]
            }
        }
    }
}
Language
Authorization
Click Try It! to start a request and see the response here!