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 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.
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 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 information associated with the merchant.
| # | Name | Type | Pattern | Format | Mode | Usage | Description |
|---|---|---|---|---|---|---|---|
| 1 | countryCode | String(3) |
ALPHA | O | Country code of the Customer. | ||
| 2 | token | String(50) |
C | O | Unique random characters generated by the system for identifying and securely transmitting sensitive data. | ||
| 3 | accountAccessory | String(80) |
NUMERIC | R | Card expiration date or bank routing number. | ||
| 4 | holderName | String(150) |
NAME | R | The value is a concatenation of the firstName and lastName field values separated by a space. | ||
| 5 | address | String |
R | O | Combined address field of the customer. Note: The value is a comma separated concatenation of the street1, street2, city, state, zipCode, countryCode field values. |
||
| 6 | createDate | Datetime |
R | O | Date when the PaymentOption was created. Note: In API request, the date must be submitted in yyyy-MM-dd format. In API response, the date is returned in yyyy-MM-dd HH:mm:ss format. |
||
| 7 | id | Long |
R | O | Unique PaymentOption ID generated by the system. For more information see term: Payment Option. |
||
| 8 | tokenCode | String(512) |
R | O | Code of the token associated with the particular payment option. | ||
| 9 | createDate | Datetime |
R | O | Date when the PaymentOption was created. Note: In API request, the date must be submitted in yyyy-MM-dd format. In API response, the date is returned in yyyy-MM-dd HH:mm:ss format. |
||
| 10 | type | Enum | C | O | Type of a Payment Option. | ||
| 11 | isActive | Boolean |
O | Status of the PaymentOption. Note: Values: true (active) or false (inactive). |
|||
| 12 | csc | String |
NUMERIC | O | CVV2 security code of the credit card used for the transaction processing. | ||
| 13 | street1 | String(128) |
STREET | O | Street address of the Customer. | ||
| 14 | street2 | String(128) |
STREET | O | Secondary street address of the Customer. Note: Additional street data such as appartment or suite number. |
||
| 15 | city | String(50) |
ALPHANUMERIC_EXTENDED | O | City of the Customer. | ||
| 16 | state | String(3) |
O | State of the Customer. Note: State value format is subject to the associated country code in the Customer object. |
|||
| 17 | zipCode | String(15) |
O | ZIP/postal code of the Customer. Note: ZipCode value format is subject to the associated country code in the Customer object. |
|||
| 18 | customerId | Long | R | O | Identifier of a Customer that a PaymentOption is associated with. | ||
| 19 | code | String(60) |
CODE | C | O | Unique PaymentOption ID supplied by external/user's system. Note: Optional secondary identifier. Typically this field is a reference to an ID in your own system to cross-reference it within our system. If not provided, the system will use the object 'id' generated at the time of object creation. For more information see Reference Field Type. |
|
| 20 | accountId | Integer |
O | Merchant account associated with PaymentOption. Note: If your API user is associated to more than one merchant account or group of merchant accounts, you can specify the merchant account ID for the ~find operation to reduce the data set in the API response. Your API credentials may be associated with more than one accountId. |
|||
| 21 | address | String |
R | O | Combined address field of the customer. Note: The value is a comma separated concatenation of the street1, street2, city, state, zipCode, countryCode field values. |
||
| 22 | token | String | C | O | Unique random characters generated by the system for identifying and securely transmitting sensitive data. | ||
| 23 | state | String(3) |
ALPHA | O | State of the Customer. Note: State value format is subject to the associated country code in the Customer object. |
||
| 24 | zipCode | String(15) |
ALPHANUMERIC_EXTENDED | O | ZIP/postal code of the Customer. Note: ZipCode value format is subject to the associated country code in the Customer object. |
||
| 25 | tokenCode | String(512) |
ALPHANUMERIC_EXTENDED | R | O | Code of the token associated with the particular payment option. | |
| 26 | token | String | TOKEN | C | O | Unique random characters generated by the system for identifying and securely transmitting sensitive data. | |
| 27 | accountNumber | String(80) |
C | R | Number of a payment card or bank account. |
XML Sample:
<payment-option countryCode="" token="" accountAccessory="" holderName="" address="" createDate="" id="" tokenCode="" createDate="" type="" isActive="" csc="" street1="" street2="" city="" state="" zipCode="" customerId="" code="" accountId="" address="" token="" state="" zipCode="" tokenCode="" token="" accountNumber="" />
JSON Sample:
{ "countryCode": "", "token": "", "accountAccessory": "", "holderName": "", "address": "", "createDate": "", "id": "", "tokenCode": "", "type": "", "isActive": "", "csc": "", "street1": "", "street2": "", "city": "", "state": "", "zipCode": "", "customerId": "", "code": "", "accountId": "", "accountNumber": "" }
XURL Sample:
?countryCode=&token=&accountAccessory=&holderName=&address=&createDate=&id=&tokenCode=&createDate=&type=&isActive=&csc=&street1=&street2=&city=&state=&zipCode=&customerId=&code=&accountId=&address=&token=&state=&zipCode=&tokenCode=&token=&accountNumber=&
countryCode=
token=
accountAccessory=
holderName=
address=
createDate=
id=
tokenCode=
createDate=
type=
isActive=
csc=
street1=
street2=
city=
state=
zipCode=
customerId=
code=
accountId=
address=
token=
state=
zipCode=
tokenCode=
token=
accountNumber=
countryCode=
token=
accountAccessory=
holderName=
address=
createDate=
id=
tokenCode=
createDate=
type=
isActive=
csc=
street1=
street2=
city=
state=
zipCode=
customerId=
code=
accountId=
address=
token=
state=
zipCode=
tokenCode=
token=
accountNumber=