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]/payment-options/[payment-option-id]
Description:
Provides access to configuration settings for the specified payment option.
Supported Actions:
Method: GET
Implicit: Yes
Consumes: xurl
Produces: json,xml
Returns configuration settings for the specified payment option.
# |
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. |
2 |
payment-option-id |
Long |
|
|
|
|
Unique PaymentOption ID generated by the system. |
~load (response)
Method: GET
Implicit: Yes
Consumes: xurl
Produces: json,xml
Returns configuration settings for the specified payment option.
# |
Name |
Type |
Pattern |
Format |
Mode |
Usage |
Description |
1 |
countryCode
|
String(3) |
|
|
|
|
The customer's country code.\n\r\n> **Note:** Uses standard two-letter country codes defined in ISO 3166-1 alpha-2 (e.g., 'US' for United States). |
2 |
token
|
String(50) |
|
|
|
|
The unique value generated by the system that securely represents sensitive payment data without exposing actual card or bank details.\n\r\n> **Attention:** This field contains sensitive information and should be handled securely. |
3 |
accountAccessory
|
String(80) |
|
|
|
|
The card expiration date (for credit cards) or routing number (for bank accounts).\n\r\n> **Note:** For payment cards, format is MMYY (e.g., '1225' for December 2025). For bank accounts, this contains the routing number. |
4 |
holderName
|
String(150) |
|
|
|
|
The calculated field that combines the 'firstName' and 'lastName' values from the request.\n\r\n> **Note:** Maximum length is 150 characters. |
5 |
address
|
String |
|
|
|
|
The customer's complete address.\n\r\n> **Note:** The value is a concatenation of the street1, street2, city, state, zipCode, and countryCode field values. Maximum length is 100 characters. |
6 |
createDate
|
Datetime |
|
|
|
|
The date when the record was created.\n\r\n> **Note:** In the response, the date is returned with hour, minute, and second values, formatted as yyyy-MM-dd HH:mm:ss. |
7 |
id
|
Long |
|
|
|
|
The identifier of the object used for references; auto-incremented integer value.\n\r\n> **Note:** This is the primary system-generated identifier for the payment option. |
8 |
tokenCode
|
String(512) |
|
|
|
|
The code of the token associated with the payment option.\n\r\n> **Note:** This value can be used for future transactions with this payment method. |
9 |
createDate
|
Datetime |
|
|
|
|
The date when the record was created.\n\r\n> **Note:** In the response, the date is returned with hour, minute, and second values, formatted as yyyy-MM-dd HH:mm:ss. |
10 |
type
|
|
|
|
|
|
The type of the payment method. |
11 |
isActive
|
Boolean |
|
|
|
|
The status indicator that shows whether a record is active within the system.\n\r\n> **Note:** Possible values: true (1) or false (0). Default: `true` (1). |
12 |
csc
|
String |
|
|
|
|
The card security code (three digits on the back of a payment card).\n\r\n> **Note:** This field is typically not returned in the response for security reasons.\n\r\n> **Attention:** This field contains sensitive security information. |
13 |
street1
|
String(128) |
|
|
|
|
The customer's street address (line 1).\n\r\n> **Note:** Maximum length is 128 characters. |
14 |
street2
|
String(128) |
|
|
|
|
The customer's street address (line 2).\n\r\n> **Note:** Maximum length is 128 characters. |
15 |
city
|
String(50) |
|
|
|
|
The customer's city.\n\r\n> **Note:** Maximum length is 50 characters. |
16 |
state
|
String(3) |
|
|
|
|
The customer's state.\n\r\n> **Note:** For US addresses, this is the two-letter state code. Format depends on the associated country code. |
17 |
zipCode
|
String(15) |
|
|
|
|
The customer's ZIP or postal code.\n\r\n> **Note:** Format depends on the associated country code. Maximum length is 15 characters. |
18 |
customerId
|
Long |
|
|
|
|
The ID of the customer in the system.\n\r\n> **Note:** This field establishes the relationship between the payment option and customer records. |
19 |
code
|
String(60) |
|
|
|
|
The optional secondary identifier supplied by the external/user's system.\n\r\n> **Note:** Typically a reference to an ID in your own system. By default, this value is set to the same as the object's id returned in the response. |
20 |
accountId
|
Integer |
|
|
|
|
The merchant account associated with this payment option.\n\r\n> **Note:** Your API credentials may be associated with more than one accountId. |
21 |
address
|
String |
|
|
|
|
The customer's complete address.\n\r\n> **Note:** The value is a concatenation of the street1, street2, city, state, zipCode, and countryCode field values. Maximum length is 100 characters. |
22 |
token
|
String |
|
|
|
|
The unique value generated by the system that securely represents sensitive payment data without exposing actual card or bank details.\n\r\n> **Attention:** This field contains sensitive information and should be handled securely. |
23 |
state
|
String(3) |
|
|
|
|
The customer's state.\n\r\n> **Note:** For US addresses, this is the two-letter state code. Format depends on the associated country code. |
24 |
zipCode
|
String(15) |
|
|
|
|
The customer's ZIP or postal code.\n\r\n> **Note:** Format depends on the associated country code. Maximum length is 15 characters. |
25 |
tokenCode
|
String(512) |
|
|
|
|
The code of the token associated with the payment option.\n\r\n> **Note:** This value can be used for future transactions with this payment method. |
26 |
token
|
String |
|
|
|
|
The unique value generated by the system that securely represents sensitive payment data without exposing actual card or bank details.\n\r\n> **Attention:** This field contains sensitive information and should be handled securely. |
27 |
accountNumber
|
String(80) |
|
|
|
|
The credit card or bank account number.\n\r\n> **Note:** This field is typically masked in the response for security reasons, showing only the last 4 digits of the actual number.\n\r\n> **Attention:** This field contains sensitive payment information and should be handled securely. |
Method: POST
Implicit: Yes
Consumes: json,xml
Produces: json,xml
Updates the selected payment option with the specified values.
# |
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. |
2 |
payment-option-id |
Long |
|
|
|
|
Unique PaymentOption ID generated by the system. |
# |
Name |
Type |
Pattern |
Format |
Mode |
Usage |
Description |
1 |
countryCode |
String(3) |
|
|
|
|
The customer's country code.\n\r\n> **Note:** Use standard two-letter country codes defined in ISO 3166-1 alpha-2 (e.g., 'US' for United States). |
2 |
token |
String(50) |
|
|
|
|
The unique value generated by the system that securely represents sensitive payment data without exposing actual card or bank details.\n\r\n> **Attention:** This field contains sensitive information and should be handled securely. |
3 |
accountAccessory |
String(80) |
|
|
|
|
The card expiration date (for credit cards) or routing number (for bank accounts) used during transaction processing. This field is required even when using a token.\n\r\n> **Note:** For payment cards, format as MMYY (e.g., '1225' for December 2025). For bank accounts, provide the routing number. Maximum length is 10 characters. |
4 |
holderName |
String(150) |
|
|
|
|
The calculated field that combines the 'firstName' and 'lastName' values from the request.\n\r\n> **Note:** Maximum length is 150 characters. This field is automatically populated based on customer information. |
10 |
type |
|
|
|
|
|
The type of payment option that will be created. |
11 |
isActive |
Boolean |
|
|
|
|
The status of the payment option.\n\r\n> **Note:** Possible values: true (active) or false (inactive). Default: `true`. |
12 |
csc |
String |
|
|
|
|
The card security code (three digits on the back of a payment card).\n\r\n> **Note:** Maximum length is 4 characters to accommodate American Express cards that have a 4-digit security code. |
13 |
street1 |
String(128) |
|
|
|
|
The customer's street address (line 1).\n\r\n> **Note:** Maximum length is 128 characters.\n\r\n> **Tip:** Including accurate billing address information improves approval rates and may lower interchange costs. |
14 |
street2 |
String(128) |
|
|
|
|
The customer's secondary street address (line 2).\n\r\n> **Note:** Additional street data such as apartment or suite number. Maximum length is 128 characters. |
15 |
city |
String(50) |
|
|
|
|
The customer's city.\n\r\n> **Note:** Maximum length is 50 characters. |
16 |
state |
String(3) |
|
|
|
|
The customer's state.\n\r\n> **Note:** State value format is subject to the associated country code. For US addresses, use the two-letter state code. |
17 |
zipCode |
String(15) |
|
|
|
|
The customer's ZIP or postal code.\n\r\n> **Note:** Format is subject to the associated country code. Maximum length is 15 characters. |
19 |
code |
String(60) |
|
|
|
|
The unique payment option ID supplied by the external/user's system.\n\r\n> **Note:** Optional secondary identifier. Typically a reference to an ID in your own system. If not provided, the system will use the object's id generated at creation time. |
20 |
accountId |
Integer |
|
|
|
|
The merchant account associated with the payment option.\n\r\n> **Note:** If your API user is associated with multiple merchant accounts, you can specify the merchant account ID to reduce the data set in API responses. Your credentials may be associated with more than one accountId. |
22 |
token |
String |
|
|
|
|
The unique value generated by the system that securely represents sensitive payment data without exposing actual card or bank details.\n\r\n> **Attention:** This field contains sensitive information and should be handled securely. |
23 |
state |
String(3) |
|
|
|
|
The customer's state.\n\r\n> **Note:** State value format is subject to the associated country code. For US addresses, use the two-letter state code. |
24 |
zipCode |
String(15) |
|
|
|
|
The customer's ZIP or postal code.\n\r\n> **Note:** Format is subject to the associated country code. Maximum length is 15 characters. |
26 |
token |
String |
|
|
|
|
The unique value generated by the system that securely represents sensitive payment data without exposing actual card or bank details.\n\r\n> **Attention:** This field contains sensitive information and should be handled securely. |
27 |
accountNumber |
String(80) |
|
|
|
|
The credit card or bank account number used during transaction processing. This field is required if you are not using a token for the transaction.\n\r\n> **Note:** Maximum length is 20 characters with no spaces or special characters.\n\r\n> **Attention:** This field contains sensitive cardholder data that will be replaced with a secure token after processing. |
~modify (response)
Method: POST
Implicit: Yes
Consumes: json,xml
Produces: json,xml
Updates the selected payment option with the specified values.
# |
Name |
Type |
Pattern |
Format |
Mode |
Usage |
Description |
1 |
countryCode
|
String(3) |
|
|
|
|
The customer's country code.\n\r\n> **Note:** Uses standard two-letter country codes defined in ISO 3166-1 alpha-2 (e.g., 'US' for United States). |
2 |
token
|
String(50) |
|
|
|
|
The unique value generated by the system that securely represents sensitive payment data without exposing actual card or bank details.\n\r\n> **Attention:** This field contains sensitive information and should be handled securely. |
3 |
accountAccessory
|
String(80) |
|
|
|
|
The card expiration date (for credit cards) or routing number (for bank accounts).\n\r\n> **Note:** For payment cards, format is MMYY (e.g., '1225' for December 2025). For bank accounts, this contains the routing number. |
4 |
holderName
|
String(150) |
|
|
|
|
The calculated field that combines the 'firstName' and 'lastName' values from the request.\n\r\n> **Note:** Maximum length is 150 characters. |
5 |
address
|
String |
|
|
|
|
The customer's complete address.\n\r\n> **Note:** The value is a concatenation of the street1, street2, city, state, zipCode, and countryCode field values. Maximum length is 100 characters. |
6 |
createDate
|
Datetime |
|
|
|
|
The date when the record was created.\n\r\n> **Note:** In the response, the date is returned with hour, minute, and second values, formatted as yyyy-MM-dd HH:mm:ss. |
7 |
id
|
Long |
|
|
|
|
The identifier of the object used for references; auto-incremented integer value.\n\r\n> **Note:** This is the primary system-generated identifier for the payment option. |
8 |
tokenCode
|
String(512) |
|
|
|
|
The code of the token associated with the payment option.\n\r\n> **Note:** This value can be used for future transactions with this payment method. |
9 |
createDate
|
Datetime |
|
|
|
|
The date when the record was created.\n\r\n> **Note:** In the response, the date is returned with hour, minute, and second values, formatted as yyyy-MM-dd HH:mm:ss. |
10 |
type
|
|
|
|
|
|
The type of the payment method. |
11 |
isActive
|
Boolean |
|
|
|
|
The status indicator that shows whether a record is active within the system.\n\r\n> **Note:** Possible values: true (1) or false (0). Default: `true` (1). |
12 |
csc
|
String |
|
|
|
|
The card security code (three digits on the back of a payment card).\n\r\n> **Note:** This field is typically not returned in the response for security reasons.\n\r\n> **Attention:** This field contains sensitive security information. |
13 |
street1
|
String(128) |
|
|
|
|
The customer's street address (line 1).\n\r\n> **Note:** Maximum length is 128 characters. |
14 |
street2
|
String(128) |
|
|
|
|
The customer's street address (line 2).\n\r\n> **Note:** Maximum length is 128 characters. |
15 |
city
|
String(50) |
|
|
|
|
The customer's city.\n\r\n> **Note:** Maximum length is 50 characters. |
16 |
state
|
String(3) |
|
|
|
|
The customer's state.\n\r\n> **Note:** For US addresses, this is the two-letter state code. Format depends on the associated country code. |
17 |
zipCode
|
String(15) |
|
|
|
|
The customer's ZIP or postal code.\n\r\n> **Note:** Format depends on the associated country code. Maximum length is 15 characters. |
18 |
customerId
|
Long |
|
|
|
|
The ID of the customer in the system.\n\r\n> **Note:** This field establishes the relationship between the payment option and customer records. |
19 |
code
|
String(60) |
|
|
|
|
The optional secondary identifier supplied by the external/user's system.\n\r\n> **Note:** Typically a reference to an ID in your own system. By default, this value is set to the same as the object's id returned in the response. |
20 |
accountId
|
Integer |
|
|
|
|
The merchant account associated with this payment option.\n\r\n> **Note:** Your API credentials may be associated with more than one accountId. |
21 |
address
|
String |
|
|
|
|
The customer's complete address.\n\r\n> **Note:** The value is a concatenation of the street1, street2, city, state, zipCode, and countryCode field values. Maximum length is 100 characters. |
22 |
token
|
String |
|
|
|
|
The unique value generated by the system that securely represents sensitive payment data without exposing actual card or bank details.\n\r\n> **Attention:** This field contains sensitive information and should be handled securely. |
23 |
state
|
String(3) |
|
|
|
|
The customer's state.\n\r\n> **Note:** For US addresses, this is the two-letter state code. Format depends on the associated country code. |
24 |
zipCode
|
String(15) |
|
|
|
|
The customer's ZIP or postal code.\n\r\n> **Note:** Format depends on the associated country code. Maximum length is 15 characters. |
25 |
tokenCode
|
String(512) |
|
|
|
|
The code of the token associated with the payment option.\n\r\n> **Note:** This value can be used for future transactions with this payment method. |
26 |
token
|
String |
|
|
|
|
The unique value generated by the system that securely represents sensitive payment data without exposing actual card or bank details.\n\r\n> **Attention:** This field contains sensitive information and should be handled securely. |
27 |
accountNumber
|
String(80) |
|
|
|
|
The credit card or bank account number.\n\r\n> **Note:** This field is typically masked in the response for security reasons, showing only the last 4 digits of the actual number.\n\r\n> **Attention:** This field contains sensitive payment information and should be handled securely. |
Method: POST
Implicit: No
Consumes: json,xml
Produces: json,xml
Creates and processes a transaction based on the specified payment option.
# |
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. |
2 |
payment-option-id |
Long |
|
|
|
|
Unique PaymentOption ID generated by the system. |
~process (response)
Method: POST
Implicit: No
Consumes: json,xml
Produces: json,xml
Creates and processes a transaction based on the specified payment option.
# |
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. |
|