This document outlines the resources, endpoints, and objects of the CCBill RESTful API service. It is intended for programmers, technicians, and others with advanced coding skills.
Use this comprehensive list to determine what parameters are required for endpoint requests and which parameters are returned as responses.
For detailed instructions on integrating CCBill's RESTful API, read our RESTful API payment flow guide.
Note: The API does not support bulk requests.
The CCBill RESTful API uses OAuth-based authentication and authorization. Once you receive the MerchantApplicationID and SecretKey from CCBill Merchant Support, use them to generate the CCBill Oauth Bearer Token (access token).
This step cannot be done from within the browser. You must make the call from your backend.
Place the generated CCBill OAuth token in the Authorization header of each API request.
Each API request made to the CCBill RESTful API needs to be sent to the correct API server and API endpoint. The API base URL is https://api.ccbill.com and it provides the endpoints listed below.
CBill's RESTful API uses Media Type Versioning to specify the API version and media type. You can explicitly request a specific API version by including the desired media type in the Accept header of your requests.
To request the latest version of the API, include the following in the request headers:
Accept: application/vnd.mcn.transaction-service.api.v.2+jsonAll API request and response examples in this guide use the latest version header. Check the headers in each example to ensure it is compatible with your implementation.
The CCBill RESTful API uses conventional HTTP response codes to indicate whether an API request was successful or has failed. The code ranges indicate the following:
2xx. A successful API request HTTP response code.4xx. Failure due to request information.5xx. Error due to an unexpected issue.Visit the Error Codes page for a comprehensive list of API errors.
Support
API Support: merchantsupport@ccbill.com