| Attribute/Element | Description | Type | Notes |
|---|---|---|---|
| Id | Unique Id for payment object | Integer | Referenced as PaymentId in future calls related to the transaction including void, refund, and view details |
| Status | Payment Status set by the system | String | See Payment Statuses Expected Responses for new payments are Posted, Authorized or Failed. |
| ProviderAuthCode | A pass-through field that displays the authorization response for the transaction | String | |
| TraceNumber | A pass-through field that displays the processor’s transaction identifier for a successful transaction or the provider’s error message for a failed transaction | String | |
| FailureData | Standardized info detailing why a transaction failed | Object | See Payment Failure Codes |
| CustomerId | The system identifier for the Customer Record associated with the payment. | Integer | |
| CustomerFirstName | The first name of the Customer associated with the payment | String | |
| CustomerLastName: | The last name of the Customer associated with the payment | String | |
| CustomerCompany | The Company, if any, associated with the payment. | String | |
| ReferenceId | Integer | For a refunded payment, the PaymentId for the refund transaction, for a refund transaction the Payment Id for the refunded payment.This field will be “0” in all other cases. | |
| RecurringScheduleId | Integer | If a payment is part of a schedule, the ScheduleId - This field will be “0” in all other cases including one-time payments processed for new customers | |
| PaymentType | Set by the system to identify the transaction type, based on the type of account associated with the AccountId used for the payment | Integer | Valid Values: CC (credit card), ACH |
| PaymentSubType | The type of Credit Card or ACH payment | String | It defaults to “MOTO” for credit card payments and “WEB” for ACH payments if not included or left null. Other Values include “Swipe” for CC and “PPD,” “CCD,” and “TEL” for ACH. |
| PaymentDate | The date the payment was processed | String | Set by the system - This is always the current date |
| ReturnDate | The date an ACH payment was returned | String | Set by the system -This field will always be null for new transactions and will always be null for credit card transactions |
| EstimatedSettleDate: | The date the system expects the transaction to be settled | String | Based on a merchant’s funding time |
| ActualSettledDate | The date the system receives notification that a transaction has actually settled | String | This field will always be null for new transactions |
| CanVoidUntil | The last date on which a transaction may be voided | String | |
| AccountId | The AccountId specified in the Payment Request | Integer | |
| InvoiceId | The InvoiceId, if any, specified in the Payment Request | Integer | |
| Amount | The Amount specified in the Payment Request | Number | If the Payment Request Amount included more than two decimal places, the Response Amount will be rounded to the nearest penny |
| IsDebit | Indicates if the payment was to the customer. | Boolean | false for a payment to a merchant or true for a refund standalone credit. |
| InvoiceNumber | The InvoiceNumber, if any, specified in the Payment Request | String | |
| PurchaseOrderNumber | The PurchaseOrderNumber, if any, specified in the Payment Request | String | |
| OrderId | The OrderId, if any, specified in the Payment Request | String | |
| Description | The Description, if any, specified in the Payment Request | String | |
| Latitude | The Latitude, if any, specified or captured in the Payment Request | Number | |
| Longitude | The Longitude, if any, specified or captured in the Payment Request | Number | |
| SuccessReceiptOptions | The receipt instructions specified in the Payment Request | Object | null indicates the current system default settings were used |
| LastModified | Set by the system, the date and time the transaction record was last modified | String, formatted as datetime in ISO-8601 format | |
| CreatedOn | Set by the system, the date and time the transaction record was created | String, formatted as datetime in ISO-8601 format | The time and date the payment was processed |
| NetworkTransactionId | Value provided by the card network to identify a specific card on file used in transactions of the same sale type. | String | The response to the first successful transaction with a card on file will contain a Network Transaction Id. This id must be retained from the initial successful authorization and is required to be submitted with each subsequent sale or resubmission for a card on file. |