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.

Transaction

Type:  
Abstract:  no
Status:  Active
Java Class:  AccountTransaction
Represents a transaction associated with a particular merchant.

Available Fields:

# Name Type Pattern Format Mode Usage Description
1 taxAmount Integer O Tax amount in cents.
2 adjustmentId Long R O Identifier of an Adjustment that a Transaction is associated with.
3 invoiceList String(250) NUMERIC O List of invoice references that are expected to be covered by this transaction.
4 id Long R O Unique Transaction ID generated by the system.
5 accountId Integer O
6 customerId Long O
7 createDate Datetime R O Date when the Transaction was created.
Note: Date format: yyyy-MM-dd.
8 dueDate Date C O The date must be submitted in yyyy-MM-dd format.
9 type Enum R
10 amount Integer C R
11 balance Integer R O Current balance of the Transaction.
12 note String(255) TEXT C O
13 accountType Enum O
14 accountNumber String(19) C O
15 creatorCode String(60) CODE C O
16 processingInfo ProcessingInfo R O Information associated with a processing of the transaction.
Note: This field only is included in a transaction record if the transaction has been processed.
16.1 city String(50) R O City of the Customer.
16.2 createDate Datetime R O Date when the ProcessingInfo 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.
16.3 id Long R O Unique ProcesingInfo ID generated by the system.
16.4 createDate Datetime R O Date when the ProcessingInfo 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.
16.5 holderName String(150) R O Combined values fo the firsetName and lastName in the Customer.
16.6 accountNumber String R O Number of a payment card or bank account.
16.7 accountAccessory String R O
16.8 token String(512) R O Unique random characters generated by the system for identifying and securely transmitting sensitive data.
16.9 street String(128) STREET R O Street address of the Customer.
16.10 state String(3) R O State of the Customer.
Note: State value format is subject to the associated country code in the Customer object.
16.11 zipCode String(15) R O ZIP/postal code of the Customer.
Note: ZipCode value format is subject to the associated country code in the Customer object.
16.12 phone String(20) R O Phone number of the Customer.
16.13 email String(100) R O Email address of the Customer.
16.14 gatewayTransactionId String(20) R O Identifier of a Transaction (Processing) that the current transaction is associated with.
16.15 approvalCode String(60) R O Code of the approval status of the transaction provided by the payment provider.
16.16 responseDate Datetime R O Date when the response to the transaction was received.
16.17 responseCode String(3) R O Code providing an explanation of the outcome of the request.
For more information see UniPay Codes & Code Mapping.
16.18 responseMessage String(255) R O Response details associated with a processing request, generated by the gateway.
16.19 address String R O Combined address field of the Customer object.
Note: The value is a comma separated concatenation of the street1, street2, city, state, zipCode, countryCode field values.
16.20 accountAccessory String NUMERIC R O Card expiration date or bank routing number.
Note: This field is required even if it is used with a token.
16.21 accountNumber String NUMERIC O Number of a payment card or bank account.
16.22 approvalCode String(60) NUMERIC R O Code of the approval status of the transaction provided by the payment provider.
16.23 city String(50) ALPHANUMERIC_EXTENDED R O City of the Customer.
16.24 email String(100) EMAIL R O Email address of the Customer.
16.25 phone String(20) NUMERIC R O Phone number of the Customer.
16.26 responseCode String(3) CODE R O Code providing an explanation of the outcome of the request.
For more information see UniPay Codes & Code Mapping.
16.27 responseMessage String(255) ALPHANUMERIC_EXTENDED R O Response details associated with a processing request, generated by the gateway.
16.28 state String(3) ALPHA R O State of the Customer.
Note: State value format is subject to the associated country code in the Customer object.
16.29 token String(512) TOKEN R O Unique random characters generated by the system for identifying and securely transmitting sensitive data.
16.30 zipCode String(15) ALPHANUMERIC_EXTENDED R O ZIP/postal code of the Customer.
Note: ZipCode value format is subject to the associated country code in the Customer object.
17 code String(60) CODE C O
18 subscriptionId Long R O Identifier of a Subscription that a Transaction is associated with.
Used for transactions of type: RI - Invoice.
Note: when the Invoice transaction is created based on a subscription.
For more information see Account Activity Classifier.
19 feeAmount Integer O Fee amount (in cents) associated with the transaction processing.

XML Sample:

<transaction
    taxAmount="" 
    adjustmentId="" 
    invoiceList="" 
    id="" 
    accountId="" 
    customerId="" 
    createDate="" 
    dueDate="" 
    type="" 
    amount="" 
    balance="" 
    note="" 
    accountType="" 
    accountNumber="" 
    creatorCode="" 
    <processingInfo
        city="" 
        createDate="" 
        id="" 
        createDate="" 
        holderName="" 
        accountNumber="" 
        accountAccessory="" 
        token="" 
        street="" 
        state="" 
        zipCode="" 
        phone="" 
        email="" 
        gatewayTransactionId="" 
        approvalCode="" 
        responseDate="" 
        responseCode="" 
        responseMessage="" 
        address="" 
        accountAccessory="" 
        accountNumber="" 
        approvalCode="" 
        city="" 
        email="" 
        phone="" 
        responseCode="" 
        responseMessage="" 
        state="" 
        token="" 
        zipCode="" />
    state="" 
    city="" 
    zipCode="" 
    phone="" 
    email="" 
    gatewayTransactionId="" 
    approvalCode="" 
    responseDate="" 
    responseCode="" 
    responseMessage="" 
    address="" 
    createDate="" 
    accountAccessory="" 
    accountNumber="" 
    approvalCode="" 
    city="" 
    email="" 
    phone="" 
    responseCode="" 
    responseMessage="" 
    state="" 
    token="" 
    zipCode="" 
    id="" 
    createDate="" 
    holderName="" 
    accountNumber="" 
    accountAccessory="" 
    token="" 
    street="" 
    code="" 
    subscriptionId="3271" 
    feeAmount="" 
