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.

Base Resource URL:

https://[server-name]/api/v01/customers/[customer-id]/[payment-options]/[payment-option-id]

Description:

Provides access to configuration settings for the specified payment option.

Supported Actions:

~load (request)

Method:  GET
Implicit:  Yes
Returns:  PaymentOption
Consumes:  xurl
Produces:  json,xml

Returns configuration settings for the specified payment option.
Path Parameters:
# Name Type Pattern Format Mode Usage Description
1 customer-id Long O Unique Customer ID generated by the system.
For more information see term: Customer.
2 payment-option-id Long R O Unique PaymentOption ID generated by the system.
For more information see term: Payment Option.

~load (response)

Method:  GET
Implicit:  Yes
Returns:  PaymentOption
Consumes:  xurl
Produces:  json,xml

Returns configuration settings for the specified payment option.
Body Parameters:
# Name Type Pattern Format Mode Usage Description
1 cardType String R O Type of the card associated with payment option.
2 countryCode String(3) ALPHA O Country code of the customer's address.
3 token String(50) C O Unique random characters generated by the system for identifying and securely transmitting sensitive data.
4 accountAccessory String(80) NUMERIC R
5 holderName String(150) NAME R The value is a concatenation of the firstName and lastName field values separated by a space.
6 accountNumber String(80) C R
7 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.
8 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.
9 id Long R O Unique PaymentOption ID generated by the system.
For more information see term: Payment Option.
10 tokenCode String(512) R O
11 createDate Datetime R O Date when the record was created.

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.
12 type Enum C O
13 isActive Boolean O
14 csc String NUMERIC O Card security code (CSC) of the customer's card.
15 street1 String(128) STREET O
16 street2 String(128) STREET O
17 city String(50) ALPHANUMERIC_EXTENDED O
18 state String(3) O
19 zipCode String(15) O
20 customerId Long R O Identifier of the customer within the gateway.
21 code String(60) CODE C O Code of Account to which instance of this object is attributed to. Depending on the context, Merchant Account Code field may contain either Merchant Code or Account Code. The field is primarily used for data partitioning and data management, to make it easy to determine the ownership of a record within the database.
22 accountId Integer O
23 address String R O Address associated with a payment card or bank account holder. The value is a concatenation of the street1, street2, city, state, zipCode, countryCode field values separated by commas (,).
24 token String C O Unique random characters (generated by the payment gateway) for identifying and securely transmitting sensitive data.

~modify (request)

Method:  POST
Implicit:  Yes
Returns:  PaymentOption
Consumes:  json,xml
Produces:  json,xml

Updates the selected payment option with the specified values.
Path Parameters:
# Name Type Pattern Format Mode Usage Description
1 customer-id Long O Unique Customer ID generated by the system.
For more information see term: Customer.
2 payment-option-id Long R O Unique PaymentOption ID generated by the system.
For more information see term: Payment Option.
Body Parameters:
# Name Type Pattern Format Mode Usage Description
2 countryCode String(3) ALPHA O Country code of the customer's address.
3 token String(50) C O Unique random characters generated by the system for identifying and securely transmitting sensitive data.
4 accountAccessory String(80) NUMERIC R
5 holderName String(150) NAME R The value is a concatenation of the firstName and lastName field values separated by a space.
6 accountNumber String(80) C R
12 type Enum C O
13 isActive Boolean O
14 csc String NUMERIC O Card security code (CSC) of the customer's card.
15 street1 String(128) STREET O
16 street2 String(128) STREET O
17 city String(50) ALPHANUMERIC_EXTENDED O
18 state String(3) O
19 zipCode String(15) O
21 code String(60) CODE C O Code of Account to which instance of this object is attributed to. Depending on the context, Merchant Account Code field may contain either Merchant Code or Account Code. The field is primarily used for data partitioning and data management, to make it easy to determine the ownership of a record within the database.
22 accountId Integer O
24 token String C O Unique random characters (generated by the payment gateway) for identifying and securely transmitting sensitive data.

~modify (response)

Method:  POST
Implicit:  Yes
Returns:  PaymentOption
Consumes:  json,xml
Produces:  json,xml

