|
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. |
