Billing APIs

Introduction
Billing API is a RESTful API that allows setting up customers, collecting payments and maintaining balances for these customers, as well as creating recurring billing subscriptions.

Billing API documentation includes the following sections:

Objects - lists all recurring billing objects. The purpose of this section is to describe all object fields, their format and usage, provide the links to the corresponding database tables.

Type Enumerations – lists possible values that can be used in the respective fields within Billing API requests and responses. The purpose of this section is to provide an explanation of all enumerations used for API calls.

Actions - lists all actions that can be performed with key recurring billing objects. The purpose of this section is to describe the methods and format of API requests and the format of responses.

Integration Notes – lists integration notes associated with the Billing API objects and actions. The purpose of this section is to provide explicit information about the peculiarities of specific actions and object fields.

Code samples - provides examples of recurring billing use cases (creating billing plans, subscriptions, freeing or canceling subscriptions, reversing transactions, etc) and their implementation in JSON, XML, XURL formats. The purpose of this section is to provide examples that can be used for testing of the integration with the gateway.

To learn how to work with the Billing API, we recommend reviewing the integration notes first. Key recurring billing module terms are available here.
For more detailed information about the recurring billing configurations and management, check the Recurring Billing Guide.


Payment Option Enum   
Amex AC Represents a payment made with an American Express card.
Discover Credit DC Represents a payment made with a Discover credit card.
Discover Debit DD Represents a payment made with a Discover debit card.
MasterCard Credit MC Represents a payment made with a MasterCard credit card.
MasterCard Debit MD Represents a payment made with a MasterCard debit card.
Visa Credit VC Represents a payment made with a Visa credit card.
Visa Debit VD Represents a payment made with a Visa debit card.
Checking BC Represents a payment made using checking account.
Savings BS Represents a payment made using savings account.
Dinners NC Represents a payment made with a Dinners card.
MasterCard Prepaid MP Represents a payment made with a MasterCard prepaid card.
MasterCard Fleet MF Represents a payment made with a MasterCard fleet card.
Visa Prepaid VP Represents a payment made with a Visa prepaid card.
Visa Fleet VS Represents a payment made with a Visa fleet card.
General Gift GG Represents a payment made with a general Gift card.
Fleet One FL Represents a payment made with a fleet one card.
Fuel Man Fleet Wide GF Represents a payment made with a fuel fleet card.
Voyager VF Represents a payment made with a Voyager card.
Wright Express WX Represents a payment made with a Wright Express card.
Bank Card Debit BD Represents a payment made with a bank debit card.
Fuel Lynk FU
China UnionPay Credit UC Indicates that the payment is made with a UnionPay credit card.
China UnionPay Debit UD Indicates that the payment is made with UnionPay debit card.
Food stamp EF
Cash benefit EC