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.

ProcessingInfo

Type:  
Abstract:  no
Status:  Active
Java Class:  CaptureInfo
Information associated with transaction processing within internal and external systems.

Available Fields:

# Name Type Pattern Format Mode Usage Description
1 accountAccessory String R O Card expiration date or bank routing number.
Note: This field is required even if it is used with a token.
2 accountNumber String R O Number of a payment card or bank account.
3 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.
4 approvalCode String(60) R O Code of the approval status of the transaction provided by the payment provider.
5 city String(50) R O City of the Customer.
6 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.
7 email String(100) R O Email address of the Customer.
8 gatewayTransactionId String(20) R O Identifier of a Transaction (Processing) that the current transaction is associated with.
9 holderName String(150) R O Combined values fo the firsetName and lastName in the Customer.
10 id Long R O Unique ProcesingInfo ID generated by the system.
11 phone String(20) R O Phone number of the Customer.
12 responseCode String(3) R O Code providing an explanation of the outcome of the request.
For more information see UniPay Codes & Code Mapping.
13 responseDate Datetime R O Date when the response to the transaction was received.
14 responseMessage String(255) R O Response details associated with a processing request, generated by the gateway.
15 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 street String(128) R O Street address of the Customer.
17 token String(512) R O Unique random characters generated by the system for identifying and securely transmitting sensitive data.
18 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.
19 id Long R O
20 createDate Datetime R O 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.
21 holderName String(150) R O 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.
22 accountNumber String R O
23 accountAccessory String R O
24 token String(512) R O
25 street String(128) R O
26 city String(50) R O
27 state String(3) R O
28 zipCode String(15) R O
29 phone String(20) R O
30 email String(100) R O
31 gatewayTransactionId String(20) R O
32 approvalCode String(60) R O
33 responseDate Datetime R O In API response, the date is returned in yyyy-MM-dd HH:mm:ss format.
34 responseCode String(3) R O
35 responseMessage String(255) R O
36 address String R O

XML Sample:

<processing-info
    accountAccessory="" 
    accountNumber="" 
    address="" 
    approvalCode="" 
    city="" 
    createDate="" 
    email="" 
    gatewayTransactionId="" 
    holderName="" 
    id="" 
    phone="" 
    responseCode="" 
    responseDate="" 
    responseMessage="" 
    state="" 
    street="" 
    token="" 
    zipCode="" 
    id="" 
    createDate="" 
    holderName="" 
    accountNumber="" 
    accountAccessory="" 
    token="" 
    street="" 
    city="" 
    state="" 
    zipCode="" 
    phone="" 
    email="" 
    gatewayTransactionId="" 
    approvalCode="" 
    responseDate="" 
    responseCode="" 
    responseMessage="" 
    address="" />

JSON Sample:

{
  "accountAccessory": "",
  "accountNumber": "",
  "address": "",
  "approvalCode": "",
  "city": "",
  "createDate": "",
  "email": "",
  "gatewayTransactionId": "",
  "holderName": "",
  "id": "",
  "phone": "",
  "responseCode": "",
  "responseDate": "",
  "responseMessage": "",
  "state": "",
  "street": "",
  "token": "",
  "zipCode": ""
}

XURL Sample:

?accountAccessory=&accountNumber=&address=&approvalCode=&city=&createDate=&email=&gatewayTransactionId=&holderName=&id=&phone=&responseCode=&responseDate=&responseMessage=&state=&street=&token=&zipCode=&id=&createDate=&holderName=&accountNumber=&accountAccessory=&token=&street=&city=&state=&zipCode=&phone=&email=&gatewayTransactionId=&approvalCode=&responseDate=&responseCode=&responseMessage=&address=&
accountAccessory=
accountNumber=
address=
approvalCode=
city=
createDate=
email=
gatewayTransactionId=
holderName=
id=
phone=
responseCode=
responseDate=
responseMessage=
state=
street=
token=
zipCode=
id=
createDate=
holderName=
accountNumber=
accountAccessory=
token=
street=
city=
state=
zipCode=
phone=
email=
gatewayTransactionId=
approvalCode=
responseDate=
responseCode=
responseMessage=
address=
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.