Class: Lithic::Models::TransactionSimulateAuthorizationParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/lithic/models/transaction_simulate_authorization_params.rb

Overview

See Also:

Defined Under Namespace

Modules: Status

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(amount:, descriptor:, pan:, mcc: nil, merchant_acceptor_id: nil, merchant_amount: nil, merchant_currency: nil, partial_approval_capable: nil, pin: nil, status: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Lithic::Models::TransactionSimulateAuthorizationParams for more details.

Parameters:

  • amount (Integer) —

    Amount (in cents) to authorize. For credit authorizations and financial credit a

  • descriptor (String) —

    Merchant descriptor.

  • pan (String) —

    Sixteen digit card number.

  • mcc (String) (defaults to: nil) —

    Merchant category code for the transaction to be simulated. A four-digit number

  • merchant_acceptor_id (String) (defaults to: nil) —

    Unique identifier to identify the payment card acceptor.

  • merchant_amount (Integer) (defaults to: nil) —

    Amount of the transaction to be simulated in currency specified in merchant_curr

  • merchant_currency (String) (defaults to: nil) —

    3-character alphabetic ISO 4217 currency code. Note: Simulator only accepts USD,

  • partial_approval_capable (Boolean) (defaults to: nil) —

    Set to true if the terminal is capable of partial approval otherwise false.

  • pin (String) (defaults to: nil) —

    Simulate entering a PIN. If omitted, PIN check will not be performed.

  • status (Symbol, Lithic::Models::TransactionSimulateAuthorizationParams::Status) (defaults to: nil) —

    Type of event to simulate.

  • request_options (Lithic::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/lithic/models/transaction_simulate_authorization_params.rb', line 95

Instance Attribute Details

#amount ⇒ Integer

Amount (in cents) to authorize. For credit authorizations and financial credit authorizations, any value entered will be converted into a negative amount in the simulated transaction. For example, entering 100 in this field will result in a -100 amount in the transaction. For balance inquiries, this field must be set to 0.

Returns:

  • (Integer) 


18
 
# File 'lib/lithic/models/transaction_simulate_authorization_params.rb', line 18

required :amount, Integer

#descriptor ⇒ String

Merchant descriptor.

Returns:

  • (String) 


24
 
# File 'lib/lithic/models/transaction_simulate_authorization_params.rb', line 24

required :descriptor, String

#mcc ⇒ String?

Merchant category code for the transaction to be simulated. A four-digit number listed in ISO 18245. Supported merchant category codes can be found [here](docs.lithic.com/docs/transactions#merchant-category-codes-mccs).

Returns:

  • (String, nil) 


38
 
# File 'lib/lithic/models/transaction_simulate_authorization_params.rb', line 38

optional :mcc, String

#merchant_acceptor_id ⇒ String?

Unique identifier to identify the payment card acceptor.

Returns:

  • (String, nil) 


44
 
# File 'lib/lithic/models/transaction_simulate_authorization_params.rb', line 44

optional :merchant_acceptor_id, String

#merchant_amount ⇒ Integer?

Amount of the transaction to be simulated in currency specified in merchant_currency, including any acquirer fees.

Returns:

  • (Integer, nil) 


51
 
# File 'lib/lithic/models/transaction_simulate_authorization_params.rb', line 51

optional :merchant_amount, Integer

#merchant_currency ⇒ String?

3-character alphabetic ISO 4217 currency code. Note: Simulator only accepts USD, GBP, EUR and defaults to GBP if another ISO 4217 code is provided

Returns:

  • (String, nil) 


58
 
# File 'lib/lithic/models/transaction_simulate_authorization_params.rb', line 58

optional :merchant_currency, String

#pan ⇒ String

Sixteen digit card number.

Returns:

  • (String) 


30
 
# File 'lib/lithic/models/transaction_simulate_authorization_params.rb', line 30

required :pan, String

#partial_approval_capable ⇒ Boolean?

Set to true if the terminal is capable of partial approval otherwise false. Partial approval is when part of a transaction is approved and another payment must be used for the remainder.

Returns:

  • (Boolean, nil) 


66
 
# File 'lib/lithic/models/transaction_simulate_authorization_params.rb', line 66

optional :partial_approval_capable, Lithic::Internal::Type::Boolean

#pin ⇒ String?

Simulate entering a PIN. If omitted, PIN check will not be performed.

Returns:

  • (String, nil) 


72
 
# File 'lib/lithic/models/transaction_simulate_authorization_params.rb', line 72

optional :pin, String

#status ⇒ Symbol, ...

Type of event to simulate.

  • ‘AUTHORIZATION` is a dual message purchase authorization, meaning a subsequent clearing step is required to settle the transaction.

  • ‘BALANCE_INQUIRY` is a $0 authorization requesting the balance held on the card, and is most often observed when a cardholder requests to view a card’s balance at an ATM.

  • ‘CREDIT_AUTHORIZATION` is a dual message request from a merchant to authorize a refund, meaning a subsequent clearing step is required to settle the transaction.

  • ‘FINANCIAL_AUTHORIZATION` is a single message request from a merchant to debit funds immediately (such as an ATM withdrawal), and no subsequent clearing is required to settle the transaction.

  • ‘FINANCIAL_CREDIT_AUTHORIZATION` is a single message request from a merchant to credit funds immediately, and no subsequent clearing is required to settle the transaction.

Returns:



93
 
# File 'lib/lithic/models/transaction_simulate_authorization_params.rb', line 93

optional :status, enum: -> { Lithic::TransactionSimulateAuthorizationParams::Status }