payrix-api-sdk 1.0.0

data/lib/payrix/models/txns_post_response.rb

@@ -0,0 +1,1709 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # TxnsPostResponse Model.
+  class TxnsPostResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of this resource.
+    # @return [String]
+    attr_accessor :id
+
+    # The date and time at which this resource was created. The format should be
+    # YYYY-MM-DD HH:MM:SS.SSSS
+    # @return [String]
+    attr_accessor :created
+
+    # The date and time at which this resource was modified. The format should
+    # be YYYY-MM-DD HH:MM:SS.SSSS
+    # @return [String]
+    attr_accessor :modified
+
+    # The date and time at which this resource was modified. The format should
+    # be YYYY-MM-DD HH:MM:SS.SSSS
+    # @return [Object]
+    attr_accessor :creator
+
+    # The identifier of the Login that last modified this resource.
+    # @return [String]
+    attr_accessor :modifier
+
+    # The incoming ip address from which this Transaction was created.
+    # @return [String]
+    attr_accessor :ip_created
+
+    # The incoming ip address from which this Transaction was last modified.
+    # @return [String]
+    attr_accessor :ip_modified
+
+    # The identifier of the Merchant associated with this Transaction.
+    # @return [String]
+    attr_accessor :merchant
+
+    # The identifier of the Merchant associated with this Transaction.
+    # @return [Object]
+    attr_accessor :token
+
+    # The identifier of the Merchant associated with this Transaction.
+    # @return [Object]
+    attr_accessor :payment
+
+    # If this Transaction is related to another Transaction, then this field is
+    # set to the identifier of the other Transaction. 
+    # For example, if this Transaction is a refund, this field could be set to
+    # the identifier of the original sale Transaction.
+    # @return [String]
+    attr_accessor :fortxn
+
+    # Reauthorize this referenced Transaction. For example, to process a
+    # resubmission of a declined Transaction or to reauthorize an expired
+    # Transaction.
+    # @return [String]
+    attr_accessor :fromtxn
+
+    # If the Transaction is linked to a Batch, this field specifies the
+    # identifier of the Batch.
+    # @return [String]
+    attr_accessor :batch
+
+    # The identifier of the Subscription associated with this Transaction.
+    # @return [String]
+    attr_accessor :subscription
+
+    # The statement ID for which this transaction is being processed as payment.
+    # @return [String]
+    attr_accessor :statement
+
+    # The type of Transaction.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `1` - **Credit Card Only: Sale Transaction.** Processes a sale and
+    # charges the customer.
+    # - `2` - **Credit Card Only: Auth Transaction.** Authorizes and holds the
+    # requested total on the credit card.
+    # - `3` - **Credit Card Only: Capture Transaction.** Finalizes a prior Auth
+    # Transaction and charges the customer.
+    # - `4` - **Credit Card Only: Reverse Authorization.** Reverses a prior Auth
+    # or Sale Transaction and releases the credit hold.
+    # - `5` - **Credit Card Only: Refund Transaction.** Refunds a prior Capture
+    # or Sale Transaction (total may be specified for a partial refund).
+    # - `7` - **Echeck Only: Echeck Sale Transaction.** Sale Transaction for
+    # ECheck payment.
+    # - `8` - **Echeck Only: Echeck Refund Transaction.** Refund Transaction for
+    # prior ECheck Sale Transaction.
+    # - `11` - **Echeck Only: Echeck Redeposit Transaction.** Attempt to
+    # redeposit a prior failed eCheck Sale Transaction.
+    # - `12` - **Echeck Only: Echeck Account Verification Transaction.** Attempt
+    # to verify eCheck payment details.
+    # - `14` - **Incremental Authorization.**
+    # </details>
+    # @return [TxnTypeStrEnum]
+    attr_accessor :type
+
+    # The expiration date of this Transaction. 
+    # This field is stored as a text string in 'MMYY' format, where 'MM' is the
+    # number of a month and 'YY' is the last two digits of a year. For example,
+    # '0623' for June 2023. 
+    # The value must reflect a future date.
+    # @return [String]
+    attr_accessor :expiration
+
+    # The service code retrieved from the track data for a credit card swiped
+    # transaction.
+    # @return [String]
+    attr_accessor :service_code
+
+    # A date indicating when this Transaction was funded. 
+    # This field is set automatically.
+    # @return [Integer]
+    attr_accessor :funded
+
+    # The transaction has been returned by the receiver.
+    # @return [String]
+    attr_accessor :returned
+
+    # The currency for this transaction. See <a
+    # href="https://www.iban.com/currency-codes" target="_blank">Currency
+    # codes</a>  for all valid values.
+    # @return [CurrencyEnum]
+    attr_accessor :currency
+
+    # The currency for which transaction was funded on. See <a
+    # href="https://www.iban.com/currency-codes" target="_blank">Currency
+    # codes</a>  for all valid values.
+    # @return [FundingCurrencyEnum]
+    attr_accessor :funding_currency
+
+    # The status of the currency conversion.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `customerAccepted` - **The customer accepted the currency conversion
+    # rate.**
+    # - `customerRejected` - **The customer rejected the currency conversion
+    # rate.**
+    # - `notEligible` - **This transaction is not eligible for currency
+    # conversion.**
+    # </details>
+    # @return [CurrencyConversionEnum]
+    attr_accessor :currency_conversion
+
+    # The amount of the total sum of this Transaction that is made up of
+    # convenience fee. Fee charged when card payment is an alternative form of
+    # payment not ordinarily accepted by a merchant or service provider. This
+    # field is specified as an integer in cents. [currently not active]
+    # @return [Integer]
+    attr_accessor :convenience_fee
+
+    # Optional calculated fee amount indicator. This should be used in
+    # conjunction with txnFee setting on Fees resource, This field is specified
+    # in cents(up to three decimal points)
+    # @return [Float]
+    attr_accessor :fee
+
+    # The platform used to process transactions.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `APPLE` - **The Apple Payment Processor (Deprecated).**
+    # - `ELAVON` - **The Elavon processor (Deprecated).**
+    # - `FIRSTDATA` - **The FirstData processor (Deprecated).**
+    # - `GOOGLE` - **The Google Payment Processor (Deprecated).**
+    # - `VANTIV` - **The WorldPay (aka Vantiv or Litle) eComm (aka VAP)
+    # processor.**
+    # - `VCORE` - **The WorldPay (aka Vantiv) Core processor.**
+    # - `WELLSACH` - **The Wells Fargo ACH processor.**
+    # - `WELLSFARGO` - **The Wells Fargo Merchant Services processor
+    # (Deprecated).**
+    # - `WFSINGLE` - **The WFSINGLE processor (Deprecated).**
+    # </details>
+    # @return [TxnsPlatformEnum]
+    attr_accessor :platform
+
+    # The date on which the Transaction was authorized. 
+    # The date is specified as an eight digit string in YYYYMMDD format, for
+    # example, '20160120' for January 20, 2016. 
+    # The value of this field must represent a date in the past.
+    # @return [Integer]
+    attr_accessor :auth_date
+
+    # The authorization code for this Transaction. 
+    # This field is stored as a text string and must be between 0 and 20
+    # characters long.
+    # @return [String]
+    attr_accessor :auth_code
+
+    # A timestamp indicating when this Transaction was captured. 
+    # This field is set automatically. The format should be YYYY-MM-DD HH:MM:SS.
+    # @return [String]
+    attr_accessor :captured
+
+    # A date indicating when this Transaction was settled. 
+    # This field is set automatically. The format should be YYYY-MM-DD HH:MM:SS.
+    # @return [String]
+    attr_accessor :settled
+
+    # The currency of the settled total. 
+    # This field is set automatically.
+    # @return [SettledCurrencyEnum]
+    attr_accessor :settled_currency
+
+    # The total amount that was settled. 
+    # This field is specified as an integer in cents and is set automatically.
+    # @return [Integer]
+    attr_accessor :settled_total
+
+    # Whether to allow partial amount authorizations of this Transaction. For
+    # example, if the transaction amount is $1000 and the processor only
+    # authorizes a smaller amount, then enabling this field lets the Transaction
+    # proceed anyway.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Partial amount authorizations are not allowed.**
+    # - `1` - **Partial amount authorizations are allowed.**
+    # </details>
+    # @return [AllowPartialEnum]
+    attr_accessor :allow_partial
+
+    # The identifier of the Order associated with this Transaction. 
+    # This field is stored as a text string and must be between 0 and 1000
+    # characters long.
+    # @return [String]
+    attr_accessor :order
+
+    # A description of this Transaction. 
+    # This field is stored as a text string and must be between 0 and 1000
+    # characters long.
+    # @return [String]
+    attr_accessor :description
+
+    # The descriptor used in this Transaction. 
+    # This field is stored as a text string and must be between 1 and 50
+    # characters long. If a value is not set, an attempt is made to set a
+    # default value from the merchant information.
+    # @return [String]
+    attr_accessor :descriptor
+
+    # Sequencial number that uniquely identifies the txn.
+    # @return [Integer]
+    attr_accessor :trace_number
+
+    # The discount applied to the transaction.
+    # @return [Integer]
+    attr_accessor :discount
+
+    # The shipping fee pertaining to this transaction.
+    # @return [Integer]
+    attr_accessor :shipping
+
+    # The duty fee applicable to this transaction.
+    # @return [Integer]
+    attr_accessor :duty
+
+    # The identifier of the terminal that processed this Transaction. 
+    # The identifier is taken from the terminal system and varies in format
+    # according to the type of terminal. 
+    # This field is stored as a text string and must be between 0 and 50
+    # characters long.
+    # @return [String]
+    attr_accessor :terminal
+
+    # Capabilities of the terminal device.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `1` - **Key entry only terminal.** 
+    # - `2` - **Can read magnetic stripe.**
+    # - `3` - **Integrated circuit reader.** 
+    # - `4` - **Can detect contactless payment.**
+    # </details>
+    # @return [TerminalCapabilityEnum]
+    attr_accessor :terminal_capability
+
+    # How payment information has been entered, including manually keyed
+    # entries, card swipes with track 1 or 2 data received, card dips with EMV
+    # chip data received, contactless card reads with track or EMV data
+    # received, and ApplePay read with cryptogram data received.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `1` - **Manually keyed entry.**
+    # - `2` - **Card swiped. Track 1 received.**
+    # - `3` - **Card swiped. Track 2 received.**
+    # - `4` - **Card swiped. Track 1 & 2 received.**
+    # - `5` - **Card dipped. EMV chip received.**
+    # - `6` - **Contactless card read. Track or EMV data received.**
+    # - `7` - **Track Data from Card Swipe after EMV chip failure.**
+    # - `8` - **Track Data from Manually keyed entry after EMV chip failure.**
+    # - `9` - **ApplePay**
+    # - `10` - **Google Pay.**
+    # - `11` - **Merchant created transaction.**
+    # - `12` - **Invoice payment.**
+    # - `13` - **Merchant created transaction in payrix portal.**
+    # - `14` - **Invoice payment from payrix portal.**
+    # </details>
+    # @return [EntryModeEnum]
+    attr_accessor :entry_mode
+
+    # The origin of the transaction.
+    # <details>
+    # <summary>Valid Values</summary>
+    #  - `0` - **Unknown.**
+    #  - `1` - **Originated at a credit card terminal.**
+    #  - `2` - **Originated through an eCommerce system.**
+    #  - `3` - **Originated as a mail order or telephone order transaction.**
+    #  - `4` - **Originated with Apple Pay.**
+    #  - `5` - **Originated as a Successful 3D Secure transaction.**
+    #  - `6` - **Originated as an Attempted 3D Secure transaction.**
+    #  - `7` - **Deprecated. Originated as a recurring transaction on a card.**
+    #  - `8` - **Originated in a PayFrame.**
+    #  - `9` - **Originated in writing.**
+    # </details>
+    # @return [TxnOriginStrEnum]
+    attr_accessor :origin
+
+    # Indicates if a transaction is being processed through a Mobile POS.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Non-mobile POS.**
+    # - `1` - **Mobile POS.**
+    # </details>
+    # @return [MobileEnum]
+    attr_accessor :mobile
+
+    # The amount of the total sum of this Transaction that is made up of tax. 
+    # This field is specified as an integer in cents.
+    # @return [Integer]
+    attr_accessor :tax
+
+    # The amount of the total sum of this Transaction that is made up of
+    # surcharge. 
+    # This field is specified as an integer in cents.
+    # @return [Integer]
+    attr_accessor :surcharge
+
+    # The total amount of this Transaction. 
+    # This field is specified as an integer in cents.
+    # @return [Integer]
+    attr_accessor :total
+
+    # The amount of the total sum of this Transaction that is given as cash
+    # back. 
+    # This field is specified as an integer in cents.
+    # @return [Integer]
+    attr_accessor :cashback
+
+    # The authorization code for this Transaction, as returned by the network.
+    # @return [String]
+    attr_accessor :authorization
+
+    # The amount, in 'cents', of funds originally authorized for the
+    # transaction.
+    # @return [Integer]
+    attr_accessor :original_approved
+
+    # The total amount that was approved for this Transaction by the processor. 
+    # This field is specified as an integer in cents.
+    # @return [Integer]
+    attr_accessor :approved
+
+    # Authentication token returned by the network in a 3DSecure txn.
+    # @return [String]
+    attr_accessor :authentication
+
+    # Optional transaction ID returned by the network in a 3DSecure txn.
+    # @return [String]
+    attr_accessor :authentication_id
+
+    # Whether correct cvv was sent during this Transaction.
+    # @return [Integer]
+    attr_accessor :cvv
+
+    # The status of the CVV on the card.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `notPresent` - **CVV is not present.**
+    # - `illegible` - **CVV is illegible.**
+    # - `notProvided` - **CVV was not provided.**
+    # </details>
+    # @return [CvvStatusEnum]
+    attr_accessor :cvv_status
+
+    # Whether the card was swiped during this Transaction.
+    # This field is set to '1' automatically if 'track' data was received. 
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Swiped.**
+    # - `1` - **Swiped.**
+    # </details>
+    # @return [SwipedEnum]
+    attr_accessor :swiped
+
+    # Whether the card was dipped (using the EMV chip) during this Transaction.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not dipped.**
+    # - `1` - **Dipped.**
+    # </details>
+    # @return [EmvEnum]
+    attr_accessor :emv
+
+    # Whether a signature was captured during this Transaction. You can set this
+    # field if you took a signature for the Transaction. The API also sets this
+    # field automatically if you associate a signature to the Transaction by
+    # creating a 'txnDatas' resource.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not captured.**
+    # - `1` - **Captured.**
+    # </details>
+    # @return [SignatureEnum]
+    attr_accessor :signature
+
+    # Whether this Transaction was verified with a PIN.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **No PIN verification.**
+    # - `1` - **PIN verification.**
+    # </details>
+    # @return [PinEnum]
+    attr_accessor :pin
+
+    # Indicates the PIN entry capability of the device, which can be unknown,
+    # capable, notCapable, or pinPadDown.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `unknown` - **Unknown PIN Entry Capability.**
+    # - `capable` - **Terminal can accept PINs.**
+    # - `notCapable` - **Terminal cannot accept entry of PINs.**
+    # - `pinPadDown` - **Terminal PIN Pad is down.**
+    # </details>
+    # @return [PinEntryCapabilityEnum]
+    attr_accessor :pin_entry_capability
+
+    # Whether the card was swiped at an unattended terminal during this
+    # Transaction.
+    # This field is set to '0' by default.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Attended terminal.**
+    # - `1` - **Unattended terminal.**
+    # </details>
+    # @return [UnattendedEnum]
+    attr_accessor :unattended
+
+    # The type of Card On File transaction when using a token is single,
+    # scheduled, or unscheduled.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `single`  - **Individual Transaction.**
+    # - `scheduled`  - **Scheduled Transaction.**
+    # - `unscheduled`  - **Unscheduled sequential Transaction.**
+    # - `installment`  - **Installment Transaction.**
+    # </details>
+    # @return [CofTypeEnum]
+    attr_accessor :cof_type
+
+    # Reason for copying Transaction referenced in fromtxn field, which
+    # can be either resubmission or reauthorization.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `resubmission` - **Resubmission.**
+    # - `reauthorization` - **Reauthorization.**
+    # </details>
+    # @return [CopyReasonEnum]
+    attr_accessor :copy_reason
+
+    # The client ip address from which the Transaction was created. 
+    # Valid values are any Ipv4 or Ipv6 address.
+    # @return [String]
+    attr_accessor :client_ip
+
+    # The first name associated with this Transaction. For eCheck transactions,
+    # either first or last is required.
+    # @return [String]
+    attr_accessor :first
+
+    # The middle name associated with this Transaction.
+    # @return [String]
+    attr_accessor :middle
+
+    # The last name associated with this Transaction. For eCheck transactions,
+    # either first or last is required.
+    # @return [String]
+    attr_accessor :last
+
+    # The name of the company associated with this Transaction. 
+    # Setting this field is especially important when processing an eCheck from
+    # a company.
+    # @return [String]
+    attr_accessor :company
+
+    # The email associated with this Transaction.
+    # @return [String]
+    attr_accessor :email
+
+    # The first line of the address associated with this Transaction. 
+    # This field is stored as a text string and must be between 1 and 500
+    # characters long.
+    # @return [String]
+    attr_accessor :address1
+
+    # The second line of the address associated with this Transaction. 
+    # This field is stored as a text string and must be between 1 and 500
+    # characters long.
+    # @return [String]
+    attr_accessor :address2
+
+    # The name of the city in the address associated with this Transaction. 
+    # This field is stored as a text string and must be between 1 and 500
+    # characters long.
+    # @return [String]
+    attr_accessor :city
+
+    # The U.S. state or Canadian province relevant to the address provided here.
+    # If the location is within the U.S. and Canada, specify the 2-character
+    # postal abbreviation for the state. If the location is outside of the U.S.
+    # and Canada, provide the full state name. This field is stored as a text
+    # string and must be between 2 and 100 characters long.
+    #  
+    # <details>
+    # <summary>U.S. States</summary>
+    #  
+    #  - `AK` - **Alaska (US)**
+    #  
+    #  - `AR` - **Arkansas (US)**
+    #  
+    #  - `AL` - **Alabama (US)**
+    #  
+    #  - `AZ` - **Arizona (US)**
+    #  
+    #  - `CA` - **California (US)**
+    #  
+    #  - `CO` - **Colorado (US)**
+    #  
+    #  - `CT` - **Connecticut (US)**
+    #  
+    #  - `DE` - **Delaware (US)**
+    #  
+    #  - `FL` - **Florida (US)**
+    #  
+    #  - `GA` - **Georgia (US)**
+    #  
+    #  - `HI` - **Hawaii (US)**
+    #  
+    #  - `IA` - **Iowa (US)**
+    #  
+    #  - `ID` - **Idaho (US)**
+    #  
+    #  - `IL` - **Illinois (US)**
+    #  
+    #  - `IN` - **Indiana (US)**
+    #  
+    #  - `KY` - **Kentucky (US)**
+    #  
+    #  - `KS` - **Kansas (US)**
+    #  
+    #  - `LA` - **Louisiana (US)**
+    #  
+    #  - `MA` - **Massachusetts (US)**
+    #  
+    #  - `MD` - **Maryland (US)**
+    #  
+    #  - `ME` - **Maine (US)**
+    #  
+    #  - `MI` - **Michigan (US)**
+    #  
+    #  - `MN` - **Minnesota (US)**
+    #  
+    #  - `MO` - **Missouri (US)**
+    #  
+    #  - `MS` - **Mississippi (US)**
+    #  
+    #  - `MT` - **Montana (US)**
+    #  
+    #  - `NC` - **North Carolina (US)**
+    #  
+    #  - `ND` - **North Dakota (US)**
+    #  
+    #  - `NE` - **Nebraska (US)**
+    #  
+    #  - `NH` - **New Hampshire (US)**
+    #  
+    #  - `NJ` - **New Jersey (US)**
+    #  
+    #  - `NM` - **New Mexico (US)**
+    #  
+    #  - `NV` - **Nevada (US)**
+    #  
+    #  - `NY` - **New York (US)**
+    #  
+    #  - `OH` - **Ohio (US)**
+    #  
+    #  - `OK`- **Oklahoma (US)**
+    #  
+    #  - `OR` - **Oregon (US)**
+    #  
+    #  - `PA` - **Pennsylvania (US)**
+    #  
+    #  - `RI` - **Rhode Island (US)**
+    #  
+    #  - `SC`- **South Carolina (US)**
+    #  
+    #  - `SD` - **South Dakota (US)**
+    #  
+    #  - `TN` - **Tennessee (US)**
+    #  
+    #  - `TX` - **Texas (US)**
+    #  
+    #  - `UT` - **Utah (US)**
+    #  
+    #  - `VA` - **Virginia (US)**
+    #  
+    #  - `VT` - **Vermont (US)**
+    #  
+    #  - `WA` - **Washington (US)**
+    #  
+    #  - `WI` - **Wisconsin (US)**
+    #  
+    #  - `WV` - **West Virginia (US)**
+    #  
+    #  - `WY` - **Wyoming (US)**
+    #  </details>
+    #  <details>
+    # <summary>Canada Provinces and Territories</summary>
+    #  
+    #  - `AB` - **Alberta (CAN)**
+    #  
+    #  - `BC` - **British Columbia (CAN)**
+    #  
+    #  - `MB` - **Manitoba (CAN)**
+    #  
+    #  - `ON` - **Ontario (CAN)**
+    #  
+    #  - `NS` - **Nova Scotia (CAN)**
+    #  
+    #  - `NB` - **New Brunswick (CAN)**
+    #  
+    #  - `NL` - **Newfoundland and Labrador (CAN)**
+    #  
+    #  - `NT` - **Northwest Territories (CAN)**
+    #  
+    #  - `NU` - **Nunavut (CAN)**
+    #  
+    #  - `PE` - **Prince Edward Island (CAN)**
+    #  
+    #  - `QC` - **Quebec (CAN)**
+    #  
+    #  - `SK` - **Saskatchewan (CAN)**
+    #  
+    #  - `YT` - **Yukon (CAN)**
+    #  </details>
+    # @return [String]
+    attr_accessor :state
+
+    # The ZIP code in the address associated with this Transaction. 
+    # This field is stored as a text string and must be between 1 and 20
+    # characters long.
+    # @return [String]
+    attr_accessor :zip
+
+    # The country associated with this transaction, valid values for this field
+    # are the 3-letter ISO code for the country.
+    # @return [CountryEnum]
+    attr_accessor :country
+
+    # The phone number associated with this Transaction. 
+    # This field is stored as a text string and must be between 10 and 15
+    # characters long.
+    # @return [String]
+    attr_accessor :phone
+
+    # The Merchant ID as set by the processor. 
+    # This field is stored as a text string and must be between 0 and 50
+    # characters long.
+    # @return [String]
+    attr_accessor :mid
+
+    # The status of the Transaction. 
+    # <details>
+    # <summary>Valid Values</summary> 
+    #  - `0` - **Pending.**
+    #  - `1` - **Approved.** Payments can be voided or cancelled.
+    #  - `2` - **Failed**
+    #  - `3` - **Captured.** Payments can be refunded.
+    #  - `4` - **Settled.** Payments can be refunded.
+    #  - `5` - **Returned.** Payments has been successfully refunded.
+    #  </details>
+    # @return [TxnStatusStrEnum]
+    attr_accessor :status
+
+    # The amount of this Transaction that has been refunded.
+    # @return [Integer]
+    attr_accessor :refunded
+
+    # Indicates whether the Transaction is reserved and the action that will be
+    # taken as a result.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **No reserve.**
+    # - `1` - **Block transaction, will never be processed. The Entity is sent
+    # to the manual review queue..**
+    # - `3` - **Hold transaction, will not be captured.**
+    # - `4` - **Reserve transaction, funds should be reserved.**
+    # - `5` - **Block current activity, no change for merchant.**
+    # - `8` - **We onboard the merchant and wait for manual check later.**
+    # </details>
+    # @return [Reserved2Enum]
+    attr_accessor :reserved
+
+    # Indicates if an authorization has been misused by not being captured or
+    # reversed within the timeframe, which varies per network, mcc and type of
+    # txn closing (capture/reverse auth), with valid values indicating whether
+    # it's Not misused (0) or Misused (1). 
+    # <details>
+    # <summary>Valid Values</summary> 
+    #  - `0` - **Not misused.**
+    #  - `1` - **Misused.**
+    #  </details>
+    # @return [MisusedEnum]
+    attr_accessor :misused
+
+    # The last transaction stage check for risk.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `activation` - **Terminal activation.**
+    # - `auth` - **Apply this decision during transaction authorization.**
+    # - `postauth` - **Apply this decision after transaction authorization.**
+    # - `capture` - **Apply this decision during transaction capture.**
+    # - `refund` - **Apply this decision when processing a refund.**
+    # </details>
+    # @return [TxnCheckStage1Enum]
+    attr_accessor :check_stage
+
+    # The reason for the auth reversal. 
+    # This field is set to 'customerCancelled' by default.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `incomplete` - **Transaction Incomplete.**
+    # - `timeout` - **Transaction Timeout.**
+    # - `clerkCancelled` - **Transaction Cancelled by Clerk.**
+    # - `customerCancelled` - **Transaction Cancelled by Customer.**
+    # - `misdispense` - **Misdispense.**
+    # - `hardwareFailure` - **Hardware Failure.**
+    # - `suspectedFraud` - **Suspected Fraud.**
+    # </details>
+    # @return [UnauthReason2Enum]
+    attr_accessor :unauth_reason
+
+    # The customer identifier from the AuthToken used during authentication.
+    # @return [String]
+    attr_accessor :auth_token_customer
+
+    # This field is stored as a text string and must be between 0 and 1000
+    # characters long.
+    # @return [String]
+    attr_accessor :channel
+
+    # Whether the txn was imported from a report or not, this field is set
+    # automatically whether the txn was imported from a report or not. This
+    # field is set automatically.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0`  - **Not Imported**
+    # - `1`  - **Imported**
+    # </details>
+    # @return [ImportedEnum]
+    attr_accessor :imported
+
+    # For entry creation and deletion job sequencing: the current request
+    # sequence number for this transaction.
+    # @return [Integer]
+    attr_accessor :request_sequence
+
+    # For entry creation and deletion job sequencing: the current processed
+    # sequence number for this transaction.
+    # @return [Integer]
+    attr_accessor :processed_sequence
+
+    # If this transaction is for debt repayment or not for debt repayment.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Transaction not for debt repayment.**
+    # - `1` - **Transaction for debt repayment.**
+    # </details>
+    # @return [DebtRepaymentStrEnum]
+    attr_accessor :debt_repayment
+
+    # Whether or not funding is enabled for this Transaction.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Disabled.**
+    # - `1` - **Enabled.**
+    # </details>
+    # @return [TxnsFundingEnabledStrEnum]
+    attr_accessor :funding_enabled
+
+    # FBO in which each entry origin belongs to.
+    # @return [String]
+    attr_accessor :fbo
+
+    # If the Transaction is linked to a transaction session, this field
+    # specifies the identifier of the txnSessions resource. For more information
+    # on the transaction session see <a
+    # href="#/rest/welcome-to-payrix-pro/api-endpoints/transactions-txns/txn-ses
+    # sions/post-txn-sessions" target="_blank" rel="noopener
+    # noreferrer">txnSessions</a> API.
+    # @return [String]
+    attr_accessor :txnsession
+
+    # Whether this resource is marked as inactive.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Active**
+    # - `1` - **Inactive**
+    # </details>
+    # @return [InactiveEnum]
+    attr_accessor :inactive
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [FrozenEnum]
+    attr_accessor :frozen
+
+    # Indicates the tip amount associated with a transaction. This value is for
+    # reporting purposes only, because transaction amount includes this amount
+    # in the total.
+    # @return [Integer]
+    attr_accessor :tip
+
+    # The software POS ID.
+    # @return [String]
+    attr_accessor :soft_pos_id
+
+    # The device type indicator for the terminal.
+    # <details>
+    # <summary>Valid Values</summary>
+    #   - `1` - **Apple (Worldpay as PSP)**
+    #   - `2` - **Android (Worldpay as PSP)**
+    #   - `3` - **Apple (Worldpay not PSP)**
+    #   - `4` - **Android (Worldpay not PSP)**
+    #   
+    # </details>
+    # @return [String]
+    attr_accessor :soft_pos_device_type_indicator
+
+    # Indicates if a transaction qualified for a network token through Network
+    # Payment Manager. 
+    # <details>
+    # <summary>Valid Values</summary>
+    #   - `0` - **No**
+    #   - `1` - **Yes**
+    # </details>
+    # @return [NetworkTokenIndicator1Enum]
+    attr_accessor :network_token_indicator
+
+    # Indicates whether a transaction was attempted for Pinless Debit conversion
+    # and whether it was successful.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `null` - **If the value is null, no conversion attempt was made.**
+    # - `0` - **Conversion was attempted but not successful.**
+    # - `1` - **Conversion was attempted and successfully completed.**
+    # </details>
+    # @return [PinlessDebitConversionEnum]
+    attr_accessor :pinless_debit_conversion
+
+    # Indicates whether a transaction was attempted for Pinless Debit conversion
+    # and whether it was successful.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `null` - **If the value is null, no conversion attempt was made.**
+    # - `0` - **Conversion was attempted but not successful.**
+    # - `1` - **Conversion was attempted and successfully completed.**
+    # </details>
+    # @return [Array[TxnsPostRequest]]
+    attr_accessor :holds
+
+    # Indicates whether a transaction was attempted for Pinless Debit conversion
+    # and whether it was successful.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `null` - **If the value is null, no conversion attempt was made.**
+    # - `0` - **Conversion was attempted but not successful.**
+    # - `1` - **Conversion was attempted and successfully completed.**
+    # </details>
+    # @return [InvoiceResultResponse]
+    attr_accessor :invoice_result
+
+    # Indicates whether a transaction was attempted for Pinless Debit conversion
+    # and whether it was successful.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `null` - **If the value is null, no conversion attempt was made.**
+    # - `0` - **Conversion was attempted but not successful.**
+    # - `1` - **Conversion was attempted and successfully completed.**
+    # </details>
+    # @return [Array[ItemsPostRequest]]
+    attr_accessor :items
+
+    # Indicates whether a transaction was attempted for Pinless Debit conversion
+    # and whether it was successful.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `null` - **If the value is null, no conversion attempt was made.**
+    # - `0` - **Conversion was attempted but not successful.**
+    # - `1` - **Conversion was attempted and successfully completed.**
+    # </details>
+    # @return [Array[NotesPostRequest]]
+    attr_accessor :notes
+
+    # Indicates whether a transaction was attempted for Pinless Debit conversion
+    # and whether it was successful.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `null` - **If the value is null, no conversion attempt was made.**
+    # - `0` - **Conversion was attempted but not successful.**
+    # - `1` - **Conversion was attempted and successfully completed.**
+    # </details>
+    # @return [TxnDatasPostRequest]
+    attr_accessor :txn_data
+
+    # Indicates whether a transaction was attempted for Pinless Debit conversion
+    # and whether it was successful.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `null` - **If the value is null, no conversion attempt was made.**
+    # - `0` - **Conversion was attempted but not successful.**
+    # - `1` - **Conversion was attempted and successfully completed.**
+    # </details>
+    # @return [Array[TxnMetadatasPostRequest]]
+    attr_accessor :txn_metadatas
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['created'] = 'created'
+      @_hash['modified'] = 'modified'
+      @_hash['creator'] = 'creator'
+      @_hash['modifier'] = 'modifier'
+      @_hash['ip_created'] = 'ipCreated'
+      @_hash['ip_modified'] = 'ipModified'
+      @_hash['merchant'] = 'merchant'
+      @_hash['token'] = 'token'
+      @_hash['payment'] = 'payment'
+      @_hash['fortxn'] = 'fortxn'
+      @_hash['fromtxn'] = 'fromtxn'
+      @_hash['batch'] = 'batch'
+      @_hash['subscription'] = 'subscription'
+      @_hash['statement'] = 'statement'
+      @_hash['type'] = 'type'
+      @_hash['expiration'] = 'expiration'
+      @_hash['service_code'] = 'serviceCode'
+      @_hash['funded'] = 'funded'
+      @_hash['returned'] = 'returned'
+      @_hash['currency'] = 'currency'
+      @_hash['funding_currency'] = 'fundingCurrency'
+      @_hash['currency_conversion'] = 'currencyConversion'
+      @_hash['convenience_fee'] = 'convenienceFee'
+      @_hash['fee'] = 'fee'
+      @_hash['platform'] = 'platform'
+      @_hash['auth_date'] = 'authDate'
+      @_hash['auth_code'] = 'authCode'
+      @_hash['captured'] = 'captured'
+      @_hash['settled'] = 'settled'
+      @_hash['settled_currency'] = 'settledCurrency'
+      @_hash['settled_total'] = 'settledTotal'
+      @_hash['allow_partial'] = 'allowPartial'
+      @_hash['order'] = 'order'
+      @_hash['description'] = 'description'
+      @_hash['descriptor'] = 'descriptor'
+      @_hash['trace_number'] = 'traceNumber'
+      @_hash['discount'] = 'discount'
+      @_hash['shipping'] = 'shipping'
+      @_hash['duty'] = 'duty'
+      @_hash['terminal'] = 'terminal'
+      @_hash['terminal_capability'] = 'terminalCapability'
+      @_hash['entry_mode'] = 'entryMode'
+      @_hash['origin'] = 'origin'
+      @_hash['mobile'] = 'mobile'
+      @_hash['tax'] = 'tax'
+      @_hash['surcharge'] = 'surcharge'
+      @_hash['total'] = 'total'
+      @_hash['cashback'] = 'cashback'
+      @_hash['authorization'] = 'authorization'
+      @_hash['original_approved'] = 'originalApproved'
+      @_hash['approved'] = 'approved'
+      @_hash['authentication'] = 'authentication'
+      @_hash['authentication_id'] = 'authenticationId'
+      @_hash['cvv'] = 'cvv'
+      @_hash['cvv_status'] = 'cvvStatus'
+      @_hash['swiped'] = 'swiped'
+      @_hash['emv'] = 'emv'
+      @_hash['signature'] = 'signature'
+      @_hash['pin'] = 'pin'
+      @_hash['pin_entry_capability'] = 'pinEntryCapability'
+      @_hash['unattended'] = 'unattended'
+      @_hash['cof_type'] = 'cofType'
+      @_hash['copy_reason'] = 'copyReason'
+      @_hash['client_ip'] = 'clientIp'
+      @_hash['first'] = 'first'
+      @_hash['middle'] = 'middle'
+      @_hash['last'] = 'last'
+      @_hash['company'] = 'company'
+      @_hash['email'] = 'email'
+      @_hash['address1'] = 'address1'
+      @_hash['address2'] = 'address2'
+      @_hash['city'] = 'city'
+      @_hash['state'] = 'state'
+      @_hash['zip'] = 'zip'
+      @_hash['country'] = 'country'
+      @_hash['phone'] = 'phone'
+      @_hash['mid'] = 'mid'
+      @_hash['status'] = 'status'
+      @_hash['refunded'] = 'refunded'
+      @_hash['reserved'] = 'reserved'
+      @_hash['misused'] = 'misused'
+      @_hash['check_stage'] = 'checkStage'
+      @_hash['unauth_reason'] = 'unauthReason'
+      @_hash['auth_token_customer'] = 'authTokenCustomer'
+      @_hash['channel'] = 'channel'
+      @_hash['imported'] = 'imported'
+      @_hash['request_sequence'] = 'requestSequence'
+      @_hash['processed_sequence'] = 'processedSequence'
+      @_hash['debt_repayment'] = 'debtRepayment'
+      @_hash['funding_enabled'] = 'fundingEnabled'
+      @_hash['fbo'] = 'fbo'
+      @_hash['txnsession'] = 'txnsession'
+      @_hash['inactive'] = 'inactive'
+      @_hash['frozen'] = 'frozen'
+      @_hash['tip'] = 'tip'
+      @_hash['soft_pos_id'] = 'softPosId'
+      @_hash['soft_pos_device_type_indicator'] = 'softPosDeviceTypeIndicator'
+      @_hash['network_token_indicator'] = 'networkTokenIndicator'
+      @_hash['pinless_debit_conversion'] = 'pinlessDebitConversion'
+      @_hash['holds'] = 'holds'
+      @_hash['invoice_result'] = 'invoiceResult'
+      @_hash['items'] = 'items'
+      @_hash['notes'] = 'notes'
+      @_hash['txn_data'] = 'txnData'
+      @_hash['txn_metadatas'] = 'txnMetadatas'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        created
+        modified
+        creator
+        modifier
+        ip_created
+        ip_modified
+        merchant
+        token
+        payment
+        fortxn
+        fromtxn
+        batch
+        subscription
+        statement
+        type
+        expiration
+        service_code
+        funded
+        returned
+        currency
+        funding_currency
+        currency_conversion
+        convenience_fee
+        fee
+        platform
+        auth_date
+        auth_code
+        captured
+        settled
+        settled_currency
+        settled_total
+        allow_partial
+        order
+        description
+        descriptor
+        trace_number
+        discount
+        shipping
+        duty
+        terminal
+        terminal_capability
+        entry_mode
+        origin
+        mobile
+        tax
+        surcharge
+        total
+        cashback
+        authorization
+        original_approved
+        approved
+        authentication
+        authentication_id
+        cvv
+        cvv_status
+        swiped
+        emv
+        signature
+        pin
+        pin_entry_capability
+        unattended
+        cof_type
+        copy_reason
+        client_ip
+        first
+        middle
+        last
+        company
+        email
+        address1
+        address2
+        city
+        state
+        zip
+        country
+        phone
+        mid
+        status
+        refunded
+        reserved
+        misused
+        check_stage
+        unauth_reason
+        auth_token_customer
+        channel
+        imported
+        request_sequence
+        processed_sequence
+        debt_repayment
+        funding_enabled
+        fbo
+        txnsession
+        inactive
+        frozen
+        tip
+        soft_pos_id
+        soft_pos_device_type_indicator
+        network_token_indicator
+        pinless_debit_conversion
+        holds
+        invoice_result
+        items
+        notes
+        txn_data
+        txn_metadatas
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        currency
+        funding_currency
+        pinless_debit_conversion
+      ]
+    end
+
+    def initialize(id = SKIP, created = SKIP, modified = SKIP, creator = SKIP,
+                   modifier = SKIP, ip_created = SKIP, ip_modified = SKIP,
+                   merchant = SKIP, token = SKIP, payment = SKIP, fortxn = SKIP,
+                   fromtxn = SKIP, batch = SKIP, subscription = SKIP,
+                   statement = SKIP, type = SKIP, expiration = SKIP,
+                   service_code = SKIP, funded = SKIP, returned = SKIP,
+                   currency = SKIP, funding_currency = SKIP,
+                   currency_conversion = SKIP, convenience_fee = SKIP,
+                   fee = SKIP, platform = SKIP, auth_date = SKIP,
+                   auth_code = SKIP, captured = SKIP, settled = SKIP,
+                   settled_currency = SKIP, settled_total = SKIP,
+                   allow_partial = SKIP, order = SKIP, description = SKIP,
+                   descriptor = SKIP, trace_number = SKIP, discount = SKIP,
+                   shipping = SKIP, duty = SKIP, terminal = SKIP,
+                   terminal_capability = SKIP, entry_mode = SKIP, origin = SKIP,
+                   mobile = SKIP, tax = SKIP, surcharge = SKIP, total = SKIP,
+                   cashback = SKIP, authorization = SKIP,
+                   original_approved = SKIP, approved = SKIP,
+                   authentication = SKIP, authentication_id = SKIP, cvv = SKIP,
+                   cvv_status = SKIP, swiped = SKIP, emv = SKIP,
+                   signature = SignatureEnum::NOTCAPTURED, pin = SKIP,
+                   pin_entry_capability = SKIP, unattended = SKIP,
+                   cof_type = SKIP, copy_reason = SKIP, client_ip = SKIP,
+                   first = SKIP, middle = SKIP, last = SKIP, company = SKIP,
+                   email = SKIP, address1 = SKIP, address2 = SKIP, city = SKIP,
+                   state = SKIP, zip = SKIP, country = SKIP, phone = SKIP,
+                   mid = SKIP, status = SKIP, refunded = SKIP, reserved = SKIP,
+                   misused = SKIP, check_stage = SKIP, unauth_reason = SKIP,
+                   auth_token_customer = SKIP, channel = SKIP, imported = SKIP,
+                   request_sequence = SKIP, processed_sequence = SKIP,
+                   debt_repayment = DebtRepaymentStrEnum::OFF,
+                   funding_enabled = SKIP, fbo = SKIP, txnsession = SKIP,
+                   inactive = InactiveEnum::ACTIVE,
+                   frozen = FrozenEnum::NOTFROZEN, tip = SKIP,
+                   soft_pos_id = SKIP, soft_pos_device_type_indicator = SKIP,
+                   network_token_indicator = SKIP,
+                   pinless_debit_conversion = SKIP, holds = SKIP,
+                   invoice_result = SKIP, items = SKIP, notes = SKIP,
+                   txn_data = SKIP, txn_metadatas = SKIP)
+      @id = id unless id == SKIP
+      @created = created unless created == SKIP
+      @modified = modified unless modified == SKIP
+      @creator = creator unless creator == SKIP
+      @modifier = modifier unless modifier == SKIP
+      @ip_created = ip_created unless ip_created == SKIP
+      @ip_modified = ip_modified unless ip_modified == SKIP
+      @merchant = merchant unless merchant == SKIP
+      @token = token unless token == SKIP
+      @payment = payment unless payment == SKIP
+      @fortxn = fortxn unless fortxn == SKIP
+      @fromtxn = fromtxn unless fromtxn == SKIP
+      @batch = batch unless batch == SKIP
+      @subscription = subscription unless subscription == SKIP
+      @statement = statement unless statement == SKIP
+      @type = type unless type == SKIP
+      @expiration = expiration unless expiration == SKIP
+      @service_code = service_code unless service_code == SKIP
+      @funded = funded unless funded == SKIP
+      @returned = returned unless returned == SKIP
+      @currency = currency unless currency == SKIP
+      @funding_currency = funding_currency unless funding_currency == SKIP
+      @currency_conversion = currency_conversion unless currency_conversion == SKIP
+      @convenience_fee = convenience_fee unless convenience_fee == SKIP
+      @fee = fee unless fee == SKIP
+      @platform = platform unless platform == SKIP
+      @auth_date = auth_date unless auth_date == SKIP
+      @auth_code = auth_code unless auth_code == SKIP
+      @captured = captured unless captured == SKIP
+      @settled = settled unless settled == SKIP
+      @settled_currency = settled_currency unless settled_currency == SKIP
+      @settled_total = settled_total unless settled_total == SKIP
+      @allow_partial = allow_partial unless allow_partial == SKIP
+      @order = order unless order == SKIP
+      @description = description unless description == SKIP
+      @descriptor = descriptor unless descriptor == SKIP
+      @trace_number = trace_number unless trace_number == SKIP
+      @discount = discount unless discount == SKIP
+      @shipping = shipping unless shipping == SKIP
+      @duty = duty unless duty == SKIP
+      @terminal = terminal unless terminal == SKIP
+      @terminal_capability = terminal_capability unless terminal_capability == SKIP
+      @entry_mode = entry_mode unless entry_mode == SKIP
+      @origin = origin unless origin == SKIP
+      @mobile = mobile unless mobile == SKIP
+      @tax = tax unless tax == SKIP
+      @surcharge = surcharge unless surcharge == SKIP
+      @total = total unless total == SKIP
+      @cashback = cashback unless cashback == SKIP
+      @authorization = authorization unless authorization == SKIP
+      @original_approved = original_approved unless original_approved == SKIP
+      @approved = approved unless approved == SKIP
+      @authentication = authentication unless authentication == SKIP
+      @authentication_id = authentication_id unless authentication_id == SKIP
+      @cvv = cvv unless cvv == SKIP
+      @cvv_status = cvv_status unless cvv_status == SKIP
+      @swiped = swiped unless swiped == SKIP
+      @emv = emv unless emv == SKIP
+      @signature = signature unless signature == SKIP
+      @pin = pin unless pin == SKIP
+      @pin_entry_capability = pin_entry_capability unless pin_entry_capability == SKIP
+      @unattended = unattended unless unattended == SKIP
+      @cof_type = cof_type unless cof_type == SKIP
+      @copy_reason = copy_reason unless copy_reason == SKIP
+      @client_ip = client_ip unless client_ip == SKIP
+      @first = first unless first == SKIP
+      @middle = middle unless middle == SKIP
+      @last = last unless last == SKIP
+      @company = company unless company == SKIP
+      @email = email unless email == SKIP
+      @address1 = address1 unless address1 == SKIP
+      @address2 = address2 unless address2 == SKIP
+      @city = city unless city == SKIP
+      @state = state unless state == SKIP
+      @zip = zip unless zip == SKIP
+      @country = country unless country == SKIP
+      @phone = phone unless phone == SKIP
+      @mid = mid unless mid == SKIP
+      @status = status unless status == SKIP
+      @refunded = refunded unless refunded == SKIP
+      @reserved = reserved unless reserved == SKIP
+      @misused = misused unless misused == SKIP
+      @check_stage = check_stage unless check_stage == SKIP
+      @unauth_reason = unauth_reason unless unauth_reason == SKIP
+      @auth_token_customer = auth_token_customer unless auth_token_customer == SKIP
+      @channel = channel unless channel == SKIP
+      @imported = imported unless imported == SKIP
+      @request_sequence = request_sequence unless request_sequence == SKIP
+      @processed_sequence = processed_sequence unless processed_sequence == SKIP
+      @debt_repayment = debt_repayment unless debt_repayment == SKIP
+      @funding_enabled = funding_enabled unless funding_enabled == SKIP
+      @fbo = fbo unless fbo == SKIP
+      @txnsession = txnsession unless txnsession == SKIP
+      @inactive = inactive unless inactive == SKIP
+      @frozen = frozen unless frozen == SKIP
+      @tip = tip unless tip == SKIP
+      @soft_pos_id = soft_pos_id unless soft_pos_id == SKIP
+      unless soft_pos_device_type_indicator == SKIP
+        @soft_pos_device_type_indicator =
+          soft_pos_device_type_indicator
+      end
+      @network_token_indicator = network_token_indicator unless network_token_indicator == SKIP
+      @pinless_debit_conversion = pinless_debit_conversion unless pinless_debit_conversion == SKIP
+      @holds = holds unless holds == SKIP
+      @invoice_result = invoice_result unless invoice_result == SKIP
+      @items = items unless items == SKIP
+      @notes = notes unless notes == SKIP
+      @txn_data = txn_data unless txn_data == SKIP
+      @txn_metadatas = txn_metadatas unless txn_metadatas == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      created = hash.key?('created') ? hash['created'] : SKIP
+      modified = hash.key?('modified') ? hash['modified'] : SKIP
+      creator = hash.key?('creator') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:TxnsPostResponseCreator), hash['creator']
+      ) : SKIP
+      modifier = hash.key?('modifier') ? hash['modifier'] : SKIP
+      ip_created = hash.key?('ipCreated') ? hash['ipCreated'] : SKIP
+      ip_modified = hash.key?('ipModified') ? hash['ipModified'] : SKIP
+      merchant = hash.key?('merchant') ? hash['merchant'] : SKIP
+      token = hash.key?('token') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:TxnsPostResponseToken), hash['token']
+      ) : SKIP
+      payment = hash.key?('payment') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:TxnsPostResponsePayment), hash['payment']
+      ) : SKIP
+      fortxn = hash.key?('fortxn') ? hash['fortxn'] : SKIP
+      fromtxn = hash.key?('fromtxn') ? hash['fromtxn'] : SKIP
+      batch = hash.key?('batch') ? hash['batch'] : SKIP
+      subscription = hash.key?('subscription') ? hash['subscription'] : SKIP
+      statement = hash.key?('statement') ? hash['statement'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      expiration = hash.key?('expiration') ? hash['expiration'] : SKIP
+      service_code = hash.key?('serviceCode') ? hash['serviceCode'] : SKIP
+      funded = hash.key?('funded') ? hash['funded'] : SKIP
+      returned = hash.key?('returned') ? hash['returned'] : SKIP
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      funding_currency =
+        hash.key?('fundingCurrency') ? hash['fundingCurrency'] : SKIP
+      currency_conversion =
+        hash.key?('currencyConversion') ? hash['currencyConversion'] : SKIP
+      convenience_fee =
+        hash.key?('convenienceFee') ? hash['convenienceFee'] : SKIP
+      fee = hash.key?('fee') ? hash['fee'] : SKIP
+      platform = hash.key?('platform') ? hash['platform'] : SKIP
+      auth_date = hash.key?('authDate') ? hash['authDate'] : SKIP
+      auth_code = hash.key?('authCode') ? hash['authCode'] : SKIP
+      captured = hash.key?('captured') ? hash['captured'] : SKIP
+      settled = hash.key?('settled') ? hash['settled'] : SKIP
+      settled_currency =
+        hash.key?('settledCurrency') ? hash['settledCurrency'] : SKIP
+      settled_total = hash.key?('settledTotal') ? hash['settledTotal'] : SKIP
+      allow_partial = hash.key?('allowPartial') ? hash['allowPartial'] : SKIP
+      order = hash.key?('order') ? hash['order'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      descriptor = hash.key?('descriptor') ? hash['descriptor'] : SKIP
+      trace_number = hash.key?('traceNumber') ? hash['traceNumber'] : SKIP
+      discount = hash.key?('discount') ? hash['discount'] : SKIP
+      shipping = hash.key?('shipping') ? hash['shipping'] : SKIP
+      duty = hash.key?('duty') ? hash['duty'] : SKIP
+      terminal = hash.key?('terminal') ? hash['terminal'] : SKIP
+      terminal_capability =
+        hash.key?('terminalCapability') ? hash['terminalCapability'] : SKIP
+      entry_mode = hash.key?('entryMode') ? hash['entryMode'] : SKIP
+      origin = hash.key?('origin') ? hash['origin'] : SKIP
+      mobile = hash.key?('mobile') ? hash['mobile'] : SKIP
+      tax = hash.key?('tax') ? hash['tax'] : SKIP
+      surcharge = hash.key?('surcharge') ? hash['surcharge'] : SKIP
+      total = hash.key?('total') ? hash['total'] : SKIP
+      cashback = hash.key?('cashback') ? hash['cashback'] : SKIP
+      authorization = hash.key?('authorization') ? hash['authorization'] : SKIP
+      original_approved =
+        hash.key?('originalApproved') ? hash['originalApproved'] : SKIP
+      approved = hash.key?('approved') ? hash['approved'] : SKIP
+      authentication =
+        hash.key?('authentication') ? hash['authentication'] : SKIP
+      authentication_id =
+        hash.key?('authenticationId') ? hash['authenticationId'] : SKIP
+      cvv = hash.key?('cvv') ? hash['cvv'] : SKIP
+      cvv_status = hash.key?('cvvStatus') ? hash['cvvStatus'] : SKIP
+      swiped = hash.key?('swiped') ? hash['swiped'] : SKIP
+      emv = hash.key?('emv') ? hash['emv'] : SKIP
+      signature = hash['signature'] ||= SignatureEnum::NOTCAPTURED
+      pin = hash.key?('pin') ? hash['pin'] : SKIP
+      pin_entry_capability =
+        hash.key?('pinEntryCapability') ? hash['pinEntryCapability'] : SKIP
+      unattended = hash.key?('unattended') ? hash['unattended'] : SKIP
+      cof_type = hash.key?('cofType') ? hash['cofType'] : SKIP
+      copy_reason = hash.key?('copyReason') ? hash['copyReason'] : SKIP
+      client_ip = hash.key?('clientIp') ? hash['clientIp'] : SKIP
+      first = hash.key?('first') ? hash['first'] : SKIP
+      middle = hash.key?('middle') ? hash['middle'] : SKIP
+      last = hash.key?('last') ? hash['last'] : SKIP
+      company = hash.key?('company') ? hash['company'] : SKIP
+      email = hash.key?('email') ? hash['email'] : SKIP
+      address1 = hash.key?('address1') ? hash['address1'] : SKIP
+      address2 = hash.key?('address2') ? hash['address2'] : SKIP
+      city = hash.key?('city') ? hash['city'] : SKIP
+      state = hash.key?('state') ? hash['state'] : SKIP
+      zip = hash.key?('zip') ? hash['zip'] : SKIP
+      country = hash.key?('country') ? hash['country'] : SKIP
+      phone = hash.key?('phone') ? hash['phone'] : SKIP
+      mid = hash.key?('mid') ? hash['mid'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      refunded = hash.key?('refunded') ? hash['refunded'] : SKIP
+      reserved = hash.key?('reserved') ? hash['reserved'] : SKIP
+      misused = hash.key?('misused') ? hash['misused'] : SKIP
+      check_stage = hash.key?('checkStage') ? hash['checkStage'] : SKIP
+      unauth_reason = hash.key?('unauthReason') ? hash['unauthReason'] : SKIP
+      auth_token_customer =
+        hash.key?('authTokenCustomer') ? hash['authTokenCustomer'] : SKIP
+      channel = hash.key?('channel') ? hash['channel'] : SKIP
+      imported = hash.key?('imported') ? hash['imported'] : SKIP
+      request_sequence =
+        hash.key?('requestSequence') ? hash['requestSequence'] : SKIP
+      processed_sequence =
+        hash.key?('processedSequence') ? hash['processedSequence'] : SKIP
+      debt_repayment = hash['debtRepayment'] ||= DebtRepaymentStrEnum::OFF
+      funding_enabled =
+        hash.key?('fundingEnabled') ? hash['fundingEnabled'] : SKIP
+      fbo = hash.key?('fbo') ? hash['fbo'] : SKIP
+      txnsession = hash.key?('txnsession') ? hash['txnsession'] : SKIP
+      inactive = hash['inactive'] ||= InactiveEnum::ACTIVE
+      frozen = hash['frozen'] ||= FrozenEnum::NOTFROZEN
+      tip = hash.key?('tip') ? hash['tip'] : SKIP
+      soft_pos_id = hash.key?('softPosId') ? hash['softPosId'] : SKIP
+      soft_pos_device_type_indicator =
+        hash.key?('softPosDeviceTypeIndicator') ? hash['softPosDeviceTypeIndicator'] : SKIP
+      network_token_indicator =
+        hash.key?('networkTokenIndicator') ? hash['networkTokenIndicator'] : SKIP
+      pinless_debit_conversion =
+        hash.key?('pinlessDebitConversion') ? hash['pinlessDebitConversion'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      holds = nil
+      unless hash['holds'].nil?
+        holds = []
+        hash['holds'].each do |structure|
+          holds << (TxnsPostRequest.from_hash(structure) if structure)
+        end
+      end
+
+      holds = SKIP unless hash.key?('holds')
+      invoice_result = InvoiceResultResponse.from_hash(hash['invoiceResult']) if
+        hash['invoiceResult']
+      # Parameter is an array, so we need to iterate through it
+      items = nil
+      unless hash['items'].nil?
+        items = []
+        hash['items'].each do |structure|
+          items << (ItemsPostRequest.from_hash(structure) if structure)
+        end
+      end
+
+      items = SKIP unless hash.key?('items')
+      # Parameter is an array, so we need to iterate through it
+      notes = nil
+      unless hash['notes'].nil?
+        notes = []
+        hash['notes'].each do |structure|
+          notes << (NotesPostRequest.from_hash(structure) if structure)
+        end
+      end
+
+      notes = SKIP unless hash.key?('notes')
+      txn_data = TxnDatasPostRequest.from_hash(hash['txnData']) if hash['txnData']
+      # Parameter is an array, so we need to iterate through it
+      txn_metadatas = nil
+      unless hash['txnMetadatas'].nil?
+        txn_metadatas = []
+        hash['txnMetadatas'].each do |structure|
+          txn_metadatas << (TxnMetadatasPostRequest.from_hash(structure) if structure)
+        end
+      end
+
+      txn_metadatas = SKIP unless hash.key?('txnMetadatas')
+
+      # Create object from extracted values.
+      TxnsPostResponse.new(id,
+                           created,
+                           modified,
+                           creator,
+                           modifier,
+                           ip_created,
+                           ip_modified,
+                           merchant,
+                           token,
+                           payment,
+                           fortxn,
+                           fromtxn,
+                           batch,
+                           subscription,
+                           statement,
+                           type,
+                           expiration,
+                           service_code,
+                           funded,
+                           returned,
+                           currency,
+                           funding_currency,
+                           currency_conversion,
+                           convenience_fee,
+                           fee,
+                           platform,
+                           auth_date,
+                           auth_code,
+                           captured,
+                           settled,
+                           settled_currency,
+                           settled_total,
+                           allow_partial,
+                           order,
+                           description,
+                           descriptor,
+                           trace_number,
+                           discount,
+                           shipping,
+                           duty,
+                           terminal,
+                           terminal_capability,
+                           entry_mode,
+                           origin,
+                           mobile,
+                           tax,
+                           surcharge,
+                           total,
+                           cashback,
+                           authorization,
+                           original_approved,
+                           approved,
+                           authentication,
+                           authentication_id,
+                           cvv,
+                           cvv_status,
+                           swiped,
+                           emv,
+                           signature,
+                           pin,
+                           pin_entry_capability,
+                           unattended,
+                           cof_type,
+                           copy_reason,
+                           client_ip,
+                           first,
+                           middle,
+                           last,
+                           company,
+                           email,
+                           address1,
+                           address2,
+                           city,
+                           state,
+                           zip,
+                           country,
+                           phone,
+                           mid,
+                           status,
+                           refunded,
+                           reserved,
+                           misused,
+                           check_stage,
+                           unauth_reason,
+                           auth_token_customer,
+                           channel,
+                           imported,
+                           request_sequence,
+                           processed_sequence,
+                           debt_repayment,
+                           funding_enabled,
+                           fbo,
+                           txnsession,
+                           inactive,
+                           frozen,
+                           tip,
+                           soft_pos_id,
+                           soft_pos_device_type_indicator,
+                           network_token_indicator,
+                           pinless_debit_conversion,
+                           holds,
+                           invoice_result,
+                           items,
+                           notes,
+                           txn_data,
+                           txn_metadatas)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [TxnsPostResponse | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, created: #{@created}, modified: #{@modified}, creator:"\
+      " #{@creator}, modifier: #{@modifier}, ip_created: #{@ip_created}, ip_modified:"\
+      " #{@ip_modified}, merchant: #{@merchant}, token: #{@token}, payment: #{@payment}, fortxn:"\
+      " #{@fortxn}, fromtxn: #{@fromtxn}, batch: #{@batch}, subscription: #{@subscription},"\
+      " statement: #{@statement}, type: #{@type}, expiration: #{@expiration}, service_code:"\
+      " #{@service_code}, funded: #{@funded}, returned: #{@returned}, currency: #{@currency},"\
+      " funding_currency: #{@funding_currency}, currency_conversion: #{@currency_conversion},"\
+      " convenience_fee: #{@convenience_fee}, fee: #{@fee}, platform: #{@platform}, auth_date:"\
+      " #{@auth_date}, auth_code: #{@auth_code}, captured: #{@captured}, settled: #{@settled},"\
+      " settled_currency: #{@settled_currency}, settled_total: #{@settled_total}, allow_partial:"\
+      " #{@allow_partial}, order: #{@order}, description: #{@description}, descriptor:"\
+      " #{@descriptor}, trace_number: #{@trace_number}, discount: #{@discount}, shipping:"\
+      " #{@shipping}, duty: #{@duty}, terminal: #{@terminal}, terminal_capability:"\
+      " #{@terminal_capability}, entry_mode: #{@entry_mode}, origin: #{@origin}, mobile:"\
+      " #{@mobile}, tax: #{@tax}, surcharge: #{@surcharge}, total: #{@total}, cashback:"\
+      " #{@cashback}, authorization: #{@authorization}, original_approved: #{@original_approved},"\
+      " approved: #{@approved}, authentication: #{@authentication}, authentication_id:"\
+      " #{@authentication_id}, cvv: #{@cvv}, cvv_status: #{@cvv_status}, swiped: #{@swiped}, emv:"\
+      " #{@emv}, signature: #{@signature}, pin: #{@pin}, pin_entry_capability:"\
+      " #{@pin_entry_capability}, unattended: #{@unattended}, cof_type: #{@cof_type}, copy_reason:"\
+      " #{@copy_reason}, client_ip: #{@client_ip}, first: #{@first}, middle: #{@middle}, last:"\
+      " #{@last}, company: #{@company}, email: #{@email}, address1: #{@address1}, address2:"\
+      " #{@address2}, city: #{@city}, state: #{@state}, zip: #{@zip}, country: #{@country}, phone:"\
+      " #{@phone}, mid: #{@mid}, status: #{@status}, refunded: #{@refunded}, reserved:"\
+      " #{@reserved}, misused: #{@misused}, check_stage: #{@check_stage}, unauth_reason:"\
+      " #{@unauth_reason}, auth_token_customer: #{@auth_token_customer}, channel: #{@channel},"\
+      " imported: #{@imported}, request_sequence: #{@request_sequence}, processed_sequence:"\
+      " #{@processed_sequence}, debt_repayment: #{@debt_repayment}, funding_enabled:"\
+      " #{@funding_enabled}, fbo: #{@fbo}, txnsession: #{@txnsession}, inactive: #{@inactive},"\
+      " frozen: #{@frozen}, tip: #{@tip}, soft_pos_id: #{@soft_pos_id},"\
+      " soft_pos_device_type_indicator: #{@soft_pos_device_type_indicator},"\
+      " network_token_indicator: #{@network_token_indicator}, pinless_debit_conversion:"\
+      " #{@pinless_debit_conversion}, holds: #{@holds}, invoice_result: #{@invoice_result}, items:"\
+      " #{@items}, notes: #{@notes}, txn_data: #{@txn_data}, txn_metadatas: #{@txn_metadatas}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, created: #{@created.inspect}, modified:"\
+      " #{@modified.inspect}, creator: #{@creator.inspect}, modifier: #{@modifier.inspect},"\
+      " ip_created: #{@ip_created.inspect}, ip_modified: #{@ip_modified.inspect}, merchant:"\
+      " #{@merchant.inspect}, token: #{@token.inspect}, payment: #{@payment.inspect}, fortxn:"\
+      " #{@fortxn.inspect}, fromtxn: #{@fromtxn.inspect}, batch: #{@batch.inspect}, subscription:"\
+      " #{@subscription.inspect}, statement: #{@statement.inspect}, type: #{@type.inspect},"\
+      " expiration: #{@expiration.inspect}, service_code: #{@service_code.inspect}, funded:"\
+      " #{@funded.inspect}, returned: #{@returned.inspect}, currency: #{@currency.inspect},"\
+      " funding_currency: #{@funding_currency.inspect}, currency_conversion:"\
+      " #{@currency_conversion.inspect}, convenience_fee: #{@convenience_fee.inspect}, fee:"\
+      " #{@fee.inspect}, platform: #{@platform.inspect}, auth_date: #{@auth_date.inspect},"\
+      " auth_code: #{@auth_code.inspect}, captured: #{@captured.inspect}, settled:"\
+      " #{@settled.inspect}, settled_currency: #{@settled_currency.inspect}, settled_total:"\
+      " #{@settled_total.inspect}, allow_partial: #{@allow_partial.inspect}, order:"\
+      " #{@order.inspect}, description: #{@description.inspect}, descriptor:"\
+      " #{@descriptor.inspect}, trace_number: #{@trace_number.inspect}, discount:"\
+      " #{@discount.inspect}, shipping: #{@shipping.inspect}, duty: #{@duty.inspect}, terminal:"\
+      " #{@terminal.inspect}, terminal_capability: #{@terminal_capability.inspect}, entry_mode:"\
+      " #{@entry_mode.inspect}, origin: #{@origin.inspect}, mobile: #{@mobile.inspect}, tax:"\
+      " #{@tax.inspect}, surcharge: #{@surcharge.inspect}, total: #{@total.inspect}, cashback:"\
+      " #{@cashback.inspect}, authorization: #{@authorization.inspect}, original_approved:"\
+      " #{@original_approved.inspect}, approved: #{@approved.inspect}, authentication:"\
+      " #{@authentication.inspect}, authentication_id: #{@authentication_id.inspect}, cvv:"\
+      " #{@cvv.inspect}, cvv_status: #{@cvv_status.inspect}, swiped: #{@swiped.inspect}, emv:"\
+      " #{@emv.inspect}, signature: #{@signature.inspect}, pin: #{@pin.inspect},"\
+      " pin_entry_capability: #{@pin_entry_capability.inspect}, unattended:"\
+      " #{@unattended.inspect}, cof_type: #{@cof_type.inspect}, copy_reason:"\
+      " #{@copy_reason.inspect}, client_ip: #{@client_ip.inspect}, first: #{@first.inspect},"\
+      " middle: #{@middle.inspect}, last: #{@last.inspect}, company: #{@company.inspect}, email:"\
+      " #{@email.inspect}, address1: #{@address1.inspect}, address2: #{@address2.inspect}, city:"\
+      " #{@city.inspect}, state: #{@state.inspect}, zip: #{@zip.inspect}, country:"\
+      " #{@country.inspect}, phone: #{@phone.inspect}, mid: #{@mid.inspect}, status:"\
+      " #{@status.inspect}, refunded: #{@refunded.inspect}, reserved: #{@reserved.inspect},"\
+      " misused: #{@misused.inspect}, check_stage: #{@check_stage.inspect}, unauth_reason:"\
+      " #{@unauth_reason.inspect}, auth_token_customer: #{@auth_token_customer.inspect}, channel:"\
+      " #{@channel.inspect}, imported: #{@imported.inspect}, request_sequence:"\
+      " #{@request_sequence.inspect}, processed_sequence: #{@processed_sequence.inspect},"\
+      " debt_repayment: #{@debt_repayment.inspect}, funding_enabled: #{@funding_enabled.inspect},"\
+      " fbo: #{@fbo.inspect}, txnsession: #{@txnsession.inspect}, inactive: #{@inactive.inspect},"\
+      " frozen: #{@frozen.inspect}, tip: #{@tip.inspect}, soft_pos_id: #{@soft_pos_id.inspect},"\
+      " soft_pos_device_type_indicator: #{@soft_pos_device_type_indicator.inspect},"\
+      " network_token_indicator: #{@network_token_indicator.inspect}, pinless_debit_conversion:"\
+      " #{@pinless_debit_conversion.inspect}, holds: #{@holds.inspect}, invoice_result:"\
+      " #{@invoice_result.inspect}, items: #{@items.inspect}, notes: #{@notes.inspect}, txn_data:"\
+      " #{@txn_data.inspect}, txn_metadatas: #{@txn_metadatas.inspect}>"
+    end
+  end
+end