Below are the definitions of data that can be submitted to Billing Circle Connect for processing. Communication with Billing Circle is separated into different Methods, each Method performing a single function. Each Method is built of required and optional fields. All data is communicated as a set of NAME/VALUE pairs. The following tables contain the data fields that may be submitted with each Method. The fields are grouped based on the Method submitted.
Each table contains the following information:
Note on c_clientid and c_merchantid. A client record's merchantid is a value sent to Billing Circle by the merchant when creating a client record. This field is required and can be any value up to 255 characters. This value should be any internal value the merchant uses to refer to a client record, be it an integer key, username, email, etc. A client record's clientid is an integer value returned to the merchant after a successful createclient submission. Either the clientid or merchantid must be sent along with any Method dealing with existing client records or any billing schedule related Method. The merchant may choose which field to submit.
The following fields are global to all Methods.
| Field | Required | Value | Max Length | Description |
|---|---|---|---|---|
| method | Required | createclient, confirmclient, modifyclient, deleteclient, verifyclientbilling, checkclientstatus, fetchclient, createschedule, confirmschedule, modifyschedule, deleteschedule, createadjustment, checkschedulestatus, fetchschedule, reporting | 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. |
| testmode | Optional | Any non-zero value | N/A | Indicates whether the method should be processed as a test. Any Method submitted as a test will return a fake successful result if all required field are present, however it will not make any queries to the live databases. |
If the testmode field is sent along with any Method with a non-zero value, the data will be validated, however no information will be saved or queried within the database. If all required fields are present and data is valid, a "Success" response will be returned, however any clientids or scheduleids returned will be invalid test data created by the test subsystem. testmode is meant as a convenience and a safety feature for testing. Note that all Methods posted to the testing URL will be processed in test mode.
fetchclient, fetchschedule, and reporting calls are not available in test mode.
Members Login 