CCBill RESTful Transaction API

The primary function of CCBill's RESTful API is to enable merchants to create payment tokens and use them to charge customers.

CCBill's RESTful API allows you to take full advantage of CCBill's payment platform without utilizing CCBill's hosted payment forms.

With the API, you only need to ask customers for payment information once. For any subsequent transactions, you can use their tokenized data.

You can develop customer-facing and backend applications to access RESTful API resources programmatically and seamlessly integrate CCBill's payment processing solutions into payment flows.

Use the RESTful API to deliver an engaging and frictionless checkout experience regardless of the device or platform the customer is using.

Getting Started

Merchants need to build apps that capture customer payment data and send structured API calls to CCBill RESTful API endpoints. The API requests must be structured according to the CCBill RESTful API documentation.

Before proceeding with the API integration, merchants must open a payment processing account and register their apps with CCBill.

1. Open a CCBill Merchant Account

If you do not have a CCBill Merchant account, contact CCBill Sales or use the APPLY NOW button on our website.

CCBill employs a dedicated team of professionals to assist merchants and ensure that the onboarding process is completed with minimal friction.

The Merchant Support Service is available 24/7 and offers complete technical and administrative support regarding CCBill services.

2. Register App with CCBill

Before accessing the API, you need to register your application with CCBill Merchant Support and inform them you need a RESTful API setup on your merchant account.

Once the setup and registration are complete, the Merchant Support team will provide frontend and backend credentials.

These credentials are required to generate OAuth bearer tokens to authenticate and authorize your API requests.

In addition, the support team will set up a test account that allows you to test API calls and responses and optimize the RESTful API integration before going live.

The Payment Flow

1. Provide Payment Information

Customer payment details (such as the credit card number, expiration date, cardholder name, etc.) must be collected through a payment form.

Merchants can design custom payment forms and apps to capture this information and then forward the data in an API request to the correct endpoint.

The CCBill RESTful API uses the captured data to create a unique payment token.

HTML Example

<form id="payment-form"> 
    <input data-ccbill="firstName" />
    <input data-ccbill="lastName" />
    <input data-ccbill="amount" />
    <input data-ccbill="postalCode" /> 
    <input data-ccbill="country" /> 
    <input data-ccbill="email" /> 
    <input data-ccbill="cardNumber" /> 
    <input data-ccbill="currencyCode" /> 
    <input data-ccbill="expYear" /> 
    <input data-ccbill="expMonth" /> 
    <input data-ccbill="nameOnCard" /> 
    <input data-ccbill="cvv2" /> 
</form>

2. Generate CCBill OAuth Bearer Token

Frontend Bearer Token

Use your frontend credentials Merchant_ApplicationID:Secret_Key to generate a frontend bearer token. Include this token in the Authorization header of API requests when authenticating customers and creating payment tokens.

Backend Bearer Token

Use your backend credentials Merchant_ApplicationID:Secret_Key to request a backend bearer token. Include this token in the Authorization header of API requests that charge payment tokens to ensure only authorized backend systems can initiate transactions.

Example Request

curl - POST 'https://api.ccbill.com/ccbill-auth/oauth/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Basic Merchant_ApplicationID:Secret_Key ' \
--data-urlencode 'grant_type=client_credentials'

3. Create a Payment Token

Use the frontend bearer token and payment details to request a payment token from CCBill's API.

You can initiate a request to the payment token endpoint by passing the necessary payment details and parameters to the relevant endpoint.

API Endpoint for Creating Payment Tokens

https://api.ccbill.com/payment-tokens/merchant-only-verify

While this step can be completed by making requests directly to our API endpoints, you can also use the CCBill Advanced Widget (JS library) to simplify the integration.

4. Charge Payment Token

After you receive a payment token ID, use it together with the backend bearer token to charge the customer's credit card.

Sending an API request to the /transactions endpoint allows you to charge a payment token or retrieve data on a charge.

Once the payment token has been charged, a webhooks HTTP POST notification will be triggered so that you can capture the transaction information. This webhooks event will be a “UpSaleSuccess”.

API Endpoint for Charging Payment Tokens

https://api.ccbill.com/transactions/payment-tokens/{payment_token_id}

CCBill Advanced Widget

The CCBill Advanced Widget streamlines the frontend integration by handling API calls within a JavaScript function that runs directly on your webpage. Benefits include:

• Seamless Data Collection. Automatically retrieves and validates payment form data.
• Secure Data Handling. Payment details are sent directly to CCBill without passing through your server.
• Strong Customer Authentication (SCA). Customers can complete SCA directly within the browser, ensuring compliance with regulations like PSD2.
• 3DS Verification Support. The widget allows you to check whether 3D Secure (3DS) authentication is required and manipulate payment flows dynamically.

Use the CCBill Advanced Widget to integrate a non-3DS or 3DS payment flow.

Non-3DS Payment Flow

This is the primary method for generating a payment token using the CCBill Advanced Widget.

If you DO NOT require Strong Customer Authentication (SCA) or operate in regions where it is not mandatory, this is the only method you will need to integrate from your JavaScript code.

3DS Payment Flows

3D Secure is one of the most widely used security protocols for strong customer authentication. CCBill has implemented 3DS across its payment systems and is fully compliant with PSD2 regulations.

The CCBill Advanced Widget helps you integrate 3DS into your payment flows and tokenize customer authentication results and payment information.

Select a payment flow that aligns with your business model and planned checkout process, then follow the outlined steps to generate payment tokens using the CCBill Advanced Widget.

Additional Documentation

• CCBill Advanced Widget API Reference
• CCBill RESTful API Resources
• Error Codes