Class: Increase::Models::Simulations::CardAuthorizationCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/increase/models/simulations/card_authorization_create_params.rb

Overview

See Also:

Defined Under Namespace

Modules: DeclineReason, Direction Classes: NetworkDetails

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

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, 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: , authenticated_card_payment_id: nil, card_id: nil, decline_reason: nil, digital_wallet_token_id: nil, direction: nil, event_subscription_id: nil, merchant_acceptor_id: nil, merchant_category_code: nil, merchant_city: nil, merchant_country: nil, merchant_descriptor: nil, merchant_state: nil, network_details: nil, network_risk_score: nil, physical_card_id: nil, terminal_id: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Increase::Models::Simulations::CardAuthorizationCreateParams for more details.

Parameters:

  • amount (Integer) (defaults to: ) —

    The authorization amount in cents.

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

    The identifier of a Card Payment with a ‘card_authentication` if you want to sim

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

    The identifier of the Card to be authorized.

  • decline_reason (Symbol, Increase::Models::Simulations::CardAuthorizationCreateParams::DeclineReason) (defaults to: nil) —

    Forces a card decline with a specific reason. No real time decision will be sent

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

    The identifier of the Digital Wallet Token to be authorized.

  • direction (Symbol, Increase::Models::Simulations::CardAuthorizationCreateParams::Direction) (defaults to: nil) —

    The direction describes the direction the funds will move, either from the cardh

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

    The identifier of the Event Subscription to use. If provided, will override the

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

    The merchant identifier (commonly abbreviated as MID) of the merchant the card i

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

    The Merchant Category Code (commonly abbreviated as MCC) of the merchant the car

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

    The city the merchant resides in.

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

    The country the merchant resides in.

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

    The merchant descriptor of the merchant the card is transacting with.

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

    The state the merchant resides in.

  • network_details (Increase::Models::Simulations::CardAuthorizationCreateParams::NetworkDetails) (defaults to: nil) —

    Fields specific to a given card network.

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

    The risk score generated by the card network. For Visa this is the Visa Advanced

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

    The identifier of the Physical Card to be authorized.

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

    The terminal identifier (commonly abbreviated as TID) of the terminal the card i

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



# File 'lib/increase/models/simulations/card_authorization_create_params.rb', line 126

Instance Attribute Details

#amount ⇒ Integer

The authorization amount in cents.

Returns:

  • (Integer) 


15
 
# File 'lib/increase/models/simulations/card_authorization_create_params.rb', line 15

required :amount, Integer

#authenticated_card_payment_id ⇒ String?

The identifier of a Card Payment with a ‘card_authentication` if you want to simulate an authenticated authorization.

Returns:

  • (String, nil) 


22
 
# File 'lib/increase/models/simulations/card_authorization_create_params.rb', line 22

optional :authenticated_card_payment_id, String

#card_id ⇒ String?

The identifier of the Card to be authorized.

Returns:

  • (String, nil) 


28
 
# File 'lib/increase/models/simulations/card_authorization_create_params.rb', line 28

optional :card_id, String

#decline_reason ⇒ Symbol, ...

Forces a card decline with a specific reason. No real time decision will be sent.

Returns:



35
36
37
38
 
# File 'lib/increase/models/simulations/card_authorization_create_params.rb', line 35

optional :decline_reason,
enum: -> {
  Increase::Simulations::CardAuthorizationCreateParams::DeclineReason
}

#digital_wallet_token_id ⇒ String?

The identifier of the Digital Wallet Token to be authorized.

Returns:

  • (String, nil) 


44
 
# File 'lib/increase/models/simulations/card_authorization_create_params.rb', line 44

optional :digital_wallet_token_id, String

#direction ⇒ Symbol, ...

The direction describes the direction the funds will move, either from the cardholder to the merchant or from the merchant to the cardholder.

Returns:



51
 
# File 'lib/increase/models/simulations/card_authorization_create_params.rb', line 51

optional :direction, enum: -> { Increase::Simulations::CardAuthorizationCreateParams::Direction }

#event_subscription_id ⇒ String?

The identifier of the Event Subscription to use. If provided, will override the default real time event subscription. Because you can only create one real time decision event subscription, you can use this field to route events to any specified event subscription for testing purposes.

Returns:

  • (String, nil) 


60
 
# File 'lib/increase/models/simulations/card_authorization_create_params.rb', line 60

optional :event_subscription_id, String

#merchant_acceptor_id ⇒ String?

The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with.

Returns:

  • (String, nil) 


67
 
# File 'lib/increase/models/simulations/card_authorization_create_params.rb', line 67

optional :merchant_acceptor_id, String

#merchant_category_code ⇒ String?

The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with.

Returns:

  • (String, nil) 


74
 
# File 'lib/increase/models/simulations/card_authorization_create_params.rb', line 74

optional :merchant_category_code, String

#merchant_city ⇒ String?

The city the merchant resides in.

Returns:

  • (String, nil) 


80
 
# File 'lib/increase/models/simulations/card_authorization_create_params.rb', line 80

optional :merchant_city, String

#merchant_country ⇒ String?

The country the merchant resides in.

Returns:

  • (String, nil) 


86
 
# File 'lib/increase/models/simulations/card_authorization_create_params.rb', line 86

optional :merchant_country, String

#merchant_descriptor ⇒ String?

The merchant descriptor of the merchant the card is transacting with.

Returns:

  • (String, nil) 


92
 
# File 'lib/increase/models/simulations/card_authorization_create_params.rb', line 92

optional :merchant_descriptor, String

#merchant_state ⇒ String?

The state the merchant resides in.

Returns:

  • (String, nil) 


98
 
# File 'lib/increase/models/simulations/card_authorization_create_params.rb', line 98

optional :merchant_state, String

#network_details ⇒ Increase::Models::Simulations::CardAuthorizationCreateParams::NetworkDetails?

Fields specific to a given card network.

Returns:



104
 
# File 'lib/increase/models/simulations/card_authorization_create_params.rb', line 104

optional :network_details, -> { Increase::Simulations::CardAuthorizationCreateParams::NetworkDetails }

#network_risk_score ⇒ Integer?

The risk score generated by the card network. For Visa this is the Visa Advanced Authorization risk score, from 0 to 99, where 99 is the riskiest.

Returns:

  • (Integer, nil) 


111
 
# File 'lib/increase/models/simulations/card_authorization_create_params.rb', line 111

optional :network_risk_score, Integer

#physical_card_id ⇒ String?

The identifier of the Physical Card to be authorized.

Returns:

  • (String, nil) 


117
 
# File 'lib/increase/models/simulations/card_authorization_create_params.rb', line 117

optional :physical_card_id, String

#terminal_id ⇒ String?

The terminal identifier (commonly abbreviated as TID) of the terminal the card is transacting with.

Returns:

  • (String, nil) 


124
 
# File 'lib/increase/models/simulations/card_authorization_create_params.rb', line 124

optional :terminal_id, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/simulations/card_authorization_create_params.rb', line 225