Developer Information

Connect API

Resources

Fetch Client Data

The fetchclient method allows the merchant to fetch all client information, such as name, address, email, and credit card information. Note that only the last 4 digits of the credit card is returned. Data is returned as a URL encoded query string.

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 fetchclient 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.
c_merchantid Conditional Any unique value 255 The "merchantid" allows a merchant to refer to a client record by their own proprietary key as defined within their database. For all methods, excluding createclient, the "merchantid" can be omitted if the "clientid" is submitted. Each client record must have a unique merchantid.
c_clientid Conditional Integer N/A The "clientid" is the key created by Billing Circle to refer to a client record. It is returned by Billing Circle after processing a successful createclient request. For all methods, excluding createclient (where a "clientid" is not applicable), the "clientid" can be omitted if the "merchantid" is submitted.