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

Billing Circle Connect API

The Billing Circle Connect API allows merchants to seamlessly integrate recurring billing functionality into their own web (and desktop) applications.

The Connect API is aimed at providing an easy to implement, transparent, secure option for those looking to increase the flexibility of their product or service.

This document describes how to interact with the Billing Circle Connect.

Billing Circle Connect requires the ability to create both client and server side SSL connections. Maximum security is achieved because all data is submitted and initiated by the merchant server via SSL encryption.

The merchant server will receive an immediate response from Billing Circle, thus giving complete control over the customer's experience.

How it Works

When using Billing Circle Connect:

• The Customer connects to the merchant's site. All customer interaction takes place on the merchant's server.
• The merchant's server initiates a secure connection to the Billing Circle Connect URL (provided by Billing Circle) and initiates one or more HTTPS posts, performing various actions.
• Billing Circle Connect receives and processes the posted information.
• Billing Circle Connect responds to the request indicating success or failure.
• The merchant's server receives and processes the response.
• The merchant's server modifies the customer's experience based on response.

Requirements

The following is required of the merchant to take advantage of Billing Circle Connect:

• Contact Billing Circle and receive a secure testing and production URL. This is free for all Billing Circle members.
• Establish an SSL connection
• Provide both server and client side encryption
• Develop scripts for the integration to Billing Circle Connect (e.g., for submitting data and receiving and translating responses)
• Store Customer and Schedule Keys returned by Billing Circle Connect for later interaction.

Security

The Billing Circle Connect API defines the fields necessary to facilitate seamless interaction with the Billing Circle application. The merchant will still use the Billing Circle application's web-based interface to manage their overall account.

• All transactions are posted over a secure SSL socket.
• All transactions are authenticated against three client-unique values: CompanyID, Username, Password.
• Optionally, the URL access can be limited to communications with a single IP address per client.
• All customer credit card information is uniquely encrypted per client within our database.

Sample Code

Please visit our Resource Section for sample code.

• 

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