Updates the selected payment option with the specified values.
Body Parameters:
# Name Type Pattern Format Mode Usage Description
1 cardType String R O Type of the card associated with payment option.
2 countryCode String(3) ALPHA O Country code of the customer's address.
3 token String(50) C O Unique random characters generated by the system used for filtering PaymentOption records.
4 accountAccessory String(80) NUMERIC R
5 holderName String(150) NAME R The value is a concatenation of the firstName and lastName field values separated by a space.
6 accountNumber String(80) C R
7 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.
8 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.
9 id Long R O Unique PaymentOption ID generated by the system.
For more information see term: Payment Option.
10 tokenCode String(512) R O
11 createDate Datetime R O Date when the record was created.

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.
12 type Enum C O
13 isActive Boolean O
14 csc String NUMERIC O Card security code (CSC) of the customer's card.
15 street1 String(128) STREET O
16 street2 String(128) STREET O
17 city String(50) ALPHANUMERIC_EXTENDED O
18 state String(3) O
19 zipCode String(15) O
20 customerId Long R O Identifier of the customer within the gateway.
21 code String(60) CODE C O Code of Account to which instance of this object is attributed to. Depending on the context, Merchant Account Code field may contain either Merchant Code or Account Code. The field is primarily used for data partitioning and data management, to make it easy to determine the ownership of a record within the database.
22 accountId Integer O
23 address String R O Address associated with a payment card or bank account holder. The value is a concatenation of the street1, street2, city, state, zipCode, countryCode field values separated by commas (,).
24 token String C O Unique random characters (generated by the payment gateway) for identifying and securely transmitting sensitive data.

~process (request)

Method:  POST
Implicit:  No
Returns:  Transaction
Consumes:  json,xml
Produces:  json,xml

Creates and processes a transaction based on the specified payment option.
Path Parameters:
# Name Type Pattern Format Mode Usage Description
1 customer-id Long O Unique Customer ID generated by the system.
For more information see term: Customer.
2 payment-option-id Long R O Unique PaymentOption ID generated by the system.
For more information see term: Payment Option.
Body Parameters:
# Name Type Pattern Format Mode Usage Description
1 code String CODE C O Unique ProcessingRequest 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.
3 feeAmount Integer O Fee amount (in cents) that will be associated with the transaction processing.
4 holderName String(150) NAME C 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.
5 taxAmount Integer O
6 dueDate Date C O Date when the ProcessingRequest is expected to be completed.
7 invoiceList String(250) NUMERIC O List of invoice references that are expected to be covered by this transaction.
8 accountData String C O The date must be submitted in yyyy-MM-dd format.
9 accountAccessory String NUMERIC C O
10 accountNumber String C O
11 token String(512) TOKEN C O
12 csc String NUMERIC C O
13 street String(128) STREET C O
14 city String(50) ALPHANUMERIC_EXTENDED C O
15 state String(3) C O
16 zipCode String(15) C O
17 phone String(20) NUMERIC C O
18 email String(100) EMAIL C O
19 dueDate Date C O The date must be submitted in yyyy-MM-dd format.
20 type Enum C O
21 accountType Enum C O
22 creatorCode String(60) CODE C O
23 amount Integer R
24 note String(255) TEXT C O
25 accountId Integer O
26 countryCode String(3) ALPHA C O
27 code String CODE C O
28 feeAmount Integer O

~process (response)

Method:  POST
Implicit:  No
Returns:  Transaction
Consumes:  json,xml
Produces:  json,xml

