Developer Information

• Introduction

• Customer Self Service
• Callback URL
• Billing Circle Connect API
  • Understanding Bill Types

Connect API

• API Introduction
• Client Records
  • Create Client
  • Confirm Client
  • Modify Client
  • Delete Clients
  • Create Note
  • Verify Client Billing
  • Check Client Status
  • Fetch Client Data
  • Search Client Data
• Billing Schedules
  • Create Schedule
  • Confirm Schedule
  • Modify Schedule
  • Delete Schedule
  • Create Adjustment
  • Check Schedule Status
  • Fetch Schedule Data
• Reporting Data
  • Report Transactions
  • Report Due
• Understanding Responses
  • Response Codes

Resources

• Sample Code

Modify Client

The modifyclient Method allows previously created client records to be modified and updated. All NAME/VALUE pairs from the createclient Method are allowed as well as c_status.

Field	Required	Value	Max Length	Description
method	Required	modifyclient	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. This value is required if a "clientid" is not submitted.
c_clientid	Conditional	Integer	N/A	The "clientid" is an integer value returned after a successful createclient post. This value is required if a merchantid is not submitted.
c_company	Optional	Any string	30	Client company.
c_firstname	Optional	Any string	30	Client first name.
c_lastname	Optional	Any string	30	Client last name.
c_address	Optional	Any string	100	Client billing address.
c_address2	Optional	Any string	100	Client billing address.
c_city	Optional	Any string	100	Client billing city.
c_state	Optional	State Code	2	Client billing state/province code. US Codes, CA Codes
c_zip	Optional	Any string	20	Client billing zip code.
c_country	Optional	ISO Country Code	2	Client billing country. Country Codes available here
c_saddress	Required	Any string	100	Client shipping address.
c_saddress2	Optional	Any string	100	Client shipping address2.
c_scity	Optional	Any string	100	Client shipping city.
c_sstate	Optional	State Code	2	Client shipping state/province code.
c_szip	Optional	Any string	20	Client shipping zip code.
c_scountry	Optional	ISO Country Code	2	Client shipping country.
c_phone	Optional	Any string	20	Client phone number.
c_fax	Optional	Any string	20	Client fax number.
c_email	Optional	Any string	100	Client email address.
c_password	Optional	Any string	100	Client password allowing client to log into a private URL to manage their account.
c_sendemails	Optional	Any non-zero value	N/A	If set this allows client to receive various Billing Circle generated emails such as billing receipts. Emails must be first set up by merchant. Clients will not be sent emails by default.
c_custom1	Optional	Any string	255	Custom client field set up by merchant in Billing Circle.
c_custom2	Optional	Any string	255	Custom client field set up by merchant in Billing Circle.
c_custom3	Optional	Any string	255	Custom client field set up by merchant in Billing Circle.
c_customN	Optional	Any string	255	You can send fields c_custom1 through c_custom20
c_chargemethod	Optional	"cc", "echeck", "manual"	N/A	Method used to charge client. CC = Credit Card, ECHECK = ACH/eCheck debit.
c_ccname	Optional	Any string	30	Name on credit card. Required if c_chargemethod is "cc" or is omitted.
c_ccnumber	Optional	Any string	16	Credit card number. Required if c_chargemethod is "cc" or is omitted.
c_ccexp	Optional	MM/YYYY	7	Credit card expiration date. Required if c_chargemethod is "cc" or is omitted.
c_ccv2	Optional	Integer	4	CCV security number found on most credit cards. After the first successful transaction this information is deleted from our database. Optional when c_chargemethod is "cc" or is omitted.
c_ccnamebackup	Optional	Any string	30	Name on backup credit card. Backup cards will be attempted if a decline is received while charging the primary card. Note that the backup card will NOT be attempted when using the s_authimmediately option for creating billing schedules.
c_ccnumberbackup	Optional	Any string	16	Credit card number associated with backup credit card.
c_ccexpbackup	Optional	MM/YYYY	7	Expiration date associated with backup credit card.
c_ccv2backup	Optional	Integer	4	CCV security number associated with backup credit card.
c_routingnumber	Optional	Integer	9	Check routing number. Required if c_chargemethod is "echeck".
c_accountnumber	Optional	Integer	20	Check account number. Required if c_chargemethod is "echeck".
c_accounttype	Optional	"checking", "saving", "businesschecking"	N/A	Bank account type. Required if c_chargemethod is "echeck".
c_bankname	Optional	Any String	50	Bank name. Required if c_chargemethod is "echeck".
c_nameonaccount	Optional	Any String	50	Name on bank account. Required if c_chargemethod is "echeck".
c_status	Optional	active, inactive, pending, fraudulent, closed	N/A	Status of client record. Statuses are meant for organization within the Billing Circle application. Only clients set to status "active" are billable.
c_manualnote	Conditional	Any String	50	Manual charge method. Required if c_chargemethod is "manual".
c_ipaddress	Optional	Any String	20	The customer's browser's IP address.

• 

• Tour
• Sign Up
• Clients
• About
• Support
• Blog
• Site Map
• © 2012 Billing Circle