</transaction>

JSON Sample:

{
  "taxAmount": "",
  "adjustmentId": "",
  "invoiceList": "",
  "id": "",
  "accountId": "",
  "customerId": "",
  "createDate": "",
  "dueDate": "",
  "type": "",
  "amount": "",
  "balance": "",
  "note": "",
  "accountType": "",
  "accountNumber": "",
  "creatorCode": "",
  "processingInfo": {
    "city": "",
    "createDate": "",
    "id": "",
    "holderName": "",
    "accountNumber": "",
    "accountAccessory": "",
    "token": "",
    "street": "",
    "state": "",
    "zipCode": "",
    "phone": "",
    "email": "",
    "gatewayTransactionId": "",
    "approvalCode": "",
    "responseDate": "",
    "responseCode": "",
    "responseMessage": "",
    "address": ""
  },
  "state": "",
  "city": "",
  "zipCode": "",
  "phone": "",
  "email": "",
  "gatewayTransactionId": "",
  "approvalCode": "",
  "responseDate": "",
  "responseCode": "",
  "responseMessage": "",
  "address": "",
  "accountAccessory": "",
  "token": "",
  "holderName": "",
  "street": "",
  "code": "",
  "subscriptionId": 3271,
  "feeAmount": ""
}

XURL Sample:

?taxAmount=&adjustmentId=&invoiceList=&id=&accountId=&customerId=&createDate=&dueDate=&type=&amount=&balance=&note=&accountType=&accountNumber=&creatorCode=&processingInfo.city=&processingInfo.createDate=&processingInfo.id=&processingInfo.createDate=&processingInfo.holderName=&processingInfo.accountNumber=&processingInfo.accountAccessory=&processingInfo.token=&processingInfo.street=&processingInfo.state=&processingInfo.zipCode=&processingInfo.phone=&processingInfo.email=&processingInfo.gatewayTransactionId=&processingInfo.approvalCode=&processingInfo.responseDate=&processingInfo.responseCode=&processingInfo.responseMessage=&processingInfo.address=&processingInfo.accountAccessory=&processingInfo.accountNumber=&processingInfo.approvalCode=&processingInfo.city=&processingInfo.email=&processingInfo.phone=&processingInfo.responseCode=&processingInfo.responseMessage=&processingInfo.state=&processingInfo.token=&processingInfo.zipCode=&state=&city=&zipCode=&phone=&email=&gatewayTransactionId=&approvalCode=&responseDate=&responseCode=&responseMessage=&address=&createDate=&accountAccessory=&accountNumber=&approvalCode=&city=&email=&phone=&responseCode=&responseMessage=&state=&token=&zipCode=&id=&createDate=&holderName=&accountNumber=&accountAccessory=&token=&street=&code=&subscriptionId=3271&feeAmount=&
taxAmount=
adjustmentId=
invoiceList=
id=
accountId=
customerId=
createDate=
dueDate=
type=
amount=
balance=
note=
accountType=
accountNumber=
creatorCode=
processingInfo.city=
processingInfo.createDate=
processingInfo.id=
processingInfo.createDate=
processingInfo.holderName=
processingInfo.accountNumber=
processingInfo.accountAccessory=
processingInfo.token=
processingInfo.street=
processingInfo.state=
processingInfo.zipCode=
processingInfo.phone=
processingInfo.email=
processingInfo.gatewayTransactionId=
processingInfo.approvalCode=
processingInfo.responseDate=
processingInfo.responseCode=
processingInfo.responseMessage=
processingInfo.address=
processingInfo.accountAccessory=
processingInfo.accountNumber=
processingInfo.approvalCode=
processingInfo.city=
processingInfo.email=
processingInfo.phone=
processingInfo.responseCode=
processingInfo.responseMessage=
processingInfo.state=
processingInfo.token=
processingInfo.zipCode=
state=
city=
zipCode=
phone=
email=
gatewayTransactionId=
approvalCode=
responseDate=
responseCode=
responseMessage=
address=
createDate=
accountAccessory=
accountNumber=
approvalCode=
city=
email=
phone=
responseCode=
responseMessage=
state=
token=
zipCode=
id=
createDate=
holderName=
accountNumber=
accountAccessory=
token=
street=
code=
subscriptionId=3271
feeAmount=
Copyright © United Thinkers. (UniPay - Payment Gateway Software)
All Logos and Trademarks used or mentioned on this page are copyrighted property of their respective owners and are used for display purposes only.