Zip and Country Codes
Development
Reference Materials
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.
Billing API Index (Actions)
URL |
Action |
Method |
[version]/customers view |
[version]/customers |
~create |
PUT |
[version]/customers |
~find |
GET |
[version]/customers/[customer-id] view |
[version]/customers/[customer-id] |
~load |
GET |
[version]/customers/[customer-id] |
~modify |
POST |
[version]/customers/[customer-id]/payment-options view |
[version]/customers/[customer-id]/payment-options |
~create |
PUT |
[version]/customers/[customer-id]/payment-options |
~find |
GET |
[version]/customers/[customer-id]/payment-options/[payment-option-id] view |
[version]/customers/[customer-id]/payment-options/[payment-option-id] |
~load |
GET |
[version]/customers/[customer-id]/payment-options/[payment-option-id] |
~modify |
POST |
[version]/customers/[customer-id]/payment-options/[payment-option-id] |
~process |
POST |
[version]/customers/[customer-id]/subscriptions view |
[version]/customers/[customer-id]/subscriptions |
~create |
PUT |
[version]/customers/[customer-id]/subscriptions |
~find |
GET |
[version]/customers/[customer-id]/subscriptions/[subscription-id] view |
[version]/customers/[customer-id]/subscriptions/[subscription-id] |
~cancel |
GET |
[version]/customers/[customer-id]/subscriptions/[subscription-id] |
~freeze |
GET |
[version]/customers/[customer-id]/subscriptions/[subscription-id] |
~load |
GET |
[version]/customers/[customer-id]/subscriptions/[subscription-id] |
~modify |
POST |
[version]/customers/[customer-id]/subscriptions/[subscription-id] |
~pause |
GET |
[version]/customers/[customer-id]/subscriptions/[subscription-id] |
~uncancel |
GET |
[version]/customers/[customer-id]/subscriptions/[subscription-id] |
~unfreeze |
GET |
[version]/customers/[customer-id]/subscriptions/[subscription-id] |
~unpause |
GET |
[version]/customers/[customer-id]/subscriptions/[subscription-id]/adjustments view |
[version]/customers/[customer-id]/subscriptions/[subscription-id]/adjustments |
~find |
GET |
[version]/customers/[customer-id]/transactions view |
[version]/customers/[customer-id]/transactions |
~create |
PUT |
[version]/customers/[customer-id]/transactions |
~find |
GET |
[version]/customers/[customer-id]/transactions |
~process |
POST |
[version]/customers/[customer-id]/transactions/[transaction-id] view |
[version]/customers/[customer-id]/transactions/[transaction-id] |
~load |
GET |
[version]/customers/[customer-id]/transactions/[transaction-id] |
~reverse |
GET |
[version]/customers/[customer-id]/transactions/[transaction-id]/allocations view |
[version]/customers/[customer-id]/transactions/[transaction-id]/allocations |
~find |
GET |
[version]/plans view |
[version]/plans |
~create |
PUT |
[version]/plans |
~find |
GET |
[version]/plans/[plan-id] view |
[version]/plans/[plan-id] |
~load |
GET |
[version]/plans/[plan-id] |
~modify |
POST |
Base Resource URL:
https://[server-name]/api/v01/customers/[customer-id]/transactions
Description:
Provides access to the transactions associated with the specified customer.
Supported sub-resources:
Resource URL |
Description |
https://[server-name]/api/v01/customers/[customer-id]/transactions/[transaction-id]
|
Provides access to management of the specified transaction. |
Supported Actions:
~create (request)
Method: PUT
Implicit: Yes
Consumes: json,xml
Produces: json,xml
Create transaction to generate invoice records linked to customers and track payment activities.
- Transactions are linked to the merchant account that processes them.
- Include payment method, amount, and status details.
- For one-time or on-demand payments, use Transaction API instead of Billing API.
- For Direct Debit (ACH), subscribe to NOC and return webhooks for real-time updates on account changes and status.
# |
Name |
Type |
Pattern |
Format |
Mode |
Usage |
Description |
1 |
customer-id |
Long |
|
|
|
|
System-generated unique identifier for the customer.\n\r\n> **Note:** Automatically generated by the system. This field must not be provided in your request. |
# |
Name |
Type |
Pattern |
Format |
Mode |
Usage |
Description |
1 |
taxAmount |
Integer |
|
|
|
|
Tax amount in cents.\n\r\n> **Note:** Specified in cents, not dollars. For example, $5.00 = 500 cents.\n\r\n> **Tip:** This field supports tax reporting and compliance requirements. |
3 |
invoiceList |
String(250) |
|
|
|
|
List of invoice references that are expected to be covered by this transaction. |
5 |
accountId |
Integer |
|
|
|
|
Specifies which merchant account to use with this API call.\n\r\n> **Note:** Your API credentials may be associated with more than one accountId.\n\r\n> **Tip:** This field routes the transaction to the correct merchant account for processing and reporting. |
6 |
customerId |
Long |
|
|
|
|
The ID of the Customer in the system.\n\r\n> **Note:** This field identifies the customer to whom the invoice is being issued.\n\r\n> **Tip:** This field links the invoice to an existing customer. The customer must exist in the system before an invoice can be created. |
8 |
dueDate |
Date |
|
|
|
|
Date when the transaction is due.\n\r\n> **Note:** The date must be submitted in yyyy-MM-dd format. Defaults to the current date if no value is passed.\n\r\n> **Tip:** This field helps establish payment expectations and manage cash flow. |
9 |
type |
|
|
|
|
|
Type of the Transaction to be created. This field is required and determines how the transaction is processed and displayed.\n\r\n> **Note:** For invoice creation, this must be set to the appropriate invoice type value.\n\r\n> **Tip:** Use this field to route the invoice to the correct customer account. |
10 |
amount |
Integer |
|
|
|
|
Specifies the total amount of the transaction in cents (not dollars). This field is required and must be a positive integer value.\n\r\n> **Note:** For example, $5.00 = 500 cents.\n\r\n> **Tip:** This value defines how much the customer is expected to pay. |
12 |
note |
String(255) |
|
|
|
|
Any notes related to the transaction.\n\r\n> **Note:** This field is limited to 255 characters.\n\r\n> **Tip:** Add context or special instructions that may be helpful for internal reference or customer communication. |
13 |
accountType |
|
|
|
|
|
Specifies the type of account associated with the transaction.\n\r\n> **Note:** This field determines how the transaction is categorized and processed in the system.\n\r\n> **Tip:** Ensure proper transaction routing and processing with this value. |
14 |
accountNumber |
String(19) |
|
|
|
|
Account number associated with the transaction. If provided, this field contains sensitive payment information that should be properly secured.\n\r\n> **Note:** This field is used for reference purposes when linking transactions to specific accounts.\n\r\n> **Tip:** Consider using tokenization instead of raw account numbers when possible. |
15 |
creatorCode |
String(60) |
|
|
|
|
Code of the user that created the transaction.\n\r\n> **Note:** Defaults to the API user's username if no value is passed. Limited to 60 characters.\n\r\n> **Tip:** This value helps audit which user or system created each transaction. |
16.21 |
accountNumber |
String |
|
|
|
|
Number of a payment card or bank account that will be used during the transaction processing. |
17 |
code |
String(60) |
|
|
|
|
Optional secondary identifier that references your system's transaction ID.\n\r\n> **Note:** Default value is the same as the object's id, which is returned in the response.\n\r\n> **Tip:** This field simplifies reconciliation between systems. |
19 |
feeAmount |
Integer |
|
|
|
|
Fee amount (in cents) associated with the transaction processing.\n\r\n> **Note:** Specified in cents, not dollars. For example, $5.00 = 500 cents.\n\r\n> **Tip:** This field allows tracking processing fees separately from the main transaction amount. |
~create (response)
Method: PUT
Implicit: Yes
Consumes: json,xml
Produces: json,xml
Create transaction to generate invoice records linked to customers and track payment activities.
- Transactions are linked to the merchant account that processes them.
- Include payment method, amount, and status details.
- For one-time or on-demand payments, use Transaction API instead of Billing API.
- For Direct Debit (ACH), subscribe to NOC and return webhooks for real-time updates on account changes and status.
# |
Name |
Type |
Pattern |
Format |
Mode |
Usage |
Description |
1 |
taxAmount
|
Integer |
|
|
|
|
Tax amount in cents.\n\r\n> **Note:** Specified in cents, not dollars. For example, $5.00 = 500 cents.\n\r\n> **Tip:** This value supports tax reporting and reconciliation requirements. |
2 |
adjustmentId
|
Long |
|
|
|
|
Identifier of an Adjustment that the transaction is associated with.\n\r\n> **Note:** This field links the transaction to a specific adjustment record in the system.\n\r\n> **Tip:** This value enables monitoring adjustments that affected this transaction. |
3 |
invoiceList
|
String(250) |
|
|
|
|
List of invoice references used for filtering records. |
4 |
id
|
Long |
|
|
|
|
Unique transaction ID generated by the system.\n\r\n> **Note:** This identifier is used for referencing the transaction in subsequent API calls.\n\r\n> **Tip:** Store this value to maintain the relationship between your records and the payment platform. |
5 |
accountId
|
Integer |
|
|
|
|
Specifies which merchant account was used with this API call.\n\r\n> **Note:** Your API credentials may be associated with more than one accountId.\n\r\n> **Tip:** Ensure this value reflects the correct merchant account to confirm proper transaction routing. |
6 |
customerId
|
Long |
|
|
|
|
The ID of the Customer in the system.\n\r\n> **Note:** This field identifies the customer to whom the invoice was issued.\n\r\n> **Tip:** Reference this identifier for subsequent API calls related to this customer. |
7 |
createDate
|
Datetime |
|
|
|
|
Date when the transaction was created.\n\r\n> **Note:** In the response, the date is returned in yyyy-MM-dd HH:mm:ss format, which includes time components not required in the request.\n\r\n> **Tip:** This timestamp supports reconciliation and auditing processes. |
8 |
dueDate
|
Date |
|
|
|
|
Date when the transaction is due.\n\r\n> **Note:** Returned in yyyy-MM-dd format. If not provided in the request, defaults to the transaction creation date.\n\r\n> **Tip:** This date supports accounts receivable aging reports and collection activities. |
9 |
type
|
|
|
|
|
|
Type of the Transaction that was created.\n\r\n> **Note:** This field indicates how the transaction is categorized in the system.\n\r\n> **Tip:** Confirm this value matches the expected transaction type for validation. |
10 |
amount
|
Integer |
|
|
|
|
Total amount of the transaction in cents.\n\r\n> **Note:** Specified in cents, not dollars. For example, $5.00 = 500 cents.\n\r\n> **Tip:** Verify this value matches your expected amount to ensure transaction accuracy. |
11 |
balance
|
Integer |
|
|
|
|
Current outstanding balance on this transaction, in cents.\n\r\n> **Note:** For newly created invoices, this will typically match the amount field until payments are applied.\n\r\n> **Tip:** Monitor this value to track the remaining amount due on the invoice. |
12 |
note
|
String(255) |
|
|
|
|
Any notes related to the transaction.\n\r\n> **Note:** This field returns any notes that were included in the request. Limited to 255 characters.\n\r\n> **Tip:** This information provides context for the transaction that may be helpful for future reference. |
13 |
accountType
|
|
|
|
|
|
Type of account associated with the transaction.\n\r\n> **Note:** This field indicates how the transaction is categorized in the system.\n\r\n> **Tip:** Verify this value to ensure proper transaction categorization. |
14 |
accountNumber
|
String(19) |
|
|
|
|
Account number associated with the transaction. Contains sensitive payment information that should be properly secured.\n\r\n> **Note:** This field is used for reference purposes when linking transactions to specific accounts.\n\r\n> **Tip:** Consider using tokenization instead of raw account numbers for enhanced security. |
15 |
creatorCode
|
String(60) |
|
|
|
|
Code of the user that created the transaction.\n\r\n> **Note:** If not provided in the request, defaults to the API user's username. Limited to 60 characters.\n\r\n> **Tip:** This information supports auditing which user or system created each transaction. |
16 |
processingInfo
|
ProcessingInfo |
|
|
|
|
Information associated with transaction processing within internal and external systems.\n\r\n> **Note:** This object contains details about how the transaction was processed.\n\r\n> **Tip:** This object provides the complete processing context of the transaction. |
16.1 |
city
|
String(50) |
|
|
|
|
City of the Customer. |
16.2 |
createDate
|
Datetime |
|
|
|
|
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 |
|
|
|
|
Unique ProcesingInfo ID generated by the system. |
16.4 |
createDate
|
Datetime |
|
|
|
|
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) |
|
|
|
|
Combined values fo the firsetName and lastName in the Customer. |
16.6 |
accountNumber
|
String |
|
|
|
|
Number of a payment card or bank account. |
16.7 |
accountAccessory
|
String |
|
|
|
|
|
16.8 |
token
|
String(512) |
|
|
|
|
Unique random characters generated by the system for identifying and securely transmitting sensitive data. |
16.9 |
street
|
String(128) |
|
|
|
|
Street address of the Customer. |
16.10 |
state
|
String(3) |
|
|
|
|
State of the Customer. Note: State value format is subject to the associated country code in the Customer object. |
16.11 |
zipCode
|
String(15) |
|
|
|
|
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) |
|
|
|
|
Phone number of the Customer. |
16.13 |
email
|
String(100) |
|
|
|
|
Email address of the Customer. |
16.14 |
gatewayTransactionId
|
String(20) |
|
|
|
|
Identifier of a Transaction (Processing) that the current transaction is associated with. |
16.15 |
approvalCode
|
String(60) |
|
|
|
|
Code of the approval status of the transaction provided by the payment provider. |
16.16 |
responseDate
|
Datetime |
|
|
|
|
Date when the response to the transaction was received. |
16.17 |
responseCode
|
String(3) |
|
|
|
|
Code providing an explanation of the outcome of the request. |
16.18 |
responseMessage
|
String(255) |
|
|
|
|
Response details associated with a processing request, generated by the gateway. |
16.19 |
address
|
String |
|
|
|
|
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 |
|
|
|
|
Card expiration date or bank routing number. Note: This field is required even if it is used with a token. |
16.21 |
accountNumber
|
String |
|
|
|
|
Number of a payment card or bank account used for filtering ProcessingInfo records. |
16.22 |
approvalCode
|
String(60) |
|
|
|
|
Code of the approval status of the transaction provided by the payment provider. |
16.23 |
city
|
String(50) |
|
|
|
|
City of the Customer. |
16.24 |
email
|
String(100) |
|
|
|
|
Email address of the Customer. |
16.25 |
phone
|
String(20) |
|
|
|
|
Phone number of the Customer. |
16.26 |
responseCode
|
String(3) |
|
|
|
|
Code providing an explanation of the outcome of the request. |
16.27 |
responseMessage
|
String(255) |
|
|
|
|
Response details associated with a processing request, generated by the gateway. |
16.28 |
state
|
String(3) |
|
|
|
|
State of the Customer. Note: State value format is subject to the associated country code in the Customer object. |
16.29 |
token
|
String(512) |
|
|
|
|
Unique random characters generated by the system for identifying and securely transmitting sensitive data. |
16.30 |
zipCode
|
String(15) |
|
|
|
|
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) |
|
|
|
|
Optional secondary identifier that references your system's transaction ID.\n\r\n> **Note:** If not provided in the request, this field will contain the same value as the id field.\n\r\n> **Tip:** This value simplifies matching transactions with your internal records. |
18 |
subscriptionId
|
Long |
|
|
|
|
Identifier of a Subscription that the transaction is associated with.\n\r\n> **Note:** This field is relevant for transactions of type 'RI' (Invoice) that were created based on a subscription.\n\r\n> **Tip:** This value helps track which subscription generated this invoice. |
19 |
feeAmount
|
Integer |
|
|
|
|
Fee amount (in cents) associated with the transaction processing.\n\r\n> **Note:** Specified in cents, not dollars. For example, $5.00 = 500 cents.\n\r\n> **Tip:** This value allows tracking processing fees separately from the main transaction amount. |
~find (request)
Method: GET
Implicit: Yes
Consumes: xurl
Produces: json,xml
Returns a list of the transactions associated with the specified customer.
# |
Name |
Type |
Pattern |
Format |
Mode |
Usage |
Description |
1 |
customer-id |
Long |
|
|
|
|
System-generated unique identifier for the customer.\n\r\n> **Note:** Automatically generated by the system. This field must not be provided in your request. |
# |
Name |
Type |
Pattern |
Format |
Mode |
Usage |
Description |
1 |
offset |
Integer |
|
|
|
|
Index of the first record returned from the search result.\n\r\n> **Note:** Default: `0`. Used with limit parameter for pagination.\n\r\n> **Tip:** Use this field for implementing paginated results. |
2 |
limit |
Integer |
|
|
|
|
Maximum number of records to load per search call.\n\r\n> **Note:** Default: `100`. Adjust based on performance requirements.\n\r\n> **Tip:** Use this field to balance response size and performance. |
3 |
createDateFrom |
Date |
|
|
|
|
The starting date for filtering transaction records; only records dated from this specific day onwards are included. |
4 |
createDateTo |
Date |
|
|
|
|
The concluding date for filtering transaction records; only records up to and through this specified date are included. |
~find (response)
Method: GET
Implicit: Yes
Consumes: xurl
Produces: json,xml
Returns a list of the transactions associated with the specified customer.
# |
Name |
Type |
Pattern |
Format |
Mode |
Usage |
Description |
1 |
taxAmount
|
Integer |
|
|
|
|
Tax amount in cents.\n\r\n> **Note:** Specified in cents, not dollars. For example, $5.00 = 500 cents.\n\r\n> **Tip:** This value supports tax reporting and reconciliation requirements. |
2 |
adjustmentId
|
Long |
|
|
|
|
Identifier of an Adjustment that the transaction is associated with.\n\r\n> **Note:** This field links the transaction to a specific adjustment record in the system.\n\r\n> **Tip:** This value enables monitoring adjustments that affected this transaction. |
3 |
invoiceList
|
String(250) |
|
|
|
|
List of invoice references that are expected to be covered by this transaction. |
4 |
id
|
Long |
|
|
|
|
Unique transaction ID generated by the system.\n\r\n> **Note:** This identifier is used for referencing the transaction in subsequent API calls.\n\r\n> **Tip:** Store this value to maintain the relationship between your records and the payment platform. |
5 |
accountId
|
Integer |
|
|
|
|
Specifies which merchant account was used with this API call.\n\r\n> **Note:** Your API credentials may be associated with more than one accountId.\n\r\n> **Tip:** Ensure this value reflects the correct merchant account to confirm proper transaction routing. |
6 |
customerId
|
Long |
|
|
|
|
The ID of the Customer in the system.\n\r\n> **Note:** This field identifies the customer to whom the invoice was issued.\n\r\n> **Tip:** Reference this identifier for subsequent API calls related to this customer. |
7 |
createDate
|
Datetime |
|
|
|
|
Date when the transaction was created.\n\r\n> **Note:** In the response, the date is returned in yyyy-MM-dd HH:mm:ss format, which includes time components not required in the request.\n\r\n> **Tip:** This timestamp supports reconciliation and auditing processes. |
8 |
dueDate
|
Date |
|
|
|
|
Date when the transaction is due.\n\r\n> **Note:** Returned in yyyy-MM-dd format. If not provided in the request, defaults to the transaction creation date.\n\r\n> **Tip:** This date supports accounts receivable aging reports and collection activities. |
9 |
type
|
|
|
|
|
|
Type of the Transaction that was created.\n\r\n> **Note:** This field indicates how the transaction is categorized in the system.\n\r\n> **Tip:** Confirm this value matches the expected transaction type for validation. |
10 |
amount
|
Integer |
|
|
|
|
Total amount of the transaction in cents.\n\r\n> **Note:** Specified in cents, not dollars. For example, $5.00 = 500 cents.\n\r\n> **Tip:** Verify this value matches your expected amount to ensure transaction accuracy. |
11 |
balance
|
Integer |
|
|
|
|
Current outstanding balance on this transaction, in cents.\n\r\n> **Note:** For newly created invoices, this will typically match the amount field until payments are applied.\n\r\n> **Tip:** Monitor this value to track the remaining amount due on the invoice. |
12 |
note
|
String(255) |
|
|
|
|
Any notes related to the transaction.\n\r\n> **Note:** This field returns any notes that were included in the request. Limited to 255 characters.\n\r\n> **Tip:** This information provides context for the transaction that may be helpful for future reference. |
13 |
accountType
|
|
|
|
|
|
Type of account associated with the transaction.\n\r\n> **Note:** This field indicates how the transaction is categorized in the system.\n\r\n> **Tip:** Verify this value to ensure proper transaction categorization. |
14 |
accountNumber
|
String(19) |
|
|
|
|
Account number associated with the transaction. Contains sensitive payment information that should be properly secured.\n\r\n> **Note:** This field is used for reference purposes when linking transactions to specific accounts.\n\r\n> **Tip:** Consider using tokenization instead of raw account numbers for enhanced security. |
15 |
creatorCode
|
String(60) |
|
|
|
|
Code of the user that created the transaction.\n\r\n> **Note:** If not provided in the request, defaults to the API user's username. Limited to 60 characters.\n\r\n> **Tip:** This information supports auditing which user or system created each transaction. |
16 |
processingInfo
|
ProcessingInfo |
|
|
|
|
Information associated with transaction processing within internal and external systems.\n\r\n> **Note:** This object contains details about how the transaction was processed.\n\r\n> **Tip:** This object provides the complete processing context of the transaction. |
16.1 |
city
|
String(50) |
|
|
|
|
City of the Customer. |
16.2 |
createDate
|
Datetime |
|
|
|
|
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 |
|
|
|
|
Unique ProcesingInfo ID generated by the system. |
16.4 |
createDate
|
Datetime |
|
|
|
|
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) |
|
|
|
|
Combined values fo the firsetName and lastName in the Customer. |
16.6 |
accountNumber
|
String |
|
|
|
|
Number of a payment card or bank account. |
16.7 |
accountAccessory
|
String |
|
|
|
|
|
16.8 |
token
|
String(512) |
|
|
|
|
Unique random characters generated by the system for identifying and securely transmitting sensitive data. |
16.9 |
street
|
String(128) |
|
|
|
|
Street address of the Customer. |
16.10 |
state
|
String(3) |
|
|
|
|
State of the Customer. Note: State value format is subject to the associated country code in the Customer object. |
16.11 |
zipCode
|
String(15) |
|
|
|
|
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) |
|
|
|
|
Phone number of the Customer. |
16.13 |
email
|
String(100) |
|
|
|
|
Email address of the Customer. |
16.14 |
gatewayTransactionId
|
String(20) |
|
|
|
|
Identifier of a Transaction (Processing) that the current transaction is associated with. |
16.15 |
approvalCode
|
String(60) |
|
|
|
|
Code of the approval status of the transaction provided by the payment provider. |
16.16 |
responseDate
|
Datetime |
|
|
|
|
Date when the response to the transaction was received. |
16.17 |
responseCode
|
String(3) |
|
|
|
|
Code providing an explanation of the outcome of the request. |
16.18 |
responseMessage
|
String(255) |
|
|
|
|
Response details associated with a processing request, generated by the gateway. |
16.19 |
address
|
String |
|
|
|
|
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 |
|
|
|
|
Card expiration date or bank routing number. Note: This field is required even if it is used with a token. |
16.21 |
accountNumber
|
String |
|
|
|
|
Number of a payment card or bank account. |
16.22 |
approvalCode
|
String(60) |
|
|
|
|
Code of the approval status of the transaction provided by the payment provider. |
16.23 |
city
|
String(50) |
|
|
|
|
City of the Customer. |
16.24 |
email
|
String(100) |
|
|
|
|
Email address of the Customer. |
16.25 |
phone
|
String(20) |
|
|
|
|
Phone number of the Customer. |
16.26 |
responseCode
|
String(3) |
|
|
|
|
Code providing an explanation of the outcome of the request. |
16.27 |
responseMessage
|
String(255) |
|
|
|
|
Response details associated with a processing request, generated by the gateway. |
16.28 |
state
|
String(3) |
|
|
|
|
State of the Customer. Note: State value format is subject to the associated country code in the Customer object. |
16.29 |
token
|
String(512) |
|
|
|
|
Unique random characters generated by the system for identifying and securely transmitting sensitive data. |
16.30 |
zipCode
|
String(15) |
|
|
|
|
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) |
|
|
|
|
Optional secondary identifier that references your system's transaction ID.\n\r\n> **Note:** If not provided in the request, this field will contain the same value as the id field.\n\r\n> **Tip:** This value simplifies matching transactions with your internal records. |
18 |
subscriptionId
|
Long |
|
|
|
|
Identifier of a Subscription that the transaction is associated with.\n\r\n> **Note:** This field is relevant for transactions of type 'RI' (Invoice) that were created based on a subscription.\n\r\n> **Tip:** This value helps track which subscription generated this invoice. |
19 |
feeAmount
|
Integer |
|
|
|
|
Fee amount (in cents) associated with the transaction processing.\n\r\n> **Note:** Specified in cents, not dollars. For example, $5.00 = 500 cents.\n\r\n> **Tip:** This value allows tracking processing fees separately from the main transaction amount. |
~process (request)
Method: POST
Implicit: No
Consumes: json,xml
Produces: json,xml
Creates and processes a transaction associated with the specified customer.
# |
Name |
Type |
Pattern |
Format |
Mode |
Usage |
Description |
1 |
customer-id |
Long |
|
|
|
|
System-generated unique identifier for the customer.\n\r\n> **Note:** Automatically generated by the system. This field must not be provided in your request. |
~process (response)
Method: POST
Implicit: No
Consumes: json,xml
Produces: json,xml
Creates and processes a transaction associated with the specified customer.
# |
Name |
Type |
Pattern |
Format |
Mode |
Usage |
Description |
1 |
taxAmount
|
Integer |
|
|
|
|
Tax amount in cents.\n\r\n> **Note:** Specified in cents, not dollars. For example, $5.00 = 500 cents.\n\r\n> **Tip:** This value supports tax reporting and reconciliation requirements. |
2 |
adjustmentId
|
Long |
|
|
|
|
Identifier of an Adjustment that the transaction is associated with.\n\r\n> **Note:** This field links the transaction to a specific adjustment record in the system.\n\r\n> **Tip:** This value enables monitoring adjustments that affected this transaction. |
3 |
invoiceList
|
String(250) |
|
|
|
|
List of invoice references used for filtering records. |
4 |
id
|
Long |
|
|
|
|
Unique transaction ID generated by the system.\n\r\n> **Note:** This identifier is used for referencing the transaction in subsequent API calls.\n\r\n> **Tip:** Store this value to maintain the relationship between your records and the payment platform. |
5 |
accountId
|
Integer |
|
|
|
|
Specifies which merchant account was used with this API call.\n\r\n> **Note:** Your API credentials may be associated with more than one accountId.\n\r\n> **Tip:** Ensure this value reflects the correct merchant account to confirm proper transaction routing. |
6 |
customerId
|
Long |
|
|
|
|
The ID of the Customer in the system.\n\r\n> **Note:** This field identifies the customer to whom the invoice was issued.\n\r\n> **Tip:** Reference this identifier for subsequent API calls related to this customer. |
7 |
createDate
|
Datetime |
|
|
|
|
Date when the transaction was created.\n\r\n> **Note:** In the response, the date is returned in yyyy-MM-dd HH:mm:ss format, which includes time components not required in the request.\n\r\n> **Tip:** This timestamp supports reconciliation and auditing processes. |
8 |
dueDate
|
Date |
|
|
|
|
Date when the transaction is due.\n\r\n> **Note:** Returned in yyyy-MM-dd format. If not provided in the request, defaults to the transaction creation date.\n\r\n> **Tip:** This date supports accounts receivable aging reports and collection activities. |
9 |
type
|
|
|
|
|
|
Type of the Transaction that was created.\n\r\n> **Note:** This field indicates how the transaction is categorized in the system.\n\r\n> **Tip:** Confirm this value matches the expected transaction type for validation. |
10 |
amount
|
Integer |
|
|
|
|
Total amount of the transaction in cents.\n\r\n> **Note:** Specified in cents, not dollars. For example, $5.00 = 500 cents.\n\r\n> **Tip:** Verify this value matches your expected amount to ensure transaction accuracy. |
11 |
balance
|
Integer |
|
|
|
|
Current outstanding balance on this transaction, in cents.\n\r\n> **Note:** For newly created invoices, this will typically match the amount field until payments are applied.\n\r\n> **Tip:** Monitor this value to track the remaining amount due on the invoice. |
12 |
note
|
String(255) |
|
|
|
|
Any notes related to the transaction.\n\r\n> **Note:** This field returns any notes that were included in the request. Limited to 255 characters.\n\r\n> **Tip:** This information provides context for the transaction that may be helpful for future reference. |
13 |
accountType
|
|
|
|
|
|
Type of account associated with the transaction.\n\r\n> **Note:** This field indicates how the transaction is categorized in the system.\n\r\n> **Tip:** Verify this value to ensure proper transaction categorization. |
14 |
accountNumber
|
String(19) |
|
|
|
|
Account number associated with the transaction. Contains sensitive payment information that should be properly secured.\n\r\n> **Note:** This field is used for reference purposes when linking transactions to specific accounts.\n\r\n> **Tip:** Consider using tokenization instead of raw account numbers for enhanced security. |
15 |
creatorCode
|
String(60) |
|
|
|
|
Code of the user that created the transaction.\n\r\n> **Note:** If not provided in the request, defaults to the API user's username. Limited to 60 characters.\n\r\n> **Tip:** This information supports auditing which user or system created each transaction. |
16 |
processingInfo
|
ProcessingInfo |
|
|
|
|
Information associated with transaction processing within internal and external systems.\n\r\n> **Note:** This object contains details about how the transaction was processed.\n\r\n> **Tip:** This object provides the complete processing context of the transaction. |
16.1 |
city
|
String(50) |
|
|
|
|
City of the Customer. |
16.2 |
createDate
|
Datetime |
|
|
|
|
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 |
|
|
|
|
Unique ProcesingInfo ID generated by the system. |
16.4 |
createDate
|
Datetime |
|
|
|
|
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) |
|
|
|
|
Combined values fo the firsetName and lastName in the Customer. |
16.6 |
accountNumber
|
String |
|
|
|
|
Number of a payment card or bank account. |
16.7 |
accountAccessory
|
String |
|
|
|
|
|
16.8 |
token
|
String(512) |
|
|
|
|
Unique random characters generated by the system for identifying and securely transmitting sensitive data. |
16.9 |
street
|
String(128) |
|
|
|
|
Street address of the Customer. |
16.10 |
state
|
String(3) |
|
|
|
|
State of the Customer. Note: State value format is subject to the associated country code in the Customer object. |
16.11 |
zipCode
|
String(15) |
|
|
|
|
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) |
|
|
|
|
Phone number of the Customer. |
16.13 |
email
|
String(100) |
|
|
|
|
Email address of the Customer. |
16.14 |
gatewayTransactionId
|
String(20) |
|
|
|
|
Identifier of a Transaction (Processing) that the current transaction is associated with. |
16.15 |
approvalCode
|
String(60) |
|
|
|
|
Code of the approval status of the transaction provided by the payment provider. |
16.16 |
responseDate
|
Datetime |
|
|
|
|
Date when the response to the transaction was received. |
16.17 |
responseCode
|
String(3) |
|
|
|
|
Code providing an explanation of the outcome of the request. |
16.18 |
responseMessage
|
String(255) |
|
|
|
|
Response details associated with a processing request, generated by the gateway. |
16.19 |
address
|
String |
|
|
|
|
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 |
|
|
|
|
Card expiration date or bank routing number. Note: This field is required even if it is used with a token. |
16.21 |
accountNumber
|
String |
|
|
|
|
Number of a payment card or bank account used for filtering ProcessingInfo records. |
16.22 |
approvalCode
|
String(60) |
|
|
|
|
Code of the approval status of the transaction provided by the payment provider. |
16.23 |
city
|
String(50) |
|
|
|
|
City of the Customer. |
16.24 |
email
|
String(100) |
|
|
|
|
Email address of the Customer. |
16.25 |
phone
|
String(20) |
|
|
|
|
Phone number of the Customer. |
16.26 |
responseCode
|
String(3) |
|
|
|
|
Code providing an explanation of the outcome of the request. |
16.27 |
responseMessage
|
String(255) |
|
|
|
|
Response details associated with a processing request, generated by the gateway. |
16.28 |
state
|
String(3) |
|
|
|
|
State of the Customer. Note: State value format is subject to the associated country code in the Customer object. |
16.29 |
token
|
String(512) |
|
|
|
|
Unique random characters generated by the system for identifying and securely transmitting sensitive data. |
16.30 |
zipCode
|
String(15) |
|
|
|
|
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) |
|
|
|
|
Optional secondary identifier that references your system's transaction ID.\n\r\n> **Note:** If not provided in the request, this field will contain the same value as the id field.\n\r\n> **Tip:** This value simplifies matching transactions with your internal records. |
18 |
subscriptionId
|
Long |
|
|
|
|
Identifier of a Subscription that the transaction is associated with.\n\r\n> **Note:** This field is relevant for transactions of type 'RI' (Invoice) that were created based on a subscription.\n\r\n> **Tip:** This value helps track which subscription generated this invoice. |
19 |
feeAmount
|
Integer |
|
|
|
|
Fee amount (in cents) associated with the transaction processing.\n\r\n> **Note:** Specified in cents, not dollars. For example, $5.00 = 500 cents.\n\r\n> **Tip:** This value allows tracking processing fees separately from the main transaction amount. |
|