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.


ProcessingRequest

Type:  
Abstract:  no
Status:  Active
Java Class:  ProcessingRequest
Represents information included in processing request sent to a processor.
holderName
References: Capture Info.Holder Name
XML Representation: attribute
Attributes:
Default Value
Name of bank account or credit card holder.

Name of a payment card or bank account holder. The value is a concatenation of the firstName and lastName field values separated by a space.
accountData
References: Capture Info.Track Data
XML Representation: attribute
Attributes:
Default Value
The date must be submitted in yyyy-MM-dd format.
accountNumber
References: Capture Info.Account Number
XML Representation: attribute
Attributes:
Default Value
Encoded credit card number or bank account number.
accountAccessory
References: Capture Info.Accessory
XML Representation: attribute
Attributes:
Default Value
Expiration date of the card or bank routing number.
token
References: Capture Info.Token Code
XML Representation: attribute
Attributes:
Default Value
Token generated for the provided payment information.
csc
References: Capture Info.CVV2
XML Representation: attribute
Attributes:
Default Value
CVV2 security code of the credit card.
street
References: Capture Info.Street
XML Representation: attribute
Attributes:
Default Value
Street mailing address of the cardholder.
city
References: Capture Info.City
XML Representation: attribute
Attributes:
Default Value
City mailing address of the cardholder.
state
References: Capture Info.State
XML Representation: attribute
Attributes:
Default Value
State mailing address of the cardholder.
zipCode
References: Capture Info.ZIP Code
XML Representation: attribute
Attributes:
Default Value
ZIP/postal code of mailing address of the cardholder.
phone
References: Capture Info.Phone
XML Representation: attribute
Attributes:
Default Value
Phone number associated with mailing address of the cardholder.
email
References: Capture Info.Email
XML Representation: attribute
Attributes:
Default Value
Email address associated with the cardholder.
dueDate
Type: Datetime
XML Representation: attribute
Attributes:
Default Value
The date must be submitted in yyyy-MM-dd format.
type
References: Account Activity.Account Activity CL
XML Representation: attribute
Attributes:
Default Value
Represents the type of account activity.
accountType
References: Asset Transaction.Transaction CL
XML Representation: attribute
Attributes:
Default Value
Enumeration of possible asset transaction processing modes available in the system.
creatorCode
References: Account Transaction.Ref Creator Code
XML Representation: attribute
Attributes:
Default Value
Code of the user that created the account transaction.
amount
References: Account Transaction.Amount
XML Representation: attribute
Attributes: Required
Default Value
Amount of the transaction in cents (without a decimal point).
note
References: Account Transaction.Note
XML Representation: attribute
Attributes:
Default Value
Description of the transaction.

XML Sample:

<processing-request
    holderName="" 
    accountData="" 
    accountNumber="" 
    accountAccessory="" 
    token="" 
    csc="" 
    street="" 
    city="" 
    state="" 
    zipCode="" 
    phone="" 
    email="" 
    dueDate="" 
    type="" 
    accountType="" 
    creatorCode="" 
    amount="" 
    note="" />

"<processing-request holderName=\"\" accountData=\"\" accountNumber=\"\" accountAccessory=\"\" token=\"\" csc=\"\" street=\"\" city=\"\" state=\"\" zipCode=\"\" phone=\"\" email=\"\" dueDate=\"\" type=\"\" accountType=\"\" creatorCode=\"\" amount=\"\" note=\"\" />"

JSON Sample:

{
  "holderName": "",
  "accountData": "",
  "accountNumber": "",
  "accountAccessory": "",
  "token": "",
  "csc": "",
  "street": "",
  "city": "",
  "state": "",
  "zipCode": "",
  "phone": "",
  "email": "",
  "dueDate": "",
  "type": "",
  "accountType": "",
  "creatorCode": "",
  "amount": "",
  "note": ""
}

Query String Sample:

?holderName=&accountData=&accountNumber=&accountAccessory=&token=&csc=&street=&city=&state=&zipCode=&phone=&email=&dueDate=&type=&accountType=&creatorCode=&amount=&note=&
holderName=
accountData=
accountNumber=
accountAccessory=
token=
csc=
street=
city=
state=
zipCode=
phone=
email=
dueDate=
type=
accountType=
creatorCode=
amount=
note=