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

Description:

Provides access to customers registered within the system.

Supported sub-resources:

Resource URL Description
https://[server-name]/api/v01/customers/[customer-id] Provides access to configuration settings for the specified customer.

Supported Actions:

~create (request)

Method:  PUT
Implicit:  Yes
Returns:  Customer
Consumes:  json,xml
Produces:  json,xml

Create customer records to establish billing profiles for your subscription services. A customer record serves as the foundation for recurring billing operations.\n\r\n> **Note:** Customer records include basic information such as the name and address, which connect to payment options and subscription plans.\n\r\n> **Warning:** Create customer records only if you intend to use the Recurring Billing API. Do not create Customers for non-recurring transactions processed through the Transaction API.\n\r\n> **Tip:** Customers can be associated with multiple payment methods and subscription plans, enabling the creation of flexible recurring billing models for your platform.
Body Parameters:
# Name Type Pattern Format Mode Usage Description
1 phone String NUMERIC R Phone number of the Customer.
2 street1 String(128) STREET O Street address of the Customer.
3 street2 String(128) STREET O Secondary Street address of the Customer.
Note: Additional street data such as appartment or suite number.
4 organizationName String(255) NAME_BUSINESS O Name of the associated organization for the Customer.
Note: OrganizationName is a user provided freeform field and does not represent any other data structure or object.
5 email String(100) EMAIL O Email address of the Customer.
11 code String(60) CODE C O Unique Customer 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.
12 accountId Integer C R Merchant account associated with Customer.
Note: If your API user is associated to more than one merchant account or group of merchant accounts, you can specify the merchant account ID for the ~find operation to reduce the data set in the API response.

Your API credentials may be associated with more than one accountId.
14 firstName String(125) NAME R First name of the Customer.
15 lastName String(125) NAME R Last name of the Customer.
16 email String EMAIL O Email address of the Customer.
17 isActive Boolean O Status of the Customer.
Note: Values: true (active) or false (inactive).
19 city String(50) ALPHANUMERIC_EXTENDED O City of the Customer.
20 countryCode String(2) ALPHA O Country code of the Customer.
21 state String(3) O State of the Customer.
Note: State value format is subject to the associated country code in the Customer object.
22 zipCode String(10) O ZIP/postal code of the Customer.
Note: ZipCode value format is subject to the associated country code in the Customer object.
25 state String(3) ALPHA O State of the Customer.
Note: State value format is subject to the associated country code in the Customer object.
26 zipCode String(10) ALPHANUMERIC_EXTENDED O ZIP/postal code of the Customer.
Note: ZipCode value format is subject to the associated country code in the Customer object.

~create (response)

Method:  PUT
Implicit:  Yes
Returns:  Customer
Consumes:  json,xml
Produces:  json,xml

Create customer records to establish billing profiles for your subscription services. A customer record serves as the foundation for recurring billing operations.\n\r\n> **Note:** Customer records include basic information such as the name and address, which connect to payment options and subscription plans.\n\r\n> **Warning:** Create customer records only if you intend to use the Recurring Billing API. Do not create Customers for non-recurring transactions processed through the Transaction API.\n\r\n> **Tip:** Customers can be associated with multiple payment methods and subscription plans, enabling the creation of flexible recurring billing models for your platform.
Body Parameters:
# Name Type Pattern Format Mode Usage Description
1 phone String NUMERIC R Phone number of the Customer used for filtering Customer records.
2 street1 String(128) STREET O Street address of the Customer used for filtering Customer records.
3 street2 String(128) STREET O Street address of the Customer used for filtering Customer records.
4 organizationName String(255) NAME_BUSINESS O Name of the organization used for filtering Customer records.
5 email String(100) EMAIL O Email address of the Customer used for filtering Customer records.
6 holderName String(500) R O Combined values of the firstName and lastName in the Customer.
Note: This value is a concatenation of the firstName and lastName values provided at the time of Customer creation or modification.
7 createDate Datetime R O Date when the Customer was created.
Note: Date format: yyyy-MM-dd.
8 address String(321) 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.
9 balance Integer R O Current balance of the Customer.
Note: This value is in cents.
10 id Long R O Unique Customer ID generated by the system.
For more information see term: Customer.
11 code String(60) CODE C O Unique Customer ID supplied by external/user's system used for filtering unique Customer ID records.
12 accountId Integer C R Reference to an account used for filtering records.
13 createDate Datetime R O Date when the Customer was created.
Note: Date format: yyyy-MM-dd HH:mm:ss.
14 firstName String(125) NAME R First name of the Customer used for filtering Customer records.
15 lastName String(125) NAME R Last name of the Customer used for filtering Customer records.
16 email String EMAIL O Email address of the Customer used for filtering Customer records.
17 isActive Boolean O Status of a Customer used for filtering Customer records.
18 balance Integer R O Current balance of the Customer.
Note: This value is in cents.
19 city String(50) ALPHANUMERIC_EXTENDED O City of the Customer used for filtering Customer records.
20 countryCode String(2) ALPHA O Country code of the Customer used for filtering Customer records.
21 state String(3) O State code of the Customer used for filtering Customer records.
22 zipCode String(10) O ZIP/postal code of the Customer used for filtering Customer records.
23 holderName String R O Calculation field combines first name and last name.
Note: A combination of the first name and last name, separated by a space.
24 address String(321) 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.
25 state String(3) ALPHA O State code of the Customer used for filtering Customer records.
26 zipCode String(10) ALPHANUMERIC_EXTENDED O ZIP/postal code of the Customer used for filtering Customer records.

