Each Method type gives back a different set of possible responses for both successes and failures.
The response returned from a Billing Circle Connect submission varies by method and information submitted. However every response is returned as a comma separated string built of four values. Note that "reporting" calls will place the CSV data contents of the report on following lines, with the newline line delimeter (\n).
| Value # | Field | Successful Submission Values |
Failed Submission Values |
Description |
|---|---|---|---|---|
| 1 | Response Code | 1 | 2 | Code identifying success/failure of a submission |
| 2 | Response SubCode | 1 | Varies by failure type | Code identifying failure type. Successful submissions will always return the number "1". |
| 3 | Response Text | "Success" | Varies | Helpful text describing a failed submission. |
| 4 | Response Data | Numeric integer or text | Field causing error | Data returned by Billing Circle Connect used to identify client or billing schedule records. |
Response Data values for successful submissions are always numeric integer values.
| Method | Description |
|---|---|
| createclient | Client ID value (c_clientid). This value is the internal key used by Billing Circle to refer to the client record. The merchant may use this value, or the c_merchantid submitted to later refer to the client in submissions. |
| confirmclient | Client ID value. See createclient above. |
| modifyclient | Client ID value. See createclient above. |
| deleteclient | Client ID value. See createclient above. |
| verifyclientbilling | Client ID value. See createclient above. |
| checkclientstatus | c_status value of client, as modified using "modifyclient" method. Possible values: "active", "inactive", "pending", "fraudulent", "closed" |
| createschedule | Schedule ID value (s_scheduleid). This value is the internal key used by Billing Circle to refer to the billing schedule. The merchant must use this value to later refer to the billing schedule in submissions. |
| confirmschedule | Schedule ID value. See createschedule above. |
| modifyschedule | Schedule ID value. See createschedule above. |
| deleteschedule | Schedule ID value. See createschedule above. |
| createadjustment | Schedule ID value. See createschedule above. |
| checkschedulestatus | Status of the latest charge attempt on the billing schedule. Possible values: "new", "success", "declined", "closed", "resubmitted", "outstanding" |
| reporting | Title of the report. All following lines (broken by newline characters) are the contents of the report, in CSV value. |
The following are examples of successful and failed api responses.
1,1,Success,68
In the above example a client record is successfully created and a c_clientid "68" is returned by Billing Circle Connect. This value should be stored and can be used to refer to the client record in other submissions.
| Code | SubCode | Text | Data (c_clientid) |
|---|---|---|---|
| 1 | 1 | Success | 68 |
1,1,Success,283
In the above example a billing schedule is successfully created and a s_scheduleid "283" is returned by Billing Circle Connect. This value should be stored and will be used to refer to the billing schedule record for confirmschedule, modifyschedule and deleteschedule Methods.
| Code | SubCode | Text | Data (s_scheduleid) |
|---|---|---|---|
| 1 | 1 | Success | 283 |
2,1007,A required field is invalid: C_CCNUMBER,c_ccnumber
In the above example an invalid credit card number is submitted.
| Code | SubCode | Text | Data (error causing field) |
|---|---|---|---|
| 2 | 1007 | A required field is invalid: C_CCNUMBER | c_ccnumber |
2,1016,Billing verification failure,This transaction has been declined.
In the above example the authorization was declined through AuthorizeNet is submitted.
| Code | SubCode | Text | Data (response text returned from AuthorizeNet) |
|---|---|---|---|
| 2 | 1016 | Billing verification failure | This transaction has been declined. |
2,1001,Invalid Credentials
A submission is sent using incorrect login credentials. The company, username, or password were incorrect.
| Code | SubCode | Text | Data |
|---|---|---|---|
| 2 | 1001 | Invalid Credentials |
1,1,Success,pending
In the above example the client record queried is currently set to pending and will not be processed for billing.
| Code | SubCode | Text | Data |
|---|---|---|---|
| 1 | 1 | Success | pending |
1,1,Success,Transaction Report - Net By Month
"Month","Transactions","Subtotal","Taxes","Total"
"2007 - 05 - May","24","1520.96","0.00","1520.96"
"2007 - 06 - June","25","1706.00","0.00","1706.00"
"2007 - 07 - July","29","2633.00","0.00","2633.00"
"2007 - 08 - August","29","3102.00","0.00","3102.00"
"2007 - 09 - September","30","2601.00","0.00","2601.00"
"2007 - 10 - October","17","1399.00","0.00","1399.00"
In the above example the client record queried is currently set to pending and will not be processed for billing.
| Code | SubCode | Text | Data |
|---|---|---|---|
| 1 | 1 | Success |
Transaction Report - Net By Month "Month","Transactions","Subtotal","Taxes","Total" "2007 - 05 - May","24","1520.96","0.00","1520.96" "2007 - 06 - June","25","1706.00","0.00","1706.00" "2007 - 07 - July","29","2633.00","0.00","2633.00" "2007 - 08 - August","29","3102.00","0.00","3102.00" "2007 - 09 - September","30","2601.00","0.00","2601.00" "2007 - 10 - October","17","1399.00","0.00","1399.00" |
1,1,Success,outstanding transactions
"recordid","clientid","merchantid","scheduleid","company","firstname","lastname","email","avs","amount","duedate","attempts","daysoverdue"
"117132","23504","joecompany","22257","Joe Company, LLC","Joe","Burnam","joe@joecompany.com","Y","28.00","2009-03-14","2","6"
"137126","55232","increbar","232442","Inc Rebar Co","Frank","Landry","frank@increbar.com","Z","38.00","2009-01-14","2","20"
A "due" report for outsanding transactions.
Members Login 