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
Creates a transaction associated with the specified customer.
# |
Name |
Type |
Pattern |
Format |
Mode |
Usage |
Description |
1 |
customer-id |
Long |
|
|
|
|
Unique Customer ID generated by the system. For more information see term: Customer. |
# |
Name |
Type |
Pattern |
Format |
Mode |
Usage |
Description |
1 |
feeAmount |
Integer |
|
|
|
|
Fee amount (in cents) that will be associated with the transaction processing. |
2 |
taxAmount |
Integer |
|
|
|
|
|
9 |
invoiceList |
String(250) |
|
|
|
|
List of invoice references that are expected to be covered by this transaction. |
11 |
accountId |
Integer |
|
|
|
|
|
12 |
customerId |
Long |
|
|
|
|
|
14 |
dueDate |
Date |
|
|
|
|
The date must be submitted in yyyy-MM-dd format. |
15 |
type |
|
|
|
|
|
|
16 |
amount |
Integer |
|
|
|
|
|
18 |
note |
String(255) |
|
|
|
|
|
19 |
accountType |
|
|
|
|
|
|
20 |
accountNumber |
String(19) |
|
|
|
|
|
21 |
creatorCode |
String(60) |
|
|
|
|
|
23 |
code |
String(60) |
|
|
|
|
|
26 |
feeAmount |
Integer |
|
|
|
|
|
~create (response)
Method: PUT
Implicit: Yes
Consumes: json,xml
Produces: json,xml
Creates a transaction associated with the specified customer.
# |
Name |
Type |
Pattern |
Format |
Mode |
Usage |
Description |
1 |
feeAmount
|
Integer |
|
|
|
|
Fee amount used for filtering Transaction records. |
2 |
taxAmount
|
Integer |
|
|
|
|
|
3 |
adjustmentId
|
Long |
|
|
|
|
Identifier of an Adjustment that a Transaction is associated with. |
4 |
balance
|
Integer |
|
|
|
|
Current balance of the Transaction. |
5 |
createDate
|
Datetime |
|
|
|
|
Date when the Transaction was created. Note: Date format: yyyy-MM-dd. |
6 |
id
|
Long |
|
|
|
|
Unique Transaction ID generated by the system. |
7 |
processingInfo
|
ProcessingInfo |
|
|
|
|
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 |
|
|
|
|
Card expiration date or bank routing number. Note: This field is required even if it is used with a token. |
7.2 |
accountNumber
|
String |
|
|
|
|
Number of a payment card or bank account. |
7.3 |
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. |
7.4 |
approvalCode
|
String(60) |
|
|
|
|
Code of the approval status of the transaction provided by the payment provider. |
7.5 |
city
|
String(50) |
|
|
|
|
City of the Customer. |
7.6 |
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. |
7.7 |
email
|
String(100) |
|
|
|
|
Email address of the Customer. |
7.8 |
gatewayTransactionId
|
String(20) |
|
|
|
|
Identifier of a Transaction (Processing) that the current transaction is associated with. |
7.9 |
holderName
|
String(150) |
|
|
|
|
Combined values fo the firsetName and lastName in the Customer. |
7.10 |
id
|
Long |
|
|
|
|
Unique ProcesingInfo ID generated by the system. |
7.11 |
phone
|
String(20) |
|
|
|
|
Phone number of the Customer. |
7.12 |
responseCode
|
String(3) |
|
|
|
|
Code providing an explanation of the outcome of the request. |
7.13 |
responseDate
|
Datetime |
|
|
|
|
Date when the response to the transaction was received. |
7.14 |
responseMessage
|
String(255) |
|
|
|
|
Response details associated with a processing request, generated by the gateway. |
7.15 |
state
|
String(3) |
|
|
|
|
State of the Customer. Note: State value format is subject to the associated country code in the Customer object. |
7.16 |
street
|
String(128) |
|
|
|
|
Street address of the Customer. |
7.17 |
token
|
String(512) |
|
|
|
|
Unique random characters generated by the system for identifying and securely transmitting sensitive data. |
7.18 |
zipCode
|
String(15) |
|
|
|
|
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 |
|
|
|
|
|
7.20 |
createDate
|
Datetime |
|
|
|
|
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) |
|
|
|
|
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 |
|
|
|
|
|
7.23 |
accountAccessory
|
String |
|
|
|
|
|
7.24 |
token
|
String(512) |
|
|
|
|
|
7.25 |
street
|
String(128) |
|
|
|
|
|
7.26 |
city
|
String(50) |
|
|
|
|
|
7.27 |
state
|
String(3) |
|
|
|
|
|
7.28 |
zipCode
|
String(15) |
|
|
|
|
|
7.29 |
phone
|
String(20) |
|
|
|
|
|
7.30 |
email
|
String(100) |
|
|
|
|
|
7.31 |
gatewayTransactionId
|
String(20) |
|
|
|
|
|
7.32 |
approvalCode
|
String(60) |
|
|
|
|
|
7.33 |
responseDate
|
Datetime |
|
|
|
|
In API response, the date is returned in yyyy-MM-dd HH:mm:ss format. |
7.34 |
responseCode
|
String(3) |
|
|
|
|
|
7.35 |
responseMessage
|
String(255) |
|
|
|
|
|
7.36 |
address
|
String |
|
|
|
|
|
8 |
subscriptionId
|
Long |
|
|
|
|
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. |
9 |
invoiceList
|
String(250) |
|
|
|
|
List of invoice references used for filtering records. |
10 |
id
|
Long |
|
|
|
|
|
11 |
accountId
|
Integer |
|
|
|
|
|
12 |
customerId
|
Long |
|
|
|
|
|
13 |
createDate
|
Datetime |
|
|
|
|
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 |
|
|
|
|
The date must be submitted in yyyy-MM-dd format. |
15 |
type
|
|
|
|
|
|
|
16 |
amount
|
Integer |
|
|
|
|
|
17 |
balance
|
Integer |
|
|
|
|
|
18 |
note
|
String(255) |
|
|
|
|
|
19 |
accountType
|
|
|
|
|
|
|
20 |
accountNumber
|
String(19) |
|
|
|
|
|
21 |
creatorCode
|
String(60) |
|
|
|
|
|
22 |
processingInfo
|
ProcessingInfo |
|
|
|
|
|
22.1 |
accountAccessory
|
String |
|
|
|
|
Card expiration date or bank routing number. Note: This field is required even if it is used with a token. |
22.2 |
accountNumber
|
String |
|
|
|
|
Number of a payment card or bank account. |
22.3 |
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. |
22.4 |
approvalCode
|
String(60) |
|
|
|
|
Code of the approval status of the transaction provided by the payment provider. |
22.5 |
city
|
String(50) |
|
|
|
|
City of the Customer. |
22.6 |
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. |
22.7 |
email
|
String(100) |
|
|
|
|
Email address of the Customer. |
22.8 |
gatewayTransactionId
|
String(20) |
|
|
|
|
Identifier of a Transaction (Processing) that the current transaction is associated with. |
22.9 |
holderName
|
String(150) |
|
|
|
|
Combined values fo the firsetName and lastName in the Customer. |
22.10 |
id
|
Long |
|
|
|
|
Unique ProcesingInfo ID generated by the system. |
22.11 |
phone
|
String(20) |
|
|
|
|
Phone number of the Customer. |
22.12 |
responseCode
|
String(3) |
|
|
|
|
Code providing an explanation of the outcome of the request. |
22.13 |
responseDate
|
Datetime |
|
|
|
|
Date when the response to the transaction was received. |
22.14 |
responseMessage
|
String(255) |
|
|
|
|
Response details associated with a processing request, generated by the gateway. |
22.15 |
state
|
String(3) |
|
|
|
|
State of the Customer. Note: State value format is subject to the associated country code in the Customer object. |
22.16 |
street
|
String(128) |
|
|
|
|
Street address of the Customer. |
22.17 |
token
|
String(512) |
|
|
|
|
Unique random characters generated by the system for identifying and securely transmitting sensitive data. |
22.18 |
zipCode
|
String(15) |
|
|
|
|
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 |
|
|
|
|
|
22.20 |
createDate
|
Datetime |
|
|
|
|
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) |
|
|
|
|
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 |
|
|
|
|
|
22.23 |
accountAccessory
|
String |
|
|
|
|
|
22.24 |
token
|
String(512) |
|
|
|
|
|
22.25 |
street
|
String(128) |
|
|
|
|
|
22.26 |
city
|
String(50) |
|
|
|
|
|
22.27 |
state
|
String(3) |
|
|
|
|
|
22.28 |
zipCode
|
String(15) |
|
|
|
|
|
22.29 |
phone
|
String(20) |
|
|
|
|
|
22.30 |
email
|
String(100) |
|
|
|
|
|
22.31 |
gatewayTransactionId
|
String(20) |
|
|
|
|
|
22.32 |
approvalCode
|
String(60) |
|
|
|
|
|
22.33 |
responseDate
|
Datetime |
|
|
|
|
In API response, the date is returned in yyyy-MM-dd HH:mm:ss format. |
22.34 |
responseCode
|
String(3) |
|
|
|
|
|
22.35 |
responseMessage
|
String(255) |
|
|
|
|
|
22.36 |
address
|
String |
|
|
|
|
|
23 |
code
|
String(60) |
|
|
|
|
|
24 |
adjustmentId
|
Long |
|
|
|
|
|
25 |
subscriptionId
|
Long |
|
|
|
|
|
26 |
feeAmount
|
Integer |
|
|
|
|
|
~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 |
|
|
|
|
Unique Customer ID generated by the system. For more information see term: Customer. |
# |
Name |
Type |
Pattern |
Format |
Mode |
Usage |
Description |
1 |
offset |
Integer |
|
|
|
|
Index of the first record returned to the customer from the search result of a web search. |
2 |
limit |
Integer |
|
|
|
|
Maximum number of records to load per single search web call made by the customer. |
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 |
feeAmount
|
Integer |
|
|
|
|
Fee amount (in cents) associated with the transaction processing. |
2 |
taxAmount
|
Integer |
|
|
|
|
|
3 |
adjustmentId
|
Long |
|
|
|
|
Identifier of an Adjustment that a Transaction is associated with. |
4 |
balance
|
Integer |
|
|
|
|
Current balance of the Transaction. |
5 |
createDate
|
Datetime |
|
|
|
|
Date when the Transaction was created. Note: Date format: yyyy-MM-dd. |
6 |
id
|
Long |
|
|
|
|
Unique Transaction ID generated by the system. |
7 |
processingInfo
|
ProcessingInfo |
|
|
|
|
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 |
|
|
|
|
Card expiration date or bank routing number. Note: This field is required even if it is used with a token. |
7.2 |
accountNumber
|
String |
|
|
|
|
Number of a payment card or bank account. |
7.3 |
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. |
7.4 |
approvalCode
|
String(60) |
|
|
|
|
Code of the approval status of the transaction provided by the payment provider. |
7.5 |
city
|
String(50) |
|
|
|
|
City of the Customer. |
7.6 |
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. |
7.7 |
email
|
String(100) |
|
|
|
|
Email address of the Customer. |
7.8 |
gatewayTransactionId
|
String(20) |
|
|
|
|
Identifier of a Transaction (Processing) that the current transaction is associated with. |
7.9 |
holderName
|
String(150) |
|
|
|
|
Combined values fo the firsetName and lastName in the Customer. |
7.10 |
id
|
Long |
|
|
|
|
Unique ProcesingInfo ID generated by the system. |
7.11 |
phone
|
String(20) |
|
|
|
|
Phone number of the Customer. |
7.12 |
responseCode
|
String(3) |
|
|
|
|
Code providing an explanation of the outcome of the request. |
7.13 |
responseDate
|
Datetime |
|
|
|
|
Date when the response to the transaction was received. |
7.14 |
responseMessage
|
String(255) |
|
|
|
|
Response details associated with a processing request, generated by the gateway. |
7.15 |
state
|
String(3) |
|
|
|
|
State of the Customer. Note: State value format is subject to the associated country code in the Customer object. |
7.16 |
street
|
String(128) |
|
|
|
|
Street address of the Customer. |
7.17 |
token
|
String(512) |
|
|
|
|
Unique random characters generated by the system for identifying and securely transmitting sensitive data. |
7.18 |
zipCode
|
String(15) |
|
|
|
|
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 |
|
|
|
|
|
7.20 |
createDate
|
Datetime |
|
|
|
|
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) |
|
|
|
|
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 |
|
|
|
|
|
7.23 |
accountAccessory
|
String |
|
|
|
|
|
7.24 |
token
|
String(512) |
|
|
|
|
|
7.25 |
street
|
String(128) |
|
|
|
|
|
7.26 |
city
|
String(50) |
|
|
|
|
|
7.27 |
state
|
String(3) |
|
|
|
|
|
7.28 |
zipCode
|
String(15) |
|
|
|
|
|
7.29 |
phone
|
String(20) |
|
|
|
|
|
7.30 |
email
|
String(100) |
|
|
|
|
|
7.31 |
gatewayTransactionId
|
String(20) |
|
|
|
|
|
7.32 |
approvalCode
|
String(60) |
|
|
|
|
|
7.33 |
responseDate
|
Datetime |
|
|
|
|
In API response, the date is returned in yyyy-MM-dd HH:mm:ss format. |
7.34 |
responseCode
|
String(3) |
|
|
|
|
|
7.35 |
responseMessage
|
String(255) |
|
|
|
|
|
7.36 |
address
|
String |
|
|
|
|
|
8 |
subscriptionId
|
Long |
|
|
|
|
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. |
9 |
invoiceList
|
String(250) |
|
|
|
|
List of invoice references that are expected to be covered by this transaction. |
10 |
id
|
Long |
|
|
|
|
|
11 |
accountId
|
Integer |
|
|
|
|
|
12 |
customerId
|
Long |
|
|
|
|
|
13 |
createDate
|
Datetime |
|
|
|
|
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 |
|
|
|
|
The date must be submitted in yyyy-MM-dd format. |
15 |
type
|
|
|
|
|
|
|
16 |
amount
|
Integer |
|
|
|
|
|
17 |
balance
|
Integer |
|
|
|
|
|
18 |
note
|
String(255) |
|
|
|
|
|
19 |
accountType
|
|
|
|
|
|
|
20 |
accountNumber
|
String(19) |
|
|
|
|
|
21 |
creatorCode
|
String(60) |
|
|
|
|
|
22 |
processingInfo
|
ProcessingInfo |
|
|
|
|
|
22.1 |
accountAccessory
|
String |
|
|
|
|
Card expiration date or bank routing number. Note: This field is required even if it is used with a token. |
22.2 |
accountNumber
|
String |
|
|
|
|
Number of a payment card or bank account. |
22.3 |
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. |
22.4 |
approvalCode
|
String(60) |
|
|
|
|
Code of the approval status of the transaction provided by the payment provider. |
22.5 |
city
|
String(50) |
|
|
|
|
City of the Customer. |
22.6 |
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. |
22.7 |
email
|
String(100) |
|
|
|
|
Email address of the Customer. |
22.8 |
gatewayTransactionId
|
String(20) |
|
|
|
|
Identifier of a Transaction (Processing) that the current transaction is associated with. |
22.9 |
holderName
|
String(150) |
|
|
|
|
Combined values fo the firsetName and lastName in the Customer. |
22.10 |
id
|
Long |
|
|
|
|
Unique ProcesingInfo ID generated by the system. |
22.11 |
phone
|
String(20) |
|
|
|
|
Phone number of the Customer. |
22.12 |
responseCode
|
String(3) |
|
|
|
|
Code providing an explanation of the outcome of the request. |
22.13 |
responseDate
|
Datetime |
|
|
|
|
Date when the response to the transaction was received. |
22.14 |
responseMessage
|
String(255) |
|
|
|
|
Response details associated with a processing request, generated by the gateway. |
22.15 |
state
|
String(3) |
|
|
|
|
State of the Customer. Note: State value format is subject to the associated country code in the Customer object. |
22.16 |
street
|
String(128) |
|
|
|
|
Street address of the Customer. |
22.17 |
token
|
String(512) |
|
|
|
|
Unique random characters generated by the system for identifying and securely transmitting sensitive data. |
22.18 |
zipCode
|
String(15) |
|
|
|
|
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 |
|
|
|
|
|
22.20 |
createDate
|
Datetime |
|
|
|
|
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) |
|
|
|
|
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 |
|
|
|
|
|
22.23 |
accountAccessory
|
String |
|
|
|
|
|
22.24 |
token
|
String(512) |
|
|
|
|
|
22.25 |
street
|
String(128) |
|
|
|
|
|
22.26 |
city
|
String(50) |
|
|
|
|
|
22.27 |
state
|
String(3) |
|
|
|
|
|
22.28 |
zipCode
|
String(15) |
|
|
|
|
|
22.29 |
phone
|
String(20) |
|
|
|
|
|
22.30 |
email
|
String(100) |
|
|
|
|
|
22.31 |
gatewayTransactionId
|
String(20) |
|
|
|
|
|
22.32 |
approvalCode
|
String(60) |
|
|
|
|
|
22.33 |
responseDate
|
Datetime |
|
|
|
|
In API response, the date is returned in yyyy-MM-dd HH:mm:ss format. |
22.34 |
responseCode
|
String(3) |
|
|
|
|
|
22.35 |
responseMessage
|
String(255) |
|
|
|
|
|
22.36 |
address
|
String |
|
|
|
|
|
23 |
code
|
String(60) |
|
|
|
|
|
24 |
adjustmentId
|
Long |
|
|
|
|
|
25 |
subscriptionId
|
Long |
|
|
|
|
|
26 |
feeAmount
|
Integer |
|
|
|
|
|
~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 |
|
|
|
|
Unique Customer ID generated by the system. For more information see term: Customer. |
~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 |
feeAmount
|
Integer |
|
|
|
|
Fee amount used for filtering Transaction records. |
2 |
taxAmount
|
Integer |
|
|
|
|
|
3 |
adjustmentId
|
Long |
|
|
|
|
Identifier of an Adjustment that a Transaction is associated with. |
4 |
balance
|
Integer |
|
|
|
|
Current balance of the Transaction. |
5 |
createDate
|
Datetime |
|
|
|
|
Date when the Transaction was created. Note: Date format: yyyy-MM-dd. |
6 |
id
|
Long |
|
|
|
|
Unique Transaction ID generated by the system. |
7 |
processingInfo
|
ProcessingInfo |
|
|
|
|
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 |
|
|
|
|
Card expiration date or bank routing number. Note: This field is required even if it is used with a token. |
7.2 |
accountNumber
|
String |
|
|
|
|
Number of a payment card or bank account. |
7.3 |
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. |
7.4 |
approvalCode
|
String(60) |
|
|
|
|
Code of the approval status of the transaction provided by the payment provider. |
7.5 |
city
|
String(50) |
|
|
|
|
City of the Customer. |
7.6 |
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. |
7.7 |
email
|
String(100) |
|
|
|
|
Email address of the Customer. |
7.8 |
gatewayTransactionId
|
String(20) |
|
|
|
|
Identifier of a Transaction (Processing) that the current transaction is associated with. |
7.9 |
holderName
|
String(150) |
|
|
|
|
Combined values fo the firsetName and lastName in the Customer. |
7.10 |
id
|
Long |
|
|
|
|
Unique ProcesingInfo ID generated by the system. |
7.11 |
phone
|
String(20) |
|
|
|
|
Phone number of the Customer. |
7.12 |
responseCode
|
String(3) |
|
|
|
|
Code providing an explanation of the outcome of the request. |
7.13 |
responseDate
|
Datetime |
|
|
|
|
Date when the response to the transaction was received. |
7.14 |
responseMessage
|
String(255) |
|
|
|
|
Response details associated with a processing request, generated by the gateway. |
7.15 |
state
|
String(3) |
|
|
|
|
State of the Customer. Note: State value format is subject to the associated country code in the Customer object. |
7.16 |
street
|
String(128) |
|
|
|
|
Street address of the Customer. |
7.17 |
token
|
String(512) |
|
|
|
|
Unique random characters generated by the system for identifying and securely transmitting sensitive data. |
7.18 |
zipCode
|
String(15) |
|
|
|
|
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 |
|
|
|
|
|
7.20 |
createDate
|
Datetime |
|
|
|
|
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) |
|
|
|
|
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 |
|
|
|
|
|
7.23 |
accountAccessory
|
String |
|
|
|
|
|
7.24 |
token
|
String(512) |
|
|
|
|
|
7.25 |
street
|
String(128) |
|
|
|
|
|
7.26 |
city
|
String(50) |
|
|
|
|
|
7.27 |
state
|
String(3) |
|
|
|
|
|
7.28 |
zipCode
|
String(15) |
|
|
|
|
|
7.29 |
phone
|
String(20) |
|
|
|
|
|
7.30 |
email
|
String(100) |
|
|
|
|
|
7.31 |
gatewayTransactionId
|
String(20) |
|
|
|
|
|
7.32 |
approvalCode
|
String(60) |
|
|
|
|
|
7.33 |
responseDate
|
Datetime |
|
|
|
|
In API response, the date is returned in yyyy-MM-dd HH:mm:ss format. |
7.34 |
responseCode
|
String(3) |
|
|
|
|
|
7.35 |
responseMessage
|
String(255) |
|
|
|
|
|
7.36 |
address
|
String |
|
|
|
|
|
8 |
subscriptionId
|
Long |
|
|
|
|
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. |
9 |
invoiceList
|
String(250) |
|
|
|
|
List of invoice references used for filtering records. |
10 |
id
|
Long |
|
|
|
|
|
11 |
accountId
|
Integer |
|
|
|
|
|
12 |
customerId
|
Long |
|
|
|
|
|
13 |
createDate
|
Datetime |
|
|
|
|
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 |
|
|
|
|
The date must be submitted in yyyy-MM-dd format. |
15 |
type
|
|
|
|
|
|
|
16 |
amount
|
Integer |
|
|
|
|
|
17 |
balance
|
Integer |
|
|
|
|
|
18 |
note
|
String(255) |
|
|
|
|
|
19 |
accountType
|
|
|
|
|
|
|
20 |
accountNumber
|
String(19) |
|
|
|
|
|
21 |
creatorCode
|
String(60) |
|
|
|
|
|
22 |
processingInfo
|
ProcessingInfo |
|
|
|
|
|
22.1 |
accountAccessory
|
String |
|
|
|
|
Card expiration date or bank routing number. Note: This field is required even if it is used with a token. |
22.2 |
accountNumber
|
String |
|
|
|
|
Number of a payment card or bank account. |
22.3 |
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. |
22.4 |
approvalCode
|
String(60) |
|
|
|
|
Code of the approval status of the transaction provided by the payment provider. |
22.5 |
city
|
String(50) |
|
|
|
|
City of the Customer. |
22.6 |
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. |
22.7 |
email
|
String(100) |
|
|
|
|
Email address of the Customer. |
22.8 |
gatewayTransactionId
|
String(20) |
|
|
|
|
Identifier of a Transaction (Processing) that the current transaction is associated with. |
22.9 |
holderName
|
String(150) |
|
|
|
|
Combined values fo the firsetName and lastName in the Customer. |
22.10 |
id
|
Long |
|
|
|
|
Unique ProcesingInfo ID generated by the system. |
22.11 |
phone
|
String(20) |
|
|
|
|
Phone number of the Customer. |
22.12 |
responseCode
|
String(3) |
|
|
|
|
Code providing an explanation of the outcome of the request. |
22.13 |
responseDate
|
Datetime |
|
|
|
|
Date when the response to the transaction was received. |
22.14 |
responseMessage
|
String(255) |
|
|
|
|
Response details associated with a processing request, generated by the gateway. |
22.15 |
state
|
String(3) |
|
|
|
|
State of the Customer. Note: State value format is subject to the associated country code in the Customer object. |
22.16 |
street
|
String(128) |
|
|
|
|
Street address of the Customer. |
22.17 |
token
|
String(512) |
|
|
|
|
Unique random characters generated by the system for identifying and securely transmitting sensitive data. |
22.18 |
zipCode
|
String(15) |
|
|
|
|
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 |
|
|
|
|
|
22.20 |
createDate
|
Datetime |
|
|
|
|
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) |
|
|
|
|
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 |
|
|
|
|
|
22.23 |
accountAccessory
|
String |
|
|
|
|
|
22.24 |
token
|
String(512) |
|
|
|
|
|
22.25 |
street
|
String(128) |
|
|
|
|
|
22.26 |
city
|
String(50) |
|
|
|
|
|
22.27 |
state
|
String(3) |
|
|
|
|
|
22.28 |
zipCode
|
String(15) |
|
|
|
|
|
22.29 |
phone
|
String(20) |
|
|
|
|
|
22.30 |
email
|
String(100) |
|
|
|
|
|
22.31 |
gatewayTransactionId
|
String(20) |
|
|
|
|
|
22.32 |
approvalCode
|
String(60) |
|
|
|
|
|
22.33 |
responseDate
|
Datetime |
|
|
|
|
In API response, the date is returned in yyyy-MM-dd HH:mm:ss format. |
22.34 |
responseCode
|
String(3) |
|
|
|
|
|
22.35 |
responseMessage
|
String(255) |
|
|
|
|
|
22.36 |
address
|
String |
|
|
|
|
|
23 |
code
|
String(60) |
|
|
|
|
|
24 |
adjustmentId
|
Long |
|
|
|
|
|
25 |
subscriptionId
|
Long |
|
|
|
|
|
26 |
feeAmount
|
Integer |
|
|
|
|
|
|