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.


Allocation

Type:  
Abstract:  no
Status:  Active
Java Class:  Allocation
Represents allocations of funds across transactions (for example between payments and invoices).
id
References: Balancing Summary.Id
XML Representation: attribute
Attributes:
Default Value
Identifier of the object used for references; auto-incremented integer value.
targetId
References: Balancing Summary.Target FK
XML Representation: attribute
Attributes:
Default Value
Reference to the entity that represents balancing summary.
createDate
References: Balancing Summary.Create Date
XML Representation: attribute
Attributes:
Default Value
Date when the record was created
isActive
References: Balancing Summary.Is Active
XML Representation: attribute
Attributes:
Default Value
Indicates whether the record is active in the system.
amount
References: Balancing Summary.Amount
XML Representation: attribute
Attributes:
Default Value
The amount element defines the amount of the transaction. Supply the value in cents without a decimal point.
targetTransactionType
References: Balancing Summary.Target FK
XML Representation: attribute
Attributes:
Default Value
Reference to the entity that represents balancing summary.
causeTransactionId
References: Balancing Summary.Cause Transaction Code
XML Representation: attribute
Attributes:
Default Value
causeTransactionType
References: Balancing Summary.Cause Transaction Cl
XML Representation: attribute
Attributes:
Default Value

XML Sample:

<allocation sourceId=""  targetId=""  createDate=""  isActive=""  amount=""  targetTransactionType=""  causeTransactionId=""  causeTransactionType="" />

"<allocation sourceId=\"\" targetId=\"\" createDate=\"\" isActive=\"\" amount=\"\" targetTransactionType=\"\" causeTransactionId=\"\" causeTransactionType=\"\" />"

JSON Sample:

{
  "sourceId": "",
  "targetId": "",
  "createDate": "",
  "isActive": "",
  "amount": "",
  "targetTransactionType": "",
  "causeTransactionId": "",
  "causeTransactionType": ""
}

Query String Sample:

?sourceId=&targetId=&createDate=&isActive=&amount=&targetTransactionType=&causeTransactionId=&causeTransactionType=&
sourceId=
targetId=
createDate=
isActive=
amount=
targetTransactionType=
causeTransactionId=
causeTransactionType=