# List 16
## Structure
`List16`
## Fields
| Name | Type | Tags | Description | Getter | Setter |
| --- | --- | --- | --- | --- | --- |
| `additionalAmounts` | [`?(AdditionalAmount[])`](../../doc/models/additional-amount.md) | Optional | Additional amounts | getAdditionalAmounts(): ?array | setAdditionalAmounts(?array additionalAmounts): void |
| `billingAddress` | [`?BillingAddress`](../../doc/models/billing-address.md) | Optional | Billing Address Object | getBillingAddress(): ?BillingAddress | setBillingAddress(?BillingAddress billingAddress): void |
| `checkinDate` | `?string` | Optional | Checkin Date - The time difference between checkin_date and checkout_date must be less than or equal to 99 days.
**Constraints**: *Maximum Length*: `10`, *Pattern*: `^[\d]{4}-[\d]{2}-[\d]{2}$` | getCheckinDate(): ?string | setCheckinDate(?string checkinDate): void |
| `checkoutDate` | `?string` | Optional | Checkout Date - The time difference between checkin_date and checkout_date must be less than or equal to 99 days.
**Constraints**: *Maximum Length*: `10`, *Pattern*: `^[\d]{4}-[\d]{2}-[\d]{2}$` | getCheckoutDate(): ?string | setCheckoutDate(?string checkoutDate): void |
| `clerkNumber` | `?string` | Optional | Clerk or Employee Identifier
**Constraints**: *Maximum Length*: `16` | getClerkNumber(): ?string | setClerkNumber(?string clerkNumber): void |
| `contactApiId` | `?string` | Optional | This can be supplied in place of contact_id if you would like to use a contact for the transaction and are using your own custom api_id's to track contacts in the system.
**Constraints**: *Maximum Length*: `36` | getContactApiId(): ?string | setContactApiId(?string contactApiId): void |
| `contactId` | `?string` | Optional | If contact_id is provided, ensure it belongs to the same location as the transaction. You cannot move transaction across locations.
**Constraints**: *Pattern*: `^(([0-9a-fA-F\-]{24,36})\|(([0-9a-fA-F]{8})-(([0-9a-fA-F]{4}\-){3})([0-9a-fA-F]{12})))$` | getContactId(): ?string | setContactId(?string contactId): void |
| `customData` | `?array` | Optional | A field that allows custom JSON to be entered to store extra data. | getCustomData(): ?array | setCustomData(?array customData): void |
| `customerId` | `?string` | Optional | Can be used by Merchants to identify Contacts in our system by an ID from another system.
**Constraints**: *Maximum Length*: `64` | getCustomerId(): ?string | setCustomerId(?string customerId): void |
| `description` | `?string` | Optional | Description
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `64` | getDescription(): ?string | setDescription(?string description): void |
| `iiasInd` | [`?int(IiasIndEnum)`](../../doc/models/iias-ind-enum.md) | Optional | Possible values are '0', '1','2' | getIiasInd(): ?int | setIiasInd(?int iiasInd): void |
| `imageFront` | `?string` | Optional | A base64 encoded string for the image. Used with Check21 ACH transactions. | getImageFront(): ?string | setImageFront(?string imageFront): void |
| `imageBack` | `?string` | Optional | A base64 encoded string for the image. Used with Check21 ACH transactions. | getImageBack(): ?string | setImageBack(?string imageBack): void |
| `installment` | `?bool` | Optional | Flag that is allowed to be passed on card not present industries to signify the transaction is a fixed installment plan transaction. | getInstallment(): ?bool | setInstallment(?bool installment): void |
| `installmentNumber` | `?int` | Optional | If this is a fixed installment plan and installment field is being passed as 1, then this field must have a vlue of 1-999 specifying the current installment number that is running.
**Constraints**: `>= 1`, `<= 999` | getInstallmentNumber(): ?int | setInstallmentNumber(?int installmentNumber): void |
| `installmentCount` | `?int` | Optional | If this is a fixed installment plan and installment field is being passed as 1, then this field must have a vlue of 1-999 specifying the total number of installments on the plan. This number must be grater than or equal to installment_number.
**Constraints**: `>= 1`, `<= 999` | getInstallmentCount(): ?int | setInstallmentCount(?int installmentCount): void |
| `locationApiId` | `?string` | Optional | This can be supplied in place of location_id for the transaction if you are using your own custom api_id's for your locations.
**Constraints**: *Maximum Length*: `36` | getLocationApiId(): ?string | setLocationApiId(?string locationApiId): void |
| `locationId` | `?string` | Optional | A valid Location Id to associate the transaction with.
**Constraints**: *Pattern*: `^(([0-9a-fA-F\-]{24,36})\|(([0-9a-fA-F]{8})-(([0-9a-fA-F]{4}\-){3})([0-9a-fA-F]{12})))$` | getLocationId(): ?string | setLocationId(?string locationId): void |
| `productTransactionId` | `?string` | Optional | The Product's method (cc/ach) has to match the action. If not provided, the API will use the default configured for the Location.
**Constraints**: *Pattern*: `^(([0-9a-fA-F\-]{24,36})\|(([0-9a-fA-F]{8})-(([0-9a-fA-F]{4}\-){3})([0-9a-fA-F]{12})))$` | getProductTransactionId(): ?string | setProductTransactionId(?string productTransactionId): void |
| `advanceDeposit` | `?bool` | Optional | Advance Deposit | getAdvanceDeposit(): ?bool | setAdvanceDeposit(?bool advanceDeposit): void |
| `noShow` | `?bool` | Optional | Used in Lodging | getNoShow(): ?bool | setNoShow(?bool noShow): void |
| `notificationEmailAddress` | `?string` | Optional | If email is supplied then receipt will be emailed | getNotificationEmailAddress(): ?string | setNotificationEmailAddress(?string notificationEmailAddress): void |
| `orderNumber` | `?string` | Optional | Required for CC transactions , if merchant's deposit account's duplicate check per batch has 'order_number' field
**Constraints**: *Maximum Length*: `32` | getOrderNumber(): ?string | setOrderNumber(?string orderNumber): void |
| `poNumber` | `?string` | Optional | Purchase Order number
**Constraints**: *Maximum Length*: `36` | getPoNumber(): ?string | setPoNumber(?string poNumber): void |
| `quickInvoiceId` | `?string` | Optional | Can be used to associate a transaction to a Quick Invoice. Quick Invoice transactions will have a value for this field automatically.
**Constraints**: *Pattern*: `^(([0-9a-fA-F\-]{24,36})\|(([0-9a-fA-F]{8})-(([0-9a-fA-F]{4}\-){3})([0-9a-fA-F]{12})))$` | getQuickInvoiceId(): ?string | setQuickInvoiceId(?string quickInvoiceId): void |
| `recurring` | [`?Recurring3`](../../doc/models/recurring-3.md) | Optional | Recurring Information on `expand` | getRecurring(): ?Recurring3 | setRecurring(?Recurring3 recurring): void |
| `recurringNumber` | `?int` | Optional | If this is an ongoing recurring and recurring field is being passed as 1, then this field must have a vlue of 1-999 specifying the current recurring number that is running.
**Constraints**: `>= 1`, `<= 999` | getRecurringNumber(): ?int | setRecurringNumber(?int recurringNumber): void |
| `roomNum` | `?string` | Optional | Used in Lodging
**Constraints**: *Maximum Length*: `12` | getRoomNum(): ?string | setRoomNum(?string roomNum): void |
| `roomRate` | `?int` | Optional | Required if merchant industry type is lodging. | getRoomRate(): ?int | setRoomRate(?int roomRate): void |
| `saveAccount` | `?bool` | Optional | Specifies to save account to contacts profile if account_number/track_data is present with either contact_id or contact_api_id in params. | getSaveAccount(): ?bool | setSaveAccount(?bool saveAccount): void |
| `saveAccountTitle` | `?string` | Optional | If saving token while running a transaction, this will be the title of the token.
**Constraints**: *Maximum Length*: `16` | getSaveAccountTitle(): ?string | setSaveAccountTitle(?string saveAccountTitle): void |
| `subtotalAmount` | `?int` | Optional | This field is allowed and required for transactions that have a product where surcharge is configured. Use only integer numbers, so $10.99 will be 1099.
**Constraints**: `>= 0`, `<= 999999999` | getSubtotalAmount(): ?int | setSubtotalAmount(?int subtotalAmount): void |
| `surchargeAmount` | `?int` | Optional | This field is allowed and required for transactions that have a product where surcharge is configured. Use only integer numbers, so $10.99 will be 1099.
**Constraints**: `>= 0`, `<= 999999999` | getSurchargeAmount(): ?int | setSurchargeAmount(?int surchargeAmount): void |
| `tags` | [`?(Tag[])`](../../doc/models/tag.md) | Optional | Tag Information on `expand` | getTags(): ?array | setTags(?array tags): void |
| `tax` | `?int` | Optional | Amount of Sales tax - If supplied, this amount should be included in the total transaction_amount field. Use only integer numbers, so $10.99 will be 1099.
**Constraints**: `>= 0`, `<= 999999999` | getTax(): ?int | setTax(?int tax): void |
| `tipAmount` | `?int` | Optional | Optional tip amount. Tip is not supported for lodging and ecommerce merchants. Use only integer numbers, so $10.99 will be 1099.
**Constraints**: `>= 0`, `<= 999999999` | getTipAmount(): ?int | setTipAmount(?int tipAmount): void |
| `transactionAmount` | `?int` | Optional | Amount of the transaction. This should always be the desired settle amount of the transaction. Use only integer numbers, so $10.99 will be 1099.
**Constraints**: `>= 0`, `<= 999999999` | getTransactionAmount(): ?int | setTransactionAmount(?int transactionAmount): void |
| `secondaryAmount` | `?int` | Optional | Retained Amount of the transaction. This should always be less than transaction amount. Use only integer numbers, so $10.99 will be 1099
**Constraints**: `>= 0`, `<= 999999999` | getSecondaryAmount(): ?int | setSecondaryAmount(?int secondaryAmount): void |
| `transactionApiId` | `?string` | Optional | See api_id page for more details
**Constraints**: *Maximum Length*: `64` | getTransactionApiId(): ?string | setTransactionApiId(?string transactionApiId): void |
| `transactionC1` | `?string` | Optional | Custom field 1 for api users to store custom data
**Constraints**: *Maximum Length*: `128` | getTransactionC1(): ?string | setTransactionC1(?string transactionC1): void |
| `transactionC2` | `?string` | Optional | Custom field 2 for api users to store custom data
**Constraints**: *Maximum Length*: `128` | getTransactionC2(): ?string | setTransactionC2(?string transactionC2): void |
| `transactionC3` | `?string` | Optional | Custom field 3 for api users to store custom data
**Constraints**: *Maximum Length*: `128` | getTransactionC3(): ?string | setTransactionC3(?string transactionC3): void |
| `bankFundedOnlyOverride` | `?bool` | Optional | Bank Funded Only Override | getBankFundedOnlyOverride(): ?bool | setBankFundedOnlyOverride(?bool bankFundedOnlyOverride): void |
| `allowPartialAuthorizationOverride` | `?bool` | Optional | Allow Partial Authorization Override | getAllowPartialAuthorizationOverride(): ?bool | setAllowPartialAuthorizationOverride(?bool allowPartialAuthorizationOverride): void |
| `autoDeclineCvvOverride` | `?bool` | Optional | Auto Decline CVV Override | getAutoDeclineCvvOverride(): ?bool | setAutoDeclineCvvOverride(?bool autoDeclineCvvOverride): void |
| `autoDeclineStreetOverride` | `?bool` | Optional | Auto Decline Street Override | getAutoDeclineStreetOverride(): ?bool | setAutoDeclineStreetOverride(?bool autoDeclineStreetOverride): void |
| `autoDeclineZipOverride` | `?bool` | Optional | Auto Decline Zip Override | getAutoDeclineZipOverride(): ?bool | setAutoDeclineZipOverride(?bool autoDeclineZipOverride): void |
| `id` | `?string` | Optional | Transaction ID
**Constraints**: *Pattern*: `^(([0-9a-fA-F\-]{24,36})\|(([0-9a-fA-F]{8})-(([0-9a-fA-F]{4}\-){3})([0-9a-fA-F]{12})))$` | getId(): ?string | setId(?string id): void |
| `createdTs` | `?int` | Optional | Created Time Stamp | getCreatedTs(): ?int | setCreatedTs(?int createdTs): void |
| `modifiedTs` | `?int` | Optional | Modified Time Stamp | getModifiedTs(): ?int | setModifiedTs(?int modifiedTs): void |
| `terminalId` | `?string` | Optional | Terminal ID
**Constraints**: *Pattern*: `^(([0-9a-fA-F\-]{24,36})\|(([0-9a-fA-F]{8})-(([0-9a-fA-F]{4}\-){3})([0-9a-fA-F]{12})))$` | getTerminalId(): ?string | setTerminalId(?string terminalId): void |
| `accountHolderName` | `?string` | Optional | For CC, this is the 'Name (as it appears) on Card'. For ACH, this is the 'Name on Account'.
**Constraints**: *Maximum Length*: `32` | getAccountHolderName(): ?string | setAccountHolderName(?string accountHolderName): void |
| `accountType` | `?string` | Optional | Required for ACH transactions if account_vault_id is not provided.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `32` | getAccountType(): ?string | setAccountType(?string accountType): void |
| `tokenApiId` | `?string` | Optional | This can be supplied in place of account_vault_id if you would like to use an token for the transaction and are using your own custom api_id's to track accountvaults in the system.
**Constraints**: *Maximum Length*: `36` | getTokenApiId(): ?string | setTokenApiId(?string tokenApiId): void |
| `tokenId` | `?string` | Optional | Required if account_number, track_data, micr_data is not provided.
**Constraints**: *Pattern*: `^(([0-9a-fA-F\-]{24,36})\|(([0-9a-fA-F]{8})-(([0-9a-fA-F]{4}\-){3})([0-9a-fA-F]{12})))$` | getTokenId(): ?string | setTokenId(?string tokenId): void |
| `achIdentifier` | `?string` | Optional | Required for ACH transactions in certain scenarios.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `1` | getAchIdentifier(): ?string | setAchIdentifier(?string achIdentifier): void |
| `achSecCode` | [`?string(AchSecCode1Enum)`](../../doc/models/ach-sec-code-1-enum.md) | Optional | Required for ACH transactions if account_vault_id is not provided. | getAchSecCode(): ?string | setAchSecCode(?string achSecCode): void |
| `authAmount` | `?int` | Optional | Authorization Amount
**Constraints**: `<= 999999999` | getAuthAmount(): ?int | setAuthAmount(?int authAmount): void |
| `authCode` | `?string` | Optional | Required on force transactions. Ignored for all other actions.
**Constraints**: *Minimum Length*: `6`, *Maximum Length*: `6` | getAuthCode(): ?string | setAuthCode(?string authCode): void |
| `avs` | [`?string(AvsEnum)`](../../doc/models/avs-enum.md) | Optional | AVS | getAvs(): ?string | setAvs(?string avs): void |
| `avsEnhanced` | `?string` | Optional | AVS Enhanced
**Constraints**: *Minimum Length*: `1` | getAvsEnhanced(): ?string | setAvsEnhanced(?string avsEnhanced): void |
| `cardholderPresent` | `?bool` | Optional | If the cardholder is present at the point of service | getCardholderPresent(): ?bool | setCardholderPresent(?bool cardholderPresent): void |
| `cardPresent` | `?bool` | Optional | A POST only field to specify whether or not the card is present. | getCardPresent(): ?bool | setCardPresent(?bool cardPresent): void |
| `checkNumber` | `?string` | Optional | Required for transactions using TEL SEC code.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `15` | getCheckNumber(): ?string | setCheckNumber(?string checkNumber): void |
| `customerIp` | `?string` | Optional | Can be used to store customer IP Address | getCustomerIp(): ?string | setCustomerIp(?string customerIp): void |
| `cvvResponse` | `?string` | Optional | Obfuscated CVV
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `1` | getCvvResponse(): ?string | setCvvResponse(?string cvvResponse): void |
| `entryModeId` | [`?string(EntryModeIdEnum)`](../../doc/models/entry-mode-id-enum.md) | Optional | Entry Mode - See entry mode section for more detail | getEntryModeId(): ?string | setEntryModeId(?string entryModeId): void |
| `emvReceiptData` | [`?EmvReceiptData`](../../doc/models/emv-receipt-data.md) | Optional | This field is a read only field. This field will only be populated for EMV transactions and will contain proper JSON formatted data with some or all of the following fields: TC,TVR,AID,TSI,ATC,APPLAB,APPN,CVM | getEmvReceiptData(): ?EmvReceiptData | setEmvReceiptData(?EmvReceiptData emvReceiptData): void |
| `firstSix` | `?string` | Optional | First six numbers of account_number. Automatically generated by system.
**Constraints**: *Minimum Length*: `6`, *Maximum Length*: `6` | getFirstSix(): ?string | setFirstSix(?string firstSix): void |
| `lastFour` | `?string` | Optional | Last four numbers of account_number. Automatically generated by the system.
**Constraints**: *Minimum Length*: `4`, *Maximum Length*: `4` | getLastFour(): ?string | setLastFour(?string lastFour): void |
| `paymentMethod` | [`?string(PaymentMethod6Enum)`](../../doc/models/payment-method-6-enum.md) | Optional | 'cc' or 'ach' | getPaymentMethod(): ?string | setPaymentMethod(?string paymentMethod): void |
| `terminalSerialNumber` | `?string` | Optional | If transaction was processed using a terminal, this field would contain the terminal's serial number
**Constraints**: *Maximum Length*: `36`, *Pattern*: `^[a-zA-Z0-9]*$` | getTerminalSerialNumber(): ?string | setTerminalSerialNumber(?string terminalSerialNumber): void |
| `transactionSettlementStatus` | `?string` | Optional | (Deprecated field)
**Constraints**: *Maximum Length*: `32` | getTransactionSettlementStatus(): ?string | setTransactionSettlementStatus(?string transactionSettlementStatus): void |
| `chargeBackDate` | `?string` | Optional | Charge Back Date (ACH Trxs)
**Constraints**: *Maximum Length*: `10`, *Pattern*: `^[\d]{4}-[\d]{2}-[\d]{2}$` | getChargeBackDate(): ?string | setChargeBackDate(?string chargeBackDate): void |
| `isRecurring` | `?bool` | Optional | Flag that is allowed to be passed on card not present industries to signify the transaction is a fixed installment plan transaction. | getIsRecurring(): ?bool | setIsRecurring(?bool isRecurring): void |
| `notificationEmailSent` | `?bool` | Optional | Indicates if email receipt has been sent | getNotificationEmailSent(): ?bool | setNotificationEmailSent(?bool notificationEmailSent): void |
| `par` | `?string` | Optional | A field usually returned form the processor to uniquely identifier a specific cardholder's credit card.
**Constraints**: *Maximum Length*: `36` | getPar(): ?string | setPar(?string par): void |
| `reasonCodeId` | [`?int(ReasonCodeId1Enum)`](../../doc/models/reason-code-id-1-enum.md) | Optional | Response reason code that provides more detail as to the result of the transaction. The reason code list can be found here: Response Reason Codes
> 0 - N/A
>
> 1000 - CC - Approved / ACH - Accepted
>
> 1000 - CC - Approved / ACH - Accepted
>
> 1001 - AuthCompleted
>
> 1002 - Forced
>
> 1003 - AuthOnly Declined
>
> 1004 - Validation Failure (System Run Trx)
>
> 1005 - Processor Response Invalid
>
> 1200 - Voided
>
> 1201 - Partial Approval
>
> 1240 - Approved, optional fields are missing (Paya ACH only)
>
> 1301 - Account Deactivated for Fraud
>
> 1302-1399 - Reserved for Future Fraud Reason Codes
>
> 1500 - Generic Decline
>
> 1510 - Call
>
> 1518 - Transaction Not Permitted - Terminal
>
> 1520 - Pickup Card
>
> 1530 - Retry Trx
>
> 1531 - Communication Error
>
> 1540 - Setup Issue, contact Support
>
> 1541 - Device is not signature capable
>
> 1588 - Data could not be de-tokenized
>
> 1599 - Other Reason
>
> 1601 - Generic Decline
>
> 1602 - Call
>
> 1603 - No Reply
>
> 1604 - Pickup Card - No Fraud
>
> 1605 - Pickup Card - Fraud
>
> 1606 - Pickup Card - Lost
>
> 1607 - Pickup Card - Stolen
>
> 1608 - Account Error
>
> 1609 - Already Reversed
>
> 1610 - Bad PIN
>
> 1611 - Cashback Exceeded
>
> 1612 - Cashback Not Available
>
> 1613 - CID Error
>
> 1614 - Date Error
>
> 1615 - Do Not Honor
>
> 1616 - NSF
>
> 1618 - Invalid Service Code
>
> 1619 - Exceeded activity limit
>
> 1620 - Violation
>
> 1621 - Encryption Error
>
> 1622 - Card Expired
>
> 1623 - Renter
>
> 1624 - Security Violation
>
> 1625 - Card Not Permitted
>
> 1626 - Trans Not Permitted
>
> 1627 - System Error
>
> 1628 - Bad Merchant ID
>
> 1629 - Duplicate Batch (Already Closed)
>
> 1630 - Batch Rejected
>
> 1631 - Account Closed
>
> 1632 - PIN tries exceeded
>
> 1640 - Required fields are missing (ACH only)
>
> 1641 - Previously declined transaction (1640)
>
> 1650 - Contact Support
>
> 1651 - Max Sending - Throttle Limit Hit (ACH only)
>
> 1652 - Max Attempts Exceeded
>
> 1653 - Contact Support
>
> 1654 - Voided - Online Reversal Failed
>
> 1655 - Decline (AVS Auto Reversal)
>
> 1656 - Decline (CVV Auto Reversal)
>
> 1657 - Decline (Partial Auth Auto Reversal)
>
> 1658 - Expired Authorization
>
> 1659 - Declined - Partial Approval not Supported
>
> 1660 - Bank Account Error, please delete and re-add Token
>
> 1661 - Declined AuthIncrement
>
> 1662 - Auto Reversal - Processor can't settle
>
> 1663 - Manager Needed (Needs override transaction)
>
> 1664 - Token Not Found: Sharing Group Unavailable
>
> 1665 - Contact Not Found: Sharing Group Unavailable
>
> 1666 - Amount Error
>
> 1667 - Action Not Allowed in Current State
>
> 1668 - Original Authorization Not Valid
>
> 1701 - Chip Reject
>
> 1800 - Incorrect CVV
>
> 1801 - Duplicate Transaction
>
> 1802 - MID/TID Not Registered
>
> 1803 - Stop Recurring
>
> 1804 - No Transactions in Batch
>
> 1805 - Batch Does Not Exist
**ACH Reject Reason Codes**
\| Code \| E-Code \| Verbiage \| Short Description \| Long Description \|
\| ----------- \| ----------- \| ----------- \| ----------- \| ----------- \|
\| 2101 \| Rejected-R01 \| \| Insufficient funds \| Available balance is not sufficient to cover the amount of the debit entry \|
\| 2102 \| Rejected-R02 \| E02 \| Bank account closed \| Previously active amount has been closed by the customer of RDFI \|
\| 2103 \| Rejected-R03 \| E03 \| No bank account/unable to locate account \| Account number does not correspond to the individual identified in the entry, or the account number designated is not an open account \|
\| 2104 \| Rejected-R04 \| E04 \| Invalid bank account number \| Account number structure is not valid \|
\| 2105 \| Rejected-R05 \| E05 \| Reserved \| Currently not in use \|
\| 2106 \| Rejected-R06 \| \| Returned per ODFI request \| ODFI requested the RDFI to return the entry \|
\| 2107 \| Rejected-R07 \| E07 \| Authorization revoked by customer \| Receiver has revoked authorization \|
\| 2108 \| Rejected-R08 \| E08 \| Payment stopped \| Receiver of a recurring debit has stopped payment of an entry \|
\| 2109 \| Rejected-R09 \| \| Uncollected funds \| Collected funds are not sufficient for payment of the debit entry \|
\| 2110 \| Rejected-R10 \| E10 \| Customer Advises Originator is Not Known to Receiver and/or Is Not Authorized by Receiver to Debit Receiver’s Account \| Receiver has advised RDFI that originator is not authorized to debit his bank account \|
\| 2111 \| Rejected-R11 \| \| Customer Advises Entry Not In Accordance with the Terms of the Authorization \| To be used when there is an error in the authorization \|
\| 2112 \| Rejected-R12 \| \| Branch sold to another RDFI \| RDFI unable to post entry destined for a bank account maintained at a branch sold to another financial institution \|
\| 2113 \| Rejected-R13 \| \| RDFI not qualified to participate \| Financial institution does not receive commercial ACH entries \|
\| 2114 \| Rejected-R14 \| E14 \| Representative payee deceased or unable to continue in that capacity \| The representative payee authorized to accept entries on behalf of a beneficiary is either deceased or unable to continue in that capacity \|
\| 2115 \| Rejected-R15 \| E15 \| Beneficiary or bank account holder deceased \| (Other than representative payee) deceased* - (1) the beneficiary entitled to payments is deceased or (2) the bank account holder other than a representative payee is deceased \|
\| 2116 \| Rejected-R16 \| E16 \| Bank account frozen \| Funds in bank account are unavailable due to action by RDFI or legal order \|
\| 2117 \| Rejected-R17 \| \| File record edit criteria \| Entry with Invalid Account Number Initiated Under Questionable Circumstances \|
\| 2118 \| Rejected-R18 \| \| Improper effective entry date \| Entries have been presented prior to the first available processing window for the effective date. \|
\| 2119 \| Rejected-R19 \| \| Amount field error \| Improper formatting of the amount field \|
\| 2120 \| Rejected-R20 \| \| Non-payment bank account \| Entry destined for non-payment bank account defined by reg. \|
\| 2121 \| Rejected-R21 \| \| Invalid company Identification \| The company ID information not valid (normally CIE entries) \|
\| 2122 \| Rejected-R22 \| \| Invalid individual ID number \| Individual id used by receiver is incorrect (CIE entries) \|
\| 2123 \| Rejected-R23 \| \| Credit entry refused by receiver \| Receiver returned entry because minimum or exact amount not remitted, bank account is subject to litigation, or payment represents an overpayment, originator is not known to receiver or receiver has not authorized this credit entry to this bank account \|
\| 2124 \| Rejected-R24 \| \| Duplicate entry \| RDFI has received a duplicate entry \|
\| 2125 \| Rejected-R25 \| \| Addenda error \| Improper formatting of the addenda record information \|
\| 2126 \| Rejected-R26 \| \| Mandatory field error \| Improper information in one of the mandatory fields \|
\| 2127 \| Rejected-R27 \| \| Trace number error \| Original entry trace number is not valid for return entry; or addenda trace numbers do not correspond with entry detail record \|
\| 2128 \| Rejected-R28 \| \| Transit routing number check digit error \| Check digit for the transit routing number is incorrect \|
\| 2129 \| Rejected-R29 \| E29 \| Corporate customer advises not authorized \| RDFI has been notified by corporate receiver that debit entry of originator is not authorized \|
\| 2130 \| Rejected-R30 \| \| RDFI not participant in check truncation program \| Financial institution not participating in automated check safekeeping application \|
\| 2131 \| Rejected-R31 \| \| Permissible return entry (CCD and CTX only) \| RDFI has been notified by the ODFI that it agrees to accept a CCD or CTX return entry \|
\| 2132 \| Rejected-R32 \| \| RDFI non-settlement \| RDFI is not able to settle the entry \|
\| 2133 \| Rejected-R33 \| \| Return of XCK entry \| RDFI determines at its sole discretion to return an XCK entry; an XCK return entry may be initiated by midnight of the sixtieth day following the settlement date if the XCK entry \|
\| 2134 \| Rejected-R34 \| \| Limited participation RDFI \| RDFI participation has been limited by a federal or state supervisor \|
\| 2135 \| Rejected-R35 \| \| Return of improper debit entry \| ACH debit not permitted for use with the CIE standard entry class code (except for reversals) \|
\| 2136 \| Rejected-R36 \| \| Return of Improper Credit Entry \| \|
\| 2137 \| Rejected-R37 \| \| Source Document Presented for Payment \| \|
\| 2138 \| Rejected-R38 \| \| Stop Payment on Source Document \| \|
\| 2139 \| Rejected-R39 \| \| Improper Source Document \| \|
\| 2140 \| Rejected-R40 \| \| Return of ENR Entry by Federal Government Agency \| \|
\| 2141 \| Rejected-R41 \| \| Invalid Transaction Code \| \|
\| 2142 \| Rejected-R42 \| \| Routing Number/Check Digit Error \| \|
\| 2143 \| Rejected-R43 \| \| Invalid DFI Account Number \| \|
\| 2144 \| Rejected-R44 \| \| Invalid Individual ID Number/Identification \| \|
\| 2145 \| Rejected-R45 \| \| Invalid Individual Name/Company Name \| \|
\| 2146 \| Rejected-R46 \| \| Invalid Representative Payee Indicator \| \|
\| 2147 \| Rejected-R47 \| \| Duplicate Enrollment \| \|
\| 2150 \| Rejected-R50 \| \| State Law Affecting RCK Acceptance \| \|
\| 2151 \| Rejected-R51 \| \| Item is Ineligible, Notice Not Provided, etc. \| \|
\| 2152 \| Rejected-R52 \| \| Stop Payment on Item (adjustment entries) \| \|
\| 2153 \| Rejected-R53 \| \| Item and ACH Entry Presented for Payment \| \|
\| 2161 \| Rejected-R61 \| \| Misrouted Return \| \|
\| 2162 \| Rejected-R62 \| \| Incorrect Trace Number \| \|
\| 2163 \| Rejected-R63 \| \| Incorrect Dollar Amount \| \|
\| 2164 \| Rejected-R64 \| \| Incorrect Individual Identification \| \|
\| 2165 \| Rejected-R65 \| \| Incorrect Transaction Code \| \|
\| 2166 \| Rejected-R66 \| \| Incorrect Company Identification \| \|
\| 2167 \| Rejected-R67 \| \| Duplicate Return \| \|
\| 2168 \| Rejected-R68 \| \| Untimely Return \| \|
\| 2169 \| Rejected-R69 \| \| Multiple Errors \| \|
\| 2170 \| Rejected-R70 \| \| Permissible Return Entry Not Accepted \| \|
\| 2171 \| Rejected-R71 \| \| Misrouted Dishonored Return \| \|
\| 2172 \| Rejected-R72 \| \| Untimely Dishonored Return \| \|
\| 2173 \| Rejected-R73 \| \| Timely Original Return \| \|
\| 2174 \| Rejected-R74 \| \| Corrected Return \| \|
\| 2180 \| Rejected-R80 \| \| Cross-Border Payment Coding Error \| \|
\| 2181 \| Rejected-R81 \| \| Non-Participant in Cross-Border Program \| \|
\| 2182 \| Rejected-R82 \| \| Invalid Foreign Receiving DFI Identification \| \|
\| 2183 \| Rejected-R83 \| \| Foreign Receiving DFI Unable to Settle \| \|
\| 2200 \| Voided \| \| Processor Void \| The transaction was voided by the processor before being sent to the bank \|
\| 2201 \| Rejected-C01 \| \| \| \|
\| 2202 \| Rejected-C02 \| \| \| \|
\| 2203 \| Rejected-C03 \| \| \| \|
\| 2204 \| Rejected-C04 \| \| \| \|
\| 2205 \| Rejected-C05 \| \| \| \|
\| 2206 \| Rejected-C06 \| \| \| \|
\| 2207 \| Rejected-C07 \| \| \| \|
\| 2208 \| Rejected-C08 \| \| \| \|
\| 2209 \| Rejected-C09 \| \| \| \|
\| 2210 \| Rejected-C10 \| \| \| \|
\| 2211 \| Rejected-C11 \| \| \| \|
\| 2212 \| Rejected-C12 \| \| \| \|
\| 2213 \| Rejected-C13 \| \| \| \|
\| 2261 \| Rejected-C61 \| \| \| \|
\| 2262 \| Rejected-C62 \| \| \| \|
\| 2263 \| Rejected-C63 \| \| \| \|
\| 2264 \| Rejected-C64 \| \| \| \|
\| 2265 \| Rejected-C65 \| \| \| \|
\| 2266 \| Rejected-C66 \| \| \| \|
\| 2267 \| Rejected-C67 \| \| \| \|
\| 2268 \| Rejected-C68 \| \| \| \|
\| 2269 \| Rejected-C69 \| \| \| \|
\| 2301 \| Rejected-X01 \| \| Misc Check 21 Return \| \|
\| 2304 \| Rejected-X04 \| \| Invalid Image \| \|
\| 2305 \| Rejected-X05 \| E95 \| Breach of Warranty \| \|
\| 2306 \| Rejected-X06 \| E96 \| Counterfeit / Forgery \| \|
\| 2307 \| Rejected-X07 \| E97 \| Refer to Maker \| \|
\| 2308 \| Rejected-X08 \| \| Maximum Payment Attempts \| \|
\| 2309 \| Rejected-X09 \| \| Item Cannot be Re-presented \| \|
\| 2310 \| Rejected-X10 \| \| Not Our Item \| \|
\| 2321 \| Rejected-X21 \| \| Pay None \| \|
\| 2322 \| Rejected-X22 \| \| Pay All \| \|
\| 2323 \| Rejected-X23 \| E93 \| Non-Negotiable \| \|
\| 2329 \| Rejected-X29 \| \| Stale Dated \| \|
\| 2345 \| Rejected-X45 \| \| Misc Return \| \|
\| 2371 \| Rejected-X71 \| \| RCK - 2nd Time \| \|
\| 2372 \| Rejected-X72 \| \| RCK Reject - ACH \| \|
\| 2373 \| Rejected-X73 \| \| RCK Reject - Payer \| \| | getReasonCodeId(): ?int | setReasonCodeId(?int reasonCodeId): void |
| `recurringId` | `?string` | Optional | A unique identifer used to associate a transaction with a Recurring.
**Constraints**: *Pattern*: `^(([0-9a-fA-F\-]{24,36})\|(([0-9a-fA-F]{8})-(([0-9a-fA-F]{4}\-){3})([0-9a-fA-F]{12})))$` | getRecurringId(): ?string | setRecurringId(?string recurringId): void |
| `settleDate` | `?string` | Optional | Settle date
**Constraints**: *Maximum Length*: `10`, *Pattern*: `^[\d]{4}-[\d]{2}-[\d]{2}$` | getSettleDate(): ?string | setSettleDate(?string settleDate): void |
| `statusCode` | [`?int(StatusCode17Enum)`](../../doc/models/status-code-17-enum.md) | Optional | Status ID - See status id section for more detail
> 101 - Sale cc Approved
>
> 102 - Sale cc AuthOnly
>
> 111 - Refund cc Refunded
>
> 121 - Credit/Debit/Refund cc AvsOnly
>
> 131 - Credit/Debit/Refund ach Pending Origination
>
> 132 - Credit/Debit/Refund ach Originating
>
> 133 - Credit/Debit/Refund ach Originated
>
> 134 - Credit/Debit/Refund ach Settled
>
> 191 - Settled (depracated - batches are now settled on the /v2/transactionbatches endpoint)
>
> 201 - All cc/ach Voided
>
> 301 - All cc/ach Declined
>
> 331 - Credit/Debit/Refund ach Charged Back | getStatusCode(): ?int | setStatusCode(?int statusCode): void |
| `transactionBatchId` | `?string` | Optional | For cc transactions, this is the id of the batch the transaction belongs to (not to be confused with batch number). This will be null for transactions that do not settle (void and authonly).
**Constraints**: *Pattern*: `^(([0-9a-fA-F\-]{24,36})\|(([0-9a-fA-F]{8})-(([0-9a-fA-F]{4}\-){3})([0-9a-fA-F]{12})))$` | getTransactionBatchId(): ?string | setTransactionBatchId(?string transactionBatchId): void |
| `typeId` | [`?int(TypeIdEnum)`](../../doc/models/type-id-enum.md) | Optional | Type ID - See type id section for more detail | getTypeId(): ?int | setTypeId(?int typeId): void |
| `verbiage` | `?string` | Optional | Verbiage -Do not use verbiage to see if the transaction was approved, use status_id | getVerbiage(): ?string | setVerbiage(?string verbiage): void |
| `voidDate` | `?string` | Optional | void date
**Constraints**: *Maximum Length*: `10`, *Pattern*: `^[\d]{4}-[\d]{2}-[\d]{2}$` | getVoidDate(): ?string | setVoidDate(?string voidDate): void |
| `batch` | `?string` | Optional | Batch | getBatch(): ?string | setBatch(?string batch): void |
| `termsAgree` | `?bool` | Optional | Terms Agreement | getTermsAgree(): ?bool | setTermsAgree(?bool termsAgree): void |
| `responseMessage` | `?string` | Optional | Response Message
**Constraints**: *Maximum Length*: `255` | getResponseMessage(): ?string | setResponseMessage(?string responseMessage): void |
| `returnDate` | `?string` | Optional | Return Date
**Constraints**: *Maximum Length*: `10`, *Pattern*: `^[\d]{4}-[\d]{2}-[\d]{2}$` | getReturnDate(): ?string | setReturnDate(?string returnDate): void |
| `trxSourceId` | [`?int(TrxSourceIdEnum)`](../../doc/models/trx-source-id-enum.md) | Optional | How the transaction was obtained by the API.
> 1 - Unknown - The origination of this transaction could not be determined.
>
> 2 - Mobile - The origination of this transaction is through the mobile application. This is always a merchant submitted payment.
>
> 3 - Web - The origination of this transaction is through a web browser. This is always a merchant submitted payment. Examples include Virtual Terminal, Contact Charge, and Transaction Details - Run Again pages.
>
> 4 - IVR Transaction - The origination of this transaction is over the phone. This payment is submitted by an automated system initiated by the cardholder.
>
> 5 - Contact Statement - The orignation of this transaction is through a Vericle statement.
>
> 6 - Contact Payment Mobile - The origination of this transaction is through the mobile application. This is always submitted by a contact user.
>
> 7 - Contact Payment - The origination of this transaction is through a web browser. This is always submitted by a contact user.
>
> 8 - Quick Invoice - The orignation of this transaction is through a Quick Invoice. This is typically submitted by a contact user, however the transaction can also be submitted by a merchant.
>
> 9 - Payform - The origination of this transaction is through a Payform. This is typically a merchant submitted transaction, and is always from an internal developer.
>
> 10 - Hosted Payment Page - The orignation of this transaction is through a Hosted Payment Page. This is typically a cardholder submitted transaction.
>
> 11 - Emulator - The origination of this transaction is through Auth.Net emulator. This is typically submitted through an integration to a website or a shopping cart.
>
> 12 - Integration - The orignation of this transaction is through an integrated solution. This will always be from an external developer.
>
> 13 - Recurring Billing - The orignation of this transaction is through a scheduled recurring payment. This payment is system-initiated based on a payment schedule that has been configured.
>
> 14 - Recurring Secondary - This feature has not been implented yet.
>
> 15 - Declined Recurring Email - The orignation of this transaction is through the email notification sent when a recurring payment has been declined. This is typically submitted by a cardholder.
>
> 16 - Paylink - The orignation of this transaction is through a Paylink. This is typically submitted by a contact user, however the transaction can also be submitted by a merchant.
>
> 17 - Elements - The origination of this transaction is through the Elements payments page. This can be a cardholder submitted or a merchant submitted transaction.
>
> 18 - ACH Import - The origination of this transaction is through an ACH file import. This is a merchant initiated process. | getTrxSourceId(): ?int | setTrxSourceId(?int trxSourceId): void |
| `routingNumber` | `?string` | Optional | This field is read only for ach on transactions. Must be supplied if account_vault_id is not provided. | getRoutingNumber(): ?string | setRoutingNumber(?string routingNumber): void |
| `trxSourceCode` | [`?int(TrxSourceCodeEnum)`](../../doc/models/trx-source-code-enum.md) | Optional | How the transaction was obtained by the API.
> 1 - Unknown - The origination of this transaction could not be determined.
>
> 2 - Mobile - The origination of this transaction is through the mobile application. This is always a merchant submitted payment.
>
> 3 - Web - The origination of this transaction is through a web browser. This is always a merchant submitted payment. Examples include Virtual Terminal, Contact Charge, and Transaction Details - Run Again pages.
>
> 4 - IVR Transaction - The origination of this transaction is over the phone. This payment is submitted by an automated system initiated by the cardholder.
>
> 5 - Contact Statement - The orignation of this transaction is through a Vericle statement.
>
> 6 - Contact Payment Mobile - The origination of this transaction is through the mobile application. This is always submitted by a contact user.
>
> 7 - Contact Payment - The origination of this transaction is through a web browser. This is always submitted by a contact user.
>
> 8 - Quick Invoice - The orignation of this transaction is through a Quick Invoice. This is typically submitted by a contact user, however the transaction can also be submitted by a merchant.
>
> 9 - Payform - The origination of this transaction is through a Payform. This is typically a merchant submitted transaction, and is always from an internal developer.
>
> 10 - Hosted Payment Page - The orignation of this transaction is through a Hosted Payment Page. This is typically a cardholder submitted transaction.
>
> 11 - Emulator - The origination of this transaction is through Auth.Net emulator. This is typically submitted through an integration to a website or a shopping cart.
>
> 12 - Integration - The orignation of this transaction is through an integrated solution. This will always be from an external developer.
>
> 13 - Recurring Billing - The orignation of this transaction is through a scheduled recurring payment. This payment is system-initiated based on a payment schedule that has been configured.
>
> 14 - Recurring Secondary - This feature has not been implented yet.
>
> 15 - Declined Recurring Email - The orignation of this transaction is through the email notification sent when a recurring payment has been declined. This is typically submitted by a cardholder.
>
> 16 - Paylink - The orignation of this transaction is through a Paylink. This is typically submitted by a contact user, however the transaction can also be submitted by a merchant.
>
> 17 - Elements - The origination of this transaction is through the Elements payments page. This can be a cardholder submitted or a merchant submitted transaction.
>
> 18 - ACH Import - The origination of this transaction is through an ACH file import. This is a merchant initiated process. | getTrxSourceCode(): ?int | setTrxSourceCode(?int trxSourceCode): void |
| `paylinkId` | `?string` | Optional | Paylink Id
**Constraints**: *Pattern*: `^(([0-9a-fA-F\-]{24,36})\|(([0-9a-fA-F]{8})-(([0-9a-fA-F]{4}\-){3})([0-9a-fA-F]{12})))$` | getPaylinkId(): ?string | setPaylinkId(?string paylinkId): void |
| `currencyCode` | `?float` | Optional | Currency Code
**Default**: `840` | getCurrencyCode(): ?float | setCurrencyCode(?float currencyCode): void |
| `isAccountvault` | `?bool` | Optional | Is Token Transaction | getIsAccountvault(): ?bool | setIsAccountvault(?bool isAccountvault): void |
| `createdUserId` | `?string` | Optional | User ID Created the register
**Constraints**: *Pattern*: `^(([0-9a-fA-F\-]{24,36})\|(([0-9a-fA-F]{8})-(([0-9a-fA-F]{4}\-){3})([0-9a-fA-F]{12})))$` | getCreatedUserId(): ?string | setCreatedUserId(?string createdUserId): void |
| `modifiedUserId` | `?string` | Optional | Last User ID that updated the register
**Constraints**: *Pattern*: `^(([0-9a-fA-F\-]{24,36})\|(([0-9a-fA-F]{8})-(([0-9a-fA-F]{4}\-){3})([0-9a-fA-F]{12})))$` | getModifiedUserId(): ?string | setModifiedUserId(?string modifiedUserId): void |
| `transactionCode` | `?string` | Optional | Transaction Code | getTransactionCode(): ?string | setTransactionCode(?string transactionCode): void |
| `effectiveDate` | `?string` | Optional | For ACH only, this is optional and defaults to current day.
**Constraints**: *Maximum Length*: `10`, *Pattern*: `^[\d]{4}-[\d]{2}-[\d]{2}$` | getEffectiveDate(): ?string | setEffectiveDate(?string effectiveDate): void |
| `notificationPhone` | `?string` | Optional | Notification Phone | getNotificationPhone(): ?string | setNotificationPhone(?string notificationPhone): void |
| `cavvResult` | `?string` | Optional | Cavv Result | getCavvResult(): ?string | setCavvResult(?string cavvResult): void |
| `recurringFlag` | `?string` | Optional | Recurring Flag | getRecurringFlag(): ?string | setRecurringFlag(?string recurringFlag): void |
| `isToken` | `?bool` | Optional | Is Token Transaction | getIsToken(): ?bool | setIsToken(?bool isToken): void |
| `installmentTotal` | `?int` | Optional | Installment Total
**Constraints**: `>= 1`, `<= 999` | getInstallmentTotal(): ?int | setInstallmentTotal(?int installmentTotal): void |
| `installmentCounter` | `?int` | Optional | Installment Counter
**Constraints**: `>= 1`, `<= 999` | getInstallmentCounter(): ?int | setInstallmentCounter(?int installmentCounter): void |
| `accountVaultId` | `?string` | Optional | Token ID
**Constraints**: *Pattern*: `^(([0-9a-fA-F\-]{24,36})\|(([0-9a-fA-F]{8})-(([0-9a-fA-F]{4}\-){3})([0-9a-fA-F]{12})))$` | getAccountVaultId(): ?string | setAccountVaultId(?string accountVaultId): void |
| `hostedPaymentPageId` | `?string` | Optional | Hosted Payment Page Id
**Constraints**: *Pattern*: `^(([0-9a-fA-F\-]{24,36})\|(([0-9a-fA-F]{8})-(([0-9a-fA-F]{4}\-){3})([0-9a-fA-F]{12})))$` | getHostedPaymentPageId(): ?string | setHostedPaymentPageId(?string hostedPaymentPageId): void |
| `stan` | `?string` | Optional | - | getStan(): ?string | setStan(?string stan): void |
| `currency` | `?string` | Optional | Currency | getCurrency(): ?string | setCurrency(?string currency): void |
| `cardBin` | `?string` | Optional | Card Bin | getCardBin(): ?string | setCardBin(?string cardBin): void |
| `walletType` | `?string` | Optional | This value provides information from where the transaction was initialized (Such as In-App provider) | getWalletType(): ?string | setWalletType(?string walletType): void |
| `accountVault` | [`?AccountVault`](../../doc/models/account-vault.md) | Optional | Token Information on `expand` | getAccountVault(): ?AccountVault | setAccountVault(?AccountVault accountVault): void |
| `quickInvoice` | [`?QuickInvoice`](../../doc/models/quick-invoice.md) | Optional | Quick Invoice Information on `expand` | getQuickInvoice(): ?QuickInvoice | setQuickInvoice(?QuickInvoice quickInvoice): void |
| `logEmails` | [`?(LogEmail[])`](../../doc/models/log-email.md) | Optional | Log Email Information on `expand` | getLogEmails(): ?array | setLogEmails(?array logEmails): void |
| `isVoidable` | `?bool` | Optional | Is Voidable Information on `expand` | getIsVoidable(): ?bool | setIsVoidable(?bool isVoidable): void |
| `isReversible` | `?bool` | Optional | Is Reversible Information on `expand` | getIsReversible(): ?bool | setIsReversible(?bool isReversible): void |
| `isRefundable` | `?bool` | Optional | Is Refundable Information on `expand` | getIsRefundable(): ?bool | setIsRefundable(?bool isRefundable): void |
| `isCompletable` | `?bool` | Optional | Is Competable Information on `expand` | getIsCompletable(): ?bool | setIsCompletable(?bool isCompletable): void |
| `isSettled` | `?bool` | Optional | Is Settled Information on `expand` | getIsSettled(): ?bool | setIsSettled(?bool isSettled): void |
| `createdUser` | [`?CreatedUser`](../../doc/models/created-user.md) | Optional | User Information on `expand` | getCreatedUser(): ?CreatedUser | setCreatedUser(?CreatedUser createdUser): void |
| `location` | [`?Location`](../../doc/models/location.md) | Optional | Location Information on `expand` | getLocation(): ?Location | setLocation(?Location location): void |
| `contact` | [`?Contact1`](../../doc/models/contact-1.md) | Optional | Contact Information on `expand` | getContact(): ?Contact1 | setContact(?Contact1 contact): void |
| `changelogs` | [`?(Changelog[])`](../../doc/models/changelog.md) | Optional | Changelog Information on `expand` | getChangelogs(): ?array | setChangelogs(?array changelogs): void |
| `productTransaction` | [`?ProductTransaction`](../../doc/models/product-transaction.md) | Optional | Product Transaction Information on `expand` | getProductTransaction(): ?ProductTransaction | setProductTransaction(?ProductTransaction productTransaction): void |
| `allTags` | [`?(AllTag[])`](../../doc/models/all-tag.md) | Optional | All Tag Information on `expand` | getAllTags(): ?array | setAllTags(?array allTags): void |
| `tagTransactions` | [`?(TagTransaction[])`](../../doc/models/tag-transaction.md) | Optional | TagTransaction Information on `expand` | getTagTransactions(): ?array | setTagTransactions(?array tagTransactions): void |
| `declinedRecurringNotification` | [`?DeclinedRecurringNotification`](../../doc/models/declined-recurring-notification.md) | Optional | Declined Recurring Notification Information on `expand` | getDeclinedRecurringNotification(): ?DeclinedRecurringNotification | setDeclinedRecurringNotification(?DeclinedRecurringNotification declinedRecurringNotification): void |
| `paymentRecurringNotification` | [`?PaymentRecurringNotification`](../../doc/models/payment-recurring-notification.md) | Optional | Payment Recurring Notification Information on `expand` | getPaymentRecurringNotification(): ?PaymentRecurringNotification | setPaymentRecurringNotification(?PaymentRecurringNotification paymentRecurringNotification): void |
| `developerCompany` | [`?DeveloperCompany`](../../doc/models/developer-company.md) | Optional | Developer Company Information on `expand` | getDeveloperCompany(): ?DeveloperCompany | setDeveloperCompany(?DeveloperCompany developerCompany): void |
| `terminal` | [`?Terminal`](../../doc/models/terminal.md) | Optional | Terminal Information on `expand` | getTerminal(): ?Terminal | setTerminal(?Terminal terminal): void |
| `hostedPaymentPage` | [`?HostedPaymentPage`](../../doc/models/hosted-payment-page.md) | Optional | Hosted Payment Page Information on `expand` | getHostedPaymentPage(): ?HostedPaymentPage | setHostedPaymentPage(?HostedPaymentPage hostedPaymentPage): void |
| `transactionLevel3` | [`?TransactionLevel3`](../../doc/models/transaction-level-3.md) | Optional | Transaction Level3 Information on `expand` | getTransactionLevel3(): ?TransactionLevel3 | setTransactionLevel3(?TransactionLevel3 transactionLevel3): void |
| `developerCompanyId` | `?string` | Optional | Developer Company Id Information on `expand` | getDeveloperCompanyId(): ?string | setDeveloperCompanyId(?string developerCompanyId): void |
| `transactionHistories` | [`?(TransactionHistory[])`](../../doc/models/transaction-history.md) | Optional | Transaction History Information on `expand` | getTransactionHistories(): ?array | setTransactionHistories(?array transactionHistories): void |
| `surchargeTransaction` | [`?SurchargeTransaction`](../../doc/models/surcharge-transaction.md) | Optional | Surcharge Transaction Information on `expand` | getSurchargeTransaction(): ?SurchargeTransaction | setSurchargeTransaction(?SurchargeTransaction surchargeTransaction): void |
| `surcharge` | [`?Surcharge`](../../doc/models/surcharge.md) | Optional | Surcharge Information on `expand` | getSurcharge(): ?Surcharge | setSurcharge(?Surcharge surcharge): void |
| `signature` | [`?Signature`](../../doc/models/signature.md) | Optional | Signature Information on `expand` | getSignature(): ?Signature | setSignature(?Signature signature): void |
| `reasonCode` | [`?ReasonCode`](../../doc/models/reason-code.md) | Optional | Reason Code Information on `expand` | getReasonCode(): ?ReasonCode | setReasonCode(?ReasonCode reasonCode): void |
| `type` | [`?Type93`](../../doc/models/type-93.md) | Optional | Type Information on `expand` | getType(): ?Type93 | setType(?Type93 type): void |
| `status` | [`?Status11`](../../doc/models/status-11.md) | Optional | Status Information on `expand` | getStatus(): ?Status11 | setStatus(?Status11 status): void |
| `transactionBatch` | [`?TransactionBatch`](../../doc/models/transaction-batch.md) | Optional | Transaction Batch Information on `expand` | getTransactionBatch(): ?TransactionBatch | setTransactionBatch(?TransactionBatch transactionBatch): void |
| `transactionSplits` | [`?(TransactionSplit[])`](../../doc/models/transaction-split.md) | Optional | Transaction Split Information on `expand` | getTransactionSplits(): ?array | setTransactionSplits(?array transactionSplits): void |
| `postbackLogs` | [`?(PostbackLog[])`](../../doc/models/postback-log.md) | Optional | Postback Log Information on `expand` | getPostbackLogs(): ?array | setPostbackLogs(?array postbackLogs): void |
| `currencyType` | [`?CurrencyType`](../../doc/models/currency-type.md) | Optional | Currency Type Information on `expand` | getCurrencyType(): ?CurrencyType | setCurrencyType(?CurrencyType currencyType): void |
| `transactionReferences` | [`?(TransactionReference[])`](../../doc/models/transaction-reference.md) | Optional | Transaction Reference Information on `expand` | getTransactionReferences(): ?array | setTransactionReferences(?array transactionReferences): void |
## Example (as JSON)
```json
{
"checkin_date": "2021-12-01",
"checkout_date": "2021-12-01",
"clerk_number": "AE1234",
"contact_id": "11e95f8ec39de8fbdb0a4f1a",
"custom_data": {
"data1": "custom1",
"data2": "custom2"
},
"customer_id": "customerid",
"description": "some description",
"iias_ind": 1,
"image_front": "U29tZVN0cmluZ09idmlvdXNseU5vdEJhc2U2NEVuY29kZWQ=",
"image_back": "U29tZVN0cmluZ09idmlvdXNseU5vdEJhc2U2NEVuY29kZWQ=",
"installment": true,
"installment_number": 1,
"installment_count": 1,
"location_api_id": "location-api-id-florida-2",
"location_id": "11e95f8ec39de8fbdb0a4f1a",
"product_transaction_id": "11e95f8ec39de8fbdb0a4f1a",
"advance_deposit": false,
"no_show": false,
"notification_email_address": "johnsmith@smiths.com",
"order_number": "433659378839",
"po_number": "555555553123",
"quick_invoice_id": "11e95f8ec39de8fbdb0a4f1a",
"recurring_number": 1,
"room_num": "303",
"room_rate": 95,
"save_account": false,
"save_account_title": "John Account",
"subtotal_amount": 599,
"surcharge_amount": 100,
"tax": 0,
"tip_amount": 0,
"transaction_amount": 0,
"secondary_amount": 0,
"transaction_api_id": "transaction-payment-abcd123",
"transaction_c1": "custom-data-1",
"transaction_c2": "custom-data-2",
"transaction_c3": "custom-data-3",
"bank_funded_only_override": false,
"allow_partial_authorization_override": false,
"auto_decline_cvv_override": false,
"auto_decline_street_override": false,
"auto_decline_zip_override": false,
"id": "11e95f8ec39de8fbdb0a4f1a",
"created_ts": 1422040992,
"modified_ts": 1422040992,
"terminal_id": "11e95f8ec39de8fbdb0a4f1a",
"account_holder_name": "smith",
"account_type": "checking",
"token_id": "11e95f8ec39de8fbdb0a4f1a",
"ach_identifier": "P",
"ach_sec_code": "C21",
"auth_amount": 1,
"auth_code": "BR349K",
"avs": "BAD",
"avs_enhanced": "N",
"cardholder_present": true,
"card_present": true,
"check_number": "8520748520963",
"customer_ip": "192.168.0.10",
"cvv_response": "N",
"entry_mode_id": "C",
"first_six": "545454",
"last_four": "5454",
"payment_method": "cc",
"terminal_serial_number": "1234567890",
"charge_back_date": "2021-12-01",
"is_recurring": true,
"notification_email_sent": true,
"par": "Q1J4Z28RKA1EBL470G9XYG90R5D3E",
"reason_code_id": 1000,
"recurring_id": "11e95f8ec39de8fbdb0a4f1a",
"settle_date": "2021-12-01",
"status_code": 101,
"transaction_batch_id": "11e95f8ec39de8fbdb0a4f1a",
"verbiage": "APPROVED",
"void_date": "2021-12-01",
"batch": "2",
"terms_agree": true,
"return_date": "2021-12-01",
"trx_source_id": 8,
"routing_number": "051904524",
"trx_source_code": 8,
"paylink_id": "11e95f8ec39de8fbdb0a4f1a",
"currency_code": 840,
"is_accountvault": true,
"created_user_id": "11e95f8ec39de8fbdb0a4f1a",
"modified_user_id": "11e95f8ec39de8fbdb0a4f1a",
"effective_date": "2021-12-01",
"is_token": true,
"installment_total": 1,
"installment_counter": 1,
"account_vault_id": "11e95f8ec39de8fbdb0a4f1a",
"hosted_payment_page_id": "11e95f8ec39de8fbdb0a4f1a",
"is_voidable": true,
"is_reversible": true,
"is_refundable": true,
"is_completable": true,
"is_settled": true,
"developer_company_id": "Sample Developer Company ID",
"additional_amounts": [
{
"type": "cashback",
"amount": 6,
"account_type": "cash_benefit",
"currency": 154.64
},
{
"type": "cashback",
"amount": 6,
"account_type": "cash_benefit",
"currency": 154.64
}
],
"billing_address": {
"postal_code": "postal_code0",
"street": "street8",
"city": "city2",
"state": "state6",
"phone": "phone2",
"country": "country2"
}
}
```