Creates and processes a transaction based on the specified payment option.
Body Parameters:
# Name Type Pattern Format Mode Usage Description
1 feeAmount Integer O Fee amount used for filtering Transaction records.
2 taxAmount Integer O
3 adjustmentId Long R O Identifier of an Adjustment that a Transaction is associated with.
4 balance Integer R O Current balance of the Transaction.
5 createDate Datetime R O Date when the Transaction was created.
Note: Date format: yyyy-MM-dd.
6 id Long R O Unique Transaction ID generated by the system.
7 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.
7.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.
7.2 accountNumber String R O Number of a payment card or bank account.
7.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.
7.4 approvalCode String(60) R O Code of the approval status of the transaction provided by the payment provider.
7.5 city String(50) R O City of the Customer.
7.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.7 email String(100) R O Email address of the Customer.
7.8 gatewayTransactionId String(20) R O Identifier of a Transaction (Processing) that the current transaction is associated with.
7.9 holderName String(150) R O Combined values fo the firsetName and lastName in the Customer.
7.10 id Long R O Unique ProcesingInfo ID generated by the system.
7.11 phone String(20) R O Phone number of the Customer.
7.12 responseCode String(3) R O Code providing an explanation of the outcome of the request.
For more information see UniPay Codes & Code Mapping.
7.13 responseDate Datetime R O Date when the response to the transaction was received.
7.14 responseMessage String(255) R O Response details associated with a processing request, generated by the gateway.
7.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.
7.16 street String(128) R O Street address of the Customer.
7.17 token String(512) R O Unique random characters generated by the system for identifying and securely transmitting sensitive data.
7.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.
7.19 id Long R O
7.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.
7.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.
7.22 accountNumber String R O
7.23 accountAccessory String R O
7.24 token String(512) R O
7.25 street String(128) R O
7.26 city String(50) R O
7.27 state String(3) R O
7.28 zipCode String(15) R O
7.29 phone String(20) R O
7.30 email String(100) R O
7.31 gatewayTransactionId String(20) R O
7.32 approvalCode String(60) R O
7.33 responseDate Datetime R O In API response, the date is returned in yyyy-MM-dd HH:mm:ss format.
7.34 responseCode String(3) R O
7.35 responseMessage String(255) R O
7.36 address String R O
8 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.
9 invoiceList String(250) NUMERIC O List of invoice references used for filtering records.
10 id Long R O
11 accountId Integer O
12 customerId Long O
13 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.
14 dueDate Date C O The date must be submitted in yyyy-MM-dd format.
15 type Enum R
16 amount Integer C R
17 balance Integer R O
18 note String(255) TEXT C O
19 accountType Enum O
20 accountNumber String(19) C O
21 creatorCode String(60) CODE C O
22 processingInfo ProcessingInfo R O
22.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.
22.2 accountNumber String R O Number of a payment card or bank account.
22.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.
22.4 approvalCode String(60) R O Code of the approval status of the transaction provided by the payment provider.
22.5 city String(50) R O City of the Customer.
22.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.
22.7 email String(100) R O Email address of the Customer.
22.8 gatewayTransactionId String(20) R O Identifier of a Transaction (Processing) that the current transaction is associated with.
22.9 holderName String(150) R O Combined values fo the firsetName and lastName in the Customer.
22.10 id Long R O Unique ProcesingInfo ID generated by the system.
22.11 phone String(20) R O Phone number of the Customer.
22.12 responseCode String(3) R O Code providing an explanation of the outcome of the request.
For more information see UniPay Codes & Code Mapping.
22.13 responseDate Datetime R O Date when the response to the transaction was received.
22.14 responseMessage String(255) R O Response details associated with a processing request, generated by the gateway.
22.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.
22.16 street String(128) R O Street address of the Customer.
22.17 token String(512) R O Unique random characters generated by the system for identifying and securely transmitting sensitive data.
22.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.
22.19 id Long R O
22.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.
22.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.22 accountNumber String R O
22.23 accountAccessory String R O
22.24 token String(512) R O
22.25 street String(128) R O
22.26 city String(50) R O
22.27 state String(3) R O
22.28 zipCode String(15) R O
22.29 phone String(20) R O
22.30 email String(100) R O
22.31 gatewayTransactionId String(20) R O
22.32 approvalCode String(60) R O
22.33 responseDate Datetime R O In API response, the date is returned in yyyy-MM-dd HH:mm:ss format.
22.34 responseCode String(3) R O
22.35 responseMessage String(255) R O
22.36 address String R O
23 code String(60) CODE C O
24 adjustmentId Long R O
25 subscriptionId Long R O
26 feeAmount Integer O
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.