Developer Information

Connect API

Resources

Search Client Data

The searchclient method allows the merchant to fetch a single client record, similar to the fetchclient call, but using an standard client field rather than requiring the clientid or merchantid unique keys.

Response Text Example: clientid=1234&merchantid=mymerchid&firstname=John&lastname=Doe&address1=123+Fake+St&city=Long+Beach&state=CA&postal=90802&country=US&phone=123-123-1234&email=john%40fake.com&chargemethod=cc&status=active&ccname=John+Doe&ccnumber=3232&ccexpmonth=09&ccexpyear=2013&lasttransstatus=success&datecreated=2007-07-15&custom1=My+Custom+Data

Field Required Value Max Length Description
method Required searchclient N/A Indicates the function the merchant wishes to perform.
companyid Required Varies by merchant 30 Issued by Billing Circle.
username Required Varies by merchant 30 Any Admin level account defined within Billing Circle.
password Required Varies by merchant 100 Password associated with username field.
searchfield Required string N/A One of the following values: c_email, c_firstname, c_lastname, c_address, c_address2, c_state, c_zip, c_country, c_phone, c_fax, c_ccname and c_custom1 through c_custom20
searchvalue Required string 20 The value to search. Search is performed case-insensitive, and as a starts-with wildcard. For instance, '123 Fake' will match '123 fake st', '123 FAKE AVE', etc.