payrix-api-sdk 1.0.0

data/lib/payrix/models/txns_post_request.rb

@@ -0,0 +1,1157 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # TxnsPostRequest Model.
+  class TxnsPostRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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
+
+    # If the Transaction is linked to a Batch, this field specifies the
+    # identifier of the Batch.
+    # @return [String]
+    attr_accessor :batch
+
+    # 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
+
+    # 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
+
+    # 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
+
+    # 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 [DebtRepaymentEnum]
+    attr_accessor :debt_repayment
+
+    # 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
+
+    # 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
+
+    # 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
+
+    # 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 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 [TxnOriginEnum]
+    attr_accessor :origin
+
+    # 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
+
+    # 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
+
+    # For entry creation and deletion job sequencing: the current processed
+    # sequence number for this transaction.
+    # @return [Integer]
+    attr_accessor :processed_sequence
+
+    # 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
+
+    # Whether or not funding is enabled for this Transaction.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Disabled.**
+    # - `1` - **Enabled.**
+    # </details>
+    # @return [TxnsFundingEnabledEnum]
+    attr_accessor :funding_enabled
+
+    # FBO (for benefit of) in which each entry origin belongs to.
+    # @return [String]
+    attr_accessor :fbo
+
+    # For entry creation and deletion job sequencing: the current processed
+    # sequence number for this transaction.
+    # @return [Integer]
+    attr_accessor :request_sequence
+
+    # The statement ID for which this transaction is being processed as payment.
+    # @return [String]
+    attr_accessor :statement
+
+    # The token of the Tokens resource this Transaction is associated with.
+    # @return [String]
+    attr_accessor :token
+
+    # 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 [TxnTypeEnum]
+    attr_accessor :type
+
+    # 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 [UnauthReasonEnum]
+    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
+
+    # 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 client ip address from which the Transaction was created. 
+    # Valid values are any Ipv4 or Ipv6 address.
+    # @return [String]
+    attr_accessor :client_ip
+
+    # 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 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 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
+
+    # 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 customer discount, in cents, already applied to the total for this
+    # transaction.
+    # @return [Integer]
+    attr_accessor :discount
+
+    # The amount of the total, in cents, that represents the duties charged to
+    # the customer
+    # @return [Integer]
+    attr_accessor :duty
+
+    # The email associated with this Transaction.
+    # @return [String]
+    attr_accessor :email
+
+    # 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
+
+    # 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
+
+    # 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 first name associated with this Transaction. For eCheck transactions,
+    # either first or last is required.
+    # @return [String]
+    attr_accessor :first
+
+    # The last name associated with this Transaction. For eCheck transactions,
+    # either first or last is required.
+    # @return [String]
+    attr_accessor :last
+
+    # The identifier of the Merchant associated with this Transaction.
+    # @return [String]
+    attr_accessor :merchant
+
+    # 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 middle name associated with this Transaction.
+    # @return [String]
+    attr_accessor :middle
+
+    # 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
+
+    # 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
+
+    # The amount of the total, in cents, that represents the shipping cost
+    # charged to the customer
+    # @return [Integer]
+    attr_accessor :shipping
+
+    # 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
+
+    # 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 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
+
+    # The total amount of this Transaction. 
+    # This field is specified as an integer in cents.For example, $10.15 would
+    # be entered as 1015.
+    # @return [Integer]
+    attr_accessor :total
+
+    # 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 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
+
+    # Threatmetrix session ID, used to trace the financial session and prevent
+    # possible frauds.
+    # @return [String]
+    attr_accessor :tmx_session_id
+
+    # For external recurring systems, this is the first transaction ID related
+    # to this recurring payment.
+    # @return [String]
+    attr_accessor :first_txn
+
+    # The payment method associated with this Transaction, including the card
+    # details.
+    # @return [TxnsPayment]
+    attr_accessor :payment
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['allow_partial'] = 'allowPartial'
+      @_hash['batch'] = 'batch'
+      @_hash['authentication'] = 'authentication'
+      @_hash['authentication_id'] = 'authenticationId'
+      @_hash['cof_type'] = 'cofType'
+      @_hash['currency_conversion'] = 'currencyConversion'
+      @_hash['debt_repayment'] = 'debtRepayment'
+      @_hash['expiration'] = 'expiration'
+      @_hash['fortxn'] = 'fortxn'
+      @_hash['fromtxn'] = 'fromtxn'
+      @_hash['copy_reason'] = 'copyReason'
+      @_hash['mobile'] = 'mobile'
+      @_hash['origin'] = 'origin'
+      @_hash['pin_entry_capability'] = 'pinEntryCapability'
+      @_hash['platform'] = 'platform'
+      @_hash['processed_sequence'] = 'processedSequence'
+      @_hash['funded'] = 'funded'
+      @_hash['returned'] = 'returned'
+      @_hash['funding_enabled'] = 'fundingEnabled'
+      @_hash['fbo'] = 'fbo'
+      @_hash['request_sequence'] = 'requestSequence'
+      @_hash['statement'] = 'statement'
+      @_hash['token'] = 'token'
+      @_hash['type'] = 'type'
+      @_hash['unauth_reason'] = 'unauthReason'
+      @_hash['auth_token_customer'] = 'authTokenCustomer'
+      @_hash['channel'] = 'channel'
+      @_hash['cashback'] = 'cashback'
+      @_hash['client_ip'] = 'clientIp'
+      @_hash['company'] = 'company'
+      @_hash['currency'] = 'currency'
+      @_hash['funding_currency'] = 'fundingCurrency'
+      @_hash['cvv_status'] = 'cvvStatus'
+      @_hash['description'] = 'description'
+      @_hash['discount'] = 'discount'
+      @_hash['duty'] = 'duty'
+      @_hash['email'] = 'email'
+      @_hash['swiped'] = 'swiped'
+      @_hash['entry_mode'] = 'entryMode'
+      @_hash['fee'] = 'fee'
+      @_hash['first'] = 'first'
+      @_hash['last'] = 'last'
+      @_hash['merchant'] = 'merchant'
+      @_hash['mid'] = 'mid'
+      @_hash['middle'] = 'middle'
+      @_hash['order'] = 'order'
+      @_hash['pin'] = 'pin'
+      @_hash['shipping'] = 'shipping'
+      @_hash['signature'] = 'signature'
+      @_hash['tax'] = 'tax'
+      @_hash['surcharge'] = 'surcharge'
+      @_hash['terminal'] = 'terminal'
+      @_hash['terminal_capability'] = 'terminalCapability'
+      @_hash['total'] = 'total'
+      @_hash['unattended'] = 'unattended'
+      @_hash['address1'] = 'address1'
+      @_hash['address2'] = 'address2'
+      @_hash['city'] = 'city'
+      @_hash['state'] = 'state'
+      @_hash['zip'] = 'zip'
+      @_hash['country'] = 'country'
+      @_hash['phone'] = 'phone'
+      @_hash['tmx_session_id'] = 'tmxSessionId'
+      @_hash['first_txn'] = 'firstTxn'
+      @_hash['payment'] = 'payment'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        batch
+        authentication_id
+        cof_type
+        currency_conversion
+        expiration
+        fromtxn
+        copy_reason
+        mobile
+        pin_entry_capability
+        platform
+        processed_sequence
+        funded
+        returned
+        funding_enabled
+        fbo
+        request_sequence
+        statement
+        token
+        auth_token_customer
+        channel
+        cashback
+        client_ip
+        company
+        cvv_status
+        description
+        discount
+        duty
+        email
+        entry_mode
+        fee
+        first
+        last
+        middle
+        order
+        shipping
+        tax
+        surcharge
+        terminal
+        terminal_capability
+        address1
+        address2
+        city
+        state
+        zip
+        country
+        phone
+        tmx_session_id
+        first_txn
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        cof_type
+        unauth_reason
+        currency
+        funding_currency
+        swiped
+        unattended
+      ]
+    end
+
+    def initialize(allow_partial = AllowPartialEnum::NOTALLOWED,
+                   authentication = nil,
+                   debt_repayment = DebtRepaymentEnum::OFF, fortxn = nil,
+                   origin = nil, type = nil, unauth_reason = nil,
+                   currency = nil, funding_currency = nil, swiped = nil,
+                   merchant = nil, mid = nil, pin = PinEnum::NOPIN,
+                   signature = SignatureEnum::NOTCAPTURED, total = nil,
+                   unattended = nil, payment = nil, batch = SKIP,
+                   authentication_id = SKIP, cof_type = SKIP,
+                   currency_conversion = SKIP, expiration = SKIP,
+                   fromtxn = SKIP, copy_reason = SKIP, mobile = SKIP,
+                   pin_entry_capability = SKIP, platform = SKIP,
+                   processed_sequence = 0, funded = SKIP, returned = SKIP,
+                   funding_enabled = SKIP, fbo = SKIP, request_sequence = 0,
+                   statement = SKIP, token = SKIP, auth_token_customer = SKIP,
+                   channel = SKIP, cashback = SKIP, client_ip = SKIP,
+                   company = SKIP, cvv_status = SKIP, description = SKIP,
+                   discount = SKIP, duty = SKIP, email = SKIP,
+                   entry_mode = SKIP, fee = SKIP, first = SKIP, last = SKIP,
+                   middle = SKIP, order = SKIP, shipping = SKIP, tax = SKIP,
+                   surcharge = SKIP, terminal = SKIP,
+                   terminal_capability = SKIP, address1 = SKIP, address2 = SKIP,
+                   city = SKIP, state = SKIP, zip = SKIP, country = SKIP,
+                   phone = SKIP, tmx_session_id = SKIP, first_txn = SKIP)
+      @allow_partial = allow_partial
+      @batch = batch unless batch == SKIP
+      @authentication = authentication
+      @authentication_id = authentication_id unless authentication_id == SKIP
+      @cof_type = cof_type unless cof_type == SKIP
+      @currency_conversion = currency_conversion unless currency_conversion == SKIP
+      @debt_repayment = debt_repayment
+      @expiration = expiration unless expiration == SKIP
+      @fortxn = fortxn
+      @fromtxn = fromtxn unless fromtxn == SKIP
+      @copy_reason = copy_reason unless copy_reason == SKIP
+      @mobile = mobile unless mobile == SKIP
+      @origin = origin
+      @pin_entry_capability = pin_entry_capability unless pin_entry_capability == SKIP
+      @platform = platform unless platform == SKIP
+      @processed_sequence = processed_sequence unless processed_sequence == SKIP
+      @funded = funded unless funded == SKIP
+      @returned = returned unless returned == SKIP
+      @funding_enabled = funding_enabled unless funding_enabled == SKIP
+      @fbo = fbo unless fbo == SKIP
+      @request_sequence = request_sequence unless request_sequence == SKIP
+      @statement = statement unless statement == SKIP
+      @token = token unless token == SKIP
+      @type = type
+      @unauth_reason = unauth_reason
+      @auth_token_customer = auth_token_customer unless auth_token_customer == SKIP
+      @channel = channel unless channel == SKIP
+      @cashback = cashback unless cashback == SKIP
+      @client_ip = client_ip unless client_ip == SKIP
+      @company = company unless company == SKIP
+      @currency = currency
+      @funding_currency = funding_currency
+      @cvv_status = cvv_status unless cvv_status == SKIP
+      @description = description unless description == SKIP
+      @discount = discount unless discount == SKIP
+      @duty = duty unless duty == SKIP
+      @email = email unless email == SKIP
+      @swiped = swiped
+      @entry_mode = entry_mode unless entry_mode == SKIP
+      @fee = fee unless fee == SKIP
+      @first = first unless first == SKIP
+      @last = last unless last == SKIP
+      @merchant = merchant
+      @mid = mid
+      @middle = middle unless middle == SKIP
+      @order = order unless order == SKIP
+      @pin = pin
+      @shipping = shipping unless shipping == SKIP
+      @signature = signature
+      @tax = tax unless tax == SKIP
+      @surcharge = surcharge unless surcharge == SKIP
+      @terminal = terminal unless terminal == SKIP
+      @terminal_capability = terminal_capability unless terminal_capability == SKIP
+      @total = total
+      @unattended = unattended
+      @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
+      @tmx_session_id = tmx_session_id unless tmx_session_id == SKIP
+      @first_txn = first_txn unless first_txn == SKIP
+      @payment = payment
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      allow_partial = hash['allowPartial'] ||= AllowPartialEnum::NOTALLOWED
+      authentication =
+        hash.key?('authentication') ? hash['authentication'] : nil
+      debt_repayment = hash['debtRepayment'] ||= DebtRepaymentEnum::OFF
+      fortxn = hash.key?('fortxn') ? hash['fortxn'] : nil
+      origin = hash.key?('origin') ? hash['origin'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+      unauth_reason = hash.key?('unauthReason') ? hash['unauthReason'] : nil
+      currency = hash.key?('currency') ? hash['currency'] : nil
+      funding_currency =
+        hash.key?('fundingCurrency') ? hash['fundingCurrency'] : nil
+      swiped = hash.key?('swiped') ? hash['swiped'] : nil
+      merchant = hash.key?('merchant') ? hash['merchant'] : nil
+      mid = hash.key?('mid') ? hash['mid'] : nil
+      pin = hash['pin'] ||= PinEnum::NOPIN
+      signature = hash['signature'] ||= SignatureEnum::NOTCAPTURED
+      total = hash.key?('total') ? hash['total'] : nil
+      unattended = hash.key?('unattended') ? hash['unattended'] : nil
+      payment = TxnsPayment.from_hash(hash['payment']) if hash['payment']
+      batch = hash.key?('batch') ? hash['batch'] : SKIP
+      authentication_id =
+        hash.key?('authenticationId') ? hash['authenticationId'] : SKIP
+      cof_type = hash.key?('cofType') ? hash['cofType'] : SKIP
+      currency_conversion =
+        hash.key?('currencyConversion') ? hash['currencyConversion'] : SKIP
+      expiration = hash.key?('expiration') ? hash['expiration'] : SKIP
+      fromtxn = hash.key?('fromtxn') ? hash['fromtxn'] : SKIP
+      copy_reason = hash.key?('copyReason') ? hash['copyReason'] : SKIP
+      mobile = hash.key?('mobile') ? hash['mobile'] : SKIP
+      pin_entry_capability =
+        hash.key?('pinEntryCapability') ? hash['pinEntryCapability'] : SKIP
+      platform = hash.key?('platform') ? hash['platform'] : SKIP
+      processed_sequence = hash['processedSequence'] ||= 0
+      funded = hash.key?('funded') ? hash['funded'] : SKIP
+      returned = hash.key?('returned') ? hash['returned'] : SKIP
+      funding_enabled =
+        hash.key?('fundingEnabled') ? hash['fundingEnabled'] : SKIP
+      fbo = hash.key?('fbo') ? hash['fbo'] : SKIP
+      request_sequence = hash['requestSequence'] ||= 0
+      statement = hash.key?('statement') ? hash['statement'] : SKIP
+      token = hash.key?('token') ? hash['token'] : SKIP
+      auth_token_customer =
+        hash.key?('authTokenCustomer') ? hash['authTokenCustomer'] : SKIP
+      channel = hash.key?('channel') ? hash['channel'] : SKIP
+      cashback = hash.key?('cashback') ? hash['cashback'] : SKIP
+      client_ip = hash.key?('clientIp') ? hash['clientIp'] : SKIP
+      company = hash.key?('company') ? hash['company'] : SKIP
+      cvv_status = hash.key?('cvvStatus') ? hash['cvvStatus'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      discount = hash.key?('discount') ? hash['discount'] : SKIP
+      duty = hash.key?('duty') ? hash['duty'] : SKIP
+      email = hash.key?('email') ? hash['email'] : SKIP
+      entry_mode = hash.key?('entryMode') ? hash['entryMode'] : SKIP
+      fee = hash.key?('fee') ? hash['fee'] : SKIP
+      first = hash.key?('first') ? hash['first'] : SKIP
+      last = hash.key?('last') ? hash['last'] : SKIP
+      middle = hash.key?('middle') ? hash['middle'] : SKIP
+      order = hash.key?('order') ? hash['order'] : SKIP
+      shipping = hash.key?('shipping') ? hash['shipping'] : SKIP
+      tax = hash.key?('tax') ? hash['tax'] : SKIP
+      surcharge = hash.key?('surcharge') ? hash['surcharge'] : SKIP
+      terminal = hash.key?('terminal') ? hash['terminal'] : SKIP
+      terminal_capability =
+        hash.key?('terminalCapability') ? hash['terminalCapability'] : 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
+      tmx_session_id = hash.key?('tmxSessionId') ? hash['tmxSessionId'] : SKIP
+      first_txn = hash.key?('firstTxn') ? hash['firstTxn'] : SKIP
+
+      # Create object from extracted values.
+      TxnsPostRequest.new(allow_partial,
+                          authentication,
+                          debt_repayment,
+                          fortxn,
+                          origin,
+                          type,
+                          unauth_reason,
+                          currency,
+                          funding_currency,
+                          swiped,
+                          merchant,
+                          mid,
+                          pin,
+                          signature,
+                          total,
+                          unattended,
+                          payment,
+                          batch,
+                          authentication_id,
+                          cof_type,
+                          currency_conversion,
+                          expiration,
+                          fromtxn,
+                          copy_reason,
+                          mobile,
+                          pin_entry_capability,
+                          platform,
+                          processed_sequence,
+                          funded,
+                          returned,
+                          funding_enabled,
+                          fbo,
+                          request_sequence,
+                          statement,
+                          token,
+                          auth_token_customer,
+                          channel,
+                          cashback,
+                          client_ip,
+                          company,
+                          cvv_status,
+                          description,
+                          discount,
+                          duty,
+                          email,
+                          entry_mode,
+                          fee,
+                          first,
+                          last,
+                          middle,
+                          order,
+                          shipping,
+                          tax,
+                          surcharge,
+                          terminal,
+                          terminal_capability,
+                          address1,
+                          address2,
+                          city,
+                          state,
+                          zip,
+                          country,
+                          phone,
+                          tmx_session_id,
+                          first_txn)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [TxnsPostRequest | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.allow_partial,
+                                ->(val) { AllowPartialEnum.validate(val) }) and
+            APIHelper.valid_type?(value.authentication,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.debt_repayment,
+                                  ->(val) { DebtRepaymentEnum.validate(val) }) and
+            APIHelper.valid_type?(value.fortxn,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.origin,
+                                  ->(val) { TxnOriginEnum.validate(val) }) and
+            APIHelper.valid_type?(value.type,
+                                  ->(val) { TxnTypeEnum.validate(val) }) and
+            APIHelper.valid_type?(value.unauth_reason,
+                                  ->(val) { UnauthReasonEnum.validate(val) }) and
+            APIHelper.valid_type?(value.currency,
+                                  ->(val) { CurrencyEnum.validate(val) }) and
+            APIHelper.valid_type?(value.funding_currency,
+                                  ->(val) { FundingCurrencyEnum.validate(val) }) and
+            APIHelper.valid_type?(value.swiped,
+                                  ->(val) { SwipedEnum.validate(val) }) and
+            APIHelper.valid_type?(value.merchant,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.mid,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.pin,
+                                  ->(val) { PinEnum.validate(val) }) and
+            APIHelper.valid_type?(value.signature,
+                                  ->(val) { SignatureEnum.validate(val) }) and
+            APIHelper.valid_type?(value.total,
+                                  ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.unattended,
+                                  ->(val) { UnattendedEnum.validate(val) }) and
+            APIHelper.valid_type?(value.payment,
+                                  ->(val) { TxnsPayment.validate(val) },
+                                  is_model_hash: true)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['allowPartial'],
+                              ->(val) { AllowPartialEnum.validate(val) }) and
+          APIHelper.valid_type?(value['authentication'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['debtRepayment'],
+                                ->(val) { DebtRepaymentEnum.validate(val) }) and
+          APIHelper.valid_type?(value['fortxn'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['origin'],
+                                ->(val) { TxnOriginEnum.validate(val) }) and
+          APIHelper.valid_type?(value['type'],
+                                ->(val) { TxnTypeEnum.validate(val) }) and
+          APIHelper.valid_type?(value['unauthReason'],
+                                ->(val) { UnauthReasonEnum.validate(val) }) and
+          APIHelper.valid_type?(value['currency'],
+                                ->(val) { CurrencyEnum.validate(val) }) and
+          APIHelper.valid_type?(value['fundingCurrency'],
+                                ->(val) { FundingCurrencyEnum.validate(val) }) and
+          APIHelper.valid_type?(value['swiped'],
+                                ->(val) { SwipedEnum.validate(val) }) and
+          APIHelper.valid_type?(value['merchant'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['mid'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['pin'],
+                                ->(val) { PinEnum.validate(val) }) and
+          APIHelper.valid_type?(value['signature'],
+                                ->(val) { SignatureEnum.validate(val) }) and
+          APIHelper.valid_type?(value['total'],
+                                ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['unattended'],
+                                ->(val) { UnattendedEnum.validate(val) }) and
+          APIHelper.valid_type?(value['payment'],
+                                ->(val) { TxnsPayment.validate(val) },
+                                is_model_hash: true)
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} allow_partial: #{@allow_partial}, batch: #{@batch}, authentication:"\
+      " #{@authentication}, authentication_id: #{@authentication_id}, cof_type: #{@cof_type},"\
+      " currency_conversion: #{@currency_conversion}, debt_repayment: #{@debt_repayment},"\
+      " expiration: #{@expiration}, fortxn: #{@fortxn}, fromtxn: #{@fromtxn}, copy_reason:"\
+      " #{@copy_reason}, mobile: #{@mobile}, origin: #{@origin}, pin_entry_capability:"\
+      " #{@pin_entry_capability}, platform: #{@platform}, processed_sequence:"\
+      " #{@processed_sequence}, funded: #{@funded}, returned: #{@returned}, funding_enabled:"\
+      " #{@funding_enabled}, fbo: #{@fbo}, request_sequence: #{@request_sequence}, statement:"\
+      " #{@statement}, token: #{@token}, type: #{@type}, unauth_reason: #{@unauth_reason},"\
+      " auth_token_customer: #{@auth_token_customer}, channel: #{@channel}, cashback:"\
+      " #{@cashback}, client_ip: #{@client_ip}, company: #{@company}, currency: #{@currency},"\
+      " funding_currency: #{@funding_currency}, cvv_status: #{@cvv_status}, description:"\
+      " #{@description}, discount: #{@discount}, duty: #{@duty}, email: #{@email}, swiped:"\
+      " #{@swiped}, entry_mode: #{@entry_mode}, fee: #{@fee}, first: #{@first}, last: #{@last},"\
+      " merchant: #{@merchant}, mid: #{@mid}, middle: #{@middle}, order: #{@order}, pin: #{@pin},"\
+      " shipping: #{@shipping}, signature: #{@signature}, tax: #{@tax}, surcharge: #{@surcharge},"\
+      " terminal: #{@terminal}, terminal_capability: #{@terminal_capability}, total: #{@total},"\
+      " unattended: #{@unattended}, address1: #{@address1}, address2: #{@address2}, city:"\
+      " #{@city}, state: #{@state}, zip: #{@zip}, country: #{@country}, phone: #{@phone},"\
+      " tmx_session_id: #{@tmx_session_id}, first_txn: #{@first_txn}, payment: #{@payment}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} allow_partial: #{@allow_partial.inspect}, batch: #{@batch.inspect},"\
+      " authentication: #{@authentication.inspect}, authentication_id:"\
+      " #{@authentication_id.inspect}, cof_type: #{@cof_type.inspect}, currency_conversion:"\
+      " #{@currency_conversion.inspect}, debt_repayment: #{@debt_repayment.inspect}, expiration:"\
+      " #{@expiration.inspect}, fortxn: #{@fortxn.inspect}, fromtxn: #{@fromtxn.inspect},"\
+      " copy_reason: #{@copy_reason.inspect}, mobile: #{@mobile.inspect}, origin:"\
+      " #{@origin.inspect}, pin_entry_capability: #{@pin_entry_capability.inspect}, platform:"\
+      " #{@platform.inspect}, processed_sequence: #{@processed_sequence.inspect}, funded:"\
+      " #{@funded.inspect}, returned: #{@returned.inspect}, funding_enabled:"\
+      " #{@funding_enabled.inspect}, fbo: #{@fbo.inspect}, request_sequence:"\
+      " #{@request_sequence.inspect}, statement: #{@statement.inspect}, token: #{@token.inspect},"\
+      " type: #{@type.inspect}, unauth_reason: #{@unauth_reason.inspect}, auth_token_customer:"\
+      " #{@auth_token_customer.inspect}, channel: #{@channel.inspect}, cashback:"\
+      " #{@cashback.inspect}, client_ip: #{@client_ip.inspect}, company: #{@company.inspect},"\
+      " currency: #{@currency.inspect}, funding_currency: #{@funding_currency.inspect},"\
+      " cvv_status: #{@cvv_status.inspect}, description: #{@description.inspect}, discount:"\
+      " #{@discount.inspect}, duty: #{@duty.inspect}, email: #{@email.inspect}, swiped:"\
+      " #{@swiped.inspect}, entry_mode: #{@entry_mode.inspect}, fee: #{@fee.inspect}, first:"\
+      " #{@first.inspect}, last: #{@last.inspect}, merchant: #{@merchant.inspect}, mid:"\
+      " #{@mid.inspect}, middle: #{@middle.inspect}, order: #{@order.inspect}, pin:"\
+      " #{@pin.inspect}, shipping: #{@shipping.inspect}, signature: #{@signature.inspect}, tax:"\
+      " #{@tax.inspect}, surcharge: #{@surcharge.inspect}, terminal: #{@terminal.inspect},"\
+      " terminal_capability: #{@terminal_capability.inspect}, total: #{@total.inspect},"\
+      " unattended: #{@unattended.inspect}, address1: #{@address1.inspect}, address2:"\
+      " #{@address2.inspect}, city: #{@city.inspect}, state: #{@state.inspect}, zip:"\
+      " #{@zip.inspect}, country: #{@country.inspect}, phone: #{@phone.inspect}, tmx_session_id:"\
+      " #{@tmx_session_id.inspect}, first_txn: #{@first_txn.inspect}, payment:"\
+      " #{@payment.inspect}>"
+    end
+  end
+end