~find (request)

Method:  GET
Implicit:  Yes
Returns:  List<Customer>
Consumes:  xurl
Produces:  json,xml

Returns a list of available customers based on specified search criteria.
Body Parameters:
# Name Type Pattern Format Mode Usage Description
1 offset Integer O Index of the first record returned from the search result.\n\r\n> **Note:** Default value is 0. Used with limit parameter for pagination.\n\r\n> **Tip:** Use this field for implementing paginated results. See Error Messages section for details on pagination issues.
2 limit Integer O Maximum number of records to load per search call.\n\r\n> **Note:** Default value is 100. Adjust based on performance requirements.\n\r\n> **Tip:** Use this field to balance response size and performance. See Webhooks Management Guide for details on handling large datasets.
3 firstName String O First name of the customer used for filtering Customer records.
4 lastName String O Last name of the customer used for filtering Customer records.
5 organizationName String O Name of the organization used for filtering Customer records.
6 accountId Integer O Account ID used for filtering records.
7 email String O Email address of the customer used for filtering Customer records.
8 phone String O Phone number of the customer used for filtering Customer records.
9 street String O Street of the mailing address of the customer used for filtering Customer records.
10 city String O City of the mailing address of the customer used for filtering Customer records.
11 state String O State code of the mailing address of the customer used for filtering Customer records.
12 zipCode String O ZIP or postal code of the mailing address of the customer used for filtering Customer records.
13 countryCode String O Country code of the mailing address of the customer used for filtering Customer records.

~find (response)

Method:  GET
Implicit:  Yes
Returns:  List<Customer>
Consumes:  xurl
Produces:  json,xml

Returns a list of available customers based on specified search criteria.
Body Parameters:
# Name Type Pattern Format Mode Usage Description
1 phone String NUMERIC R Phone number of the Customer.
2 street1 String(128) STREET O Street address of the Customer.
3 street2 String(128) STREET O Secondary Street address of the Customer.
Note: Additional street data such as appartment or suite number.
4 organizationName String(255) NAME_BUSINESS O Name of the associated organization for the Customer.
Note: OrganizationName is a user provided freeform field and does not represent any other data structure or object.
5 email String(100) EMAIL O Email address of the Customer.
6 holderName String(500) R O Combined values of the firstName and lastName in the Customer.
Note: This value is a concatenation of the firstName and lastName values provided at the time of Customer creation or modification.
7 createDate Datetime R O Date when the Customer was created.
Note: Date format: yyyy-MM-dd.
8 address String(321) 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.
9 balance Integer R O Current balance of the Customer.
Note: This value is in cents.
10 id Long R O Unique Customer ID generated by the system.
For more information see term: Customer.
11 code String(60) CODE C O Unique Customer 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.
12 accountId Integer C R Merchant account associated with Customer.
Note: If your API user is associated to more than one merchant account or group of merchant accounts, you can specify the merchant account ID for the ~find operation to reduce the data set in the API response.

Your API credentials may be associated with more than one accountId.
13 createDate Datetime R O Date when the Customer was created.
Note: Date format: yyyy-MM-dd HH:mm:ss.
14 firstName String(125) NAME R First name of the Customer.
15 lastName String(125) NAME R Last name of the Customer.
16 email String EMAIL O Email address of the Customer.
17 isActive Boolean O Status of the Customer.
Note: Values: true (active) or false (inactive).
18 balance Integer R O Current balance of the Customer.
Note: This value is in cents.
19 city String(50) ALPHANUMERIC_EXTENDED O City of the Customer.
20 countryCode String(2) ALPHA O Country code of the Customer.
21 state String(3) O State of the Customer.
Note: State value format is subject to the associated country code in the Customer object.
22 zipCode String(10) O ZIP/postal code of the Customer.
Note: ZipCode value format is subject to the associated country code in the Customer object.
23 holderName String R O Calculation field combines first name and last name.
Note: A combination of the first name and last name, separated by a space.
24 address String(321) 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.
25 state String(3) ALPHA O State of the Customer.
Note: State value format is subject to the associated country code in the Customer object.
26 zipCode String(10) ALPHANUMERIC_EXTENDED O ZIP/postal code of the Customer.
Note: ZipCode value format is subject to the associated country code in the Customer object.
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.