Class: Increase::Models::CardValidation

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/increase/models/card_validation.rb

Overview

See Also:

Defined Under Namespace

Modules: Status, Type Classes: Acceptance, CreatedBy, Decline, Submission

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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(retrieval_reference_number: , submitted_at: , trace_number: ) ⇒ Object

Some parameter documentations has been truncated, see Submission for more details.

After the validation is submitted to the card network, this will contain supplemental details.

Parameters:

  • retrieval_reference_number (String) (defaults to: ) —

    A 12-digit retrieval reference number that identifies the validation. Usually a

  • submitted_at (Time) (defaults to: ) —

    The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date and time at which th

  • trace_number (String) (defaults to: ) —

    A 6-digit trace number that identifies the validation within a short time window




# File 'lib/increase/models/card_validation.rb', line 142

Instance Attribute Details

#acceptance ⇒ Increase::Models::CardValidation::Acceptance?

If the validation is accepted by the recipient bank, this will contain supplemental details.

Returns:



18
 
# File 'lib/increase/models/card_validation.rb', line 18

required :acceptance, -> { Increase::CardValidation::Acceptance }, nil?: true

#account_id ⇒ String

The identifier of the Account from which to send the validation.

Returns:

  • (String) 


24
 
# File 'lib/increase/models/card_validation.rb', line 24

required :account_id, String

#card_token_id ⇒ String

The ID of the Card Token that was used to validate the card.

Returns:

  • (String) 


30
 
# File 'lib/increase/models/card_validation.rb', line 30

required :card_token_id, String

#cardholder_first_name ⇒ String?

The cardholder’s first name.

Returns:

  • (String, nil) 


36
 
# File 'lib/increase/models/card_validation.rb', line 36

required :cardholder_first_name, String, nil?: true

#cardholder_last_name ⇒ String?

The cardholder’s last name.

Returns:

  • (String, nil) 


42
 
# File 'lib/increase/models/card_validation.rb', line 42

required :cardholder_last_name, String, nil?: true

#cardholder_middle_name ⇒ String?

The cardholder’s middle name.

Returns:

  • (String, nil) 


48
 
# File 'lib/increase/models/card_validation.rb', line 48

required :cardholder_middle_name, String, nil?: true

#cardholder_postal_code ⇒ String?

The postal code of the cardholder’s address.

Returns:

  • (String, nil) 


54
 
# File 'lib/increase/models/card_validation.rb', line 54

required :cardholder_postal_code, String, nil?: true

#cardholder_street_address ⇒ String?

The cardholder’s street address.

Returns:

  • (String, nil) 


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

required :cardholder_street_address, String, nil?: true

#created_at ⇒ Time

The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date and time at which the validation was created.

Returns:

  • (Time) 


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

required :created_at, Time

#created_by ⇒ Increase::Models::CardValidation::CreatedBy?

What object created the validation, either via the API or the dashboard.

Returns:



73
 
# File 'lib/increase/models/card_validation.rb', line 73

required :created_by, -> { Increase::CardValidation::CreatedBy }, nil?: true

#decline ⇒ Increase::Models::CardValidation::Decline?

If the validation is rejected by the card network or the destination financial institution, this will contain supplemental details.

Returns:



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

required :decline, -> { Increase::CardValidation::Decline }, nil?: true

#id ⇒ String

The Card Validation’s identifier.

Returns:

  • (String) 


11
 
# File 'lib/increase/models/card_validation.rb', line 11

required :id, String

#idempotency_key ⇒ String?

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](increase.com/documentation/idempotency-keys).

Returns:

  • (String, nil) 


88
 
# File 'lib/increase/models/card_validation.rb', line 88

required :idempotency_key, String, nil?: true

#merchant_category_code ⇒ String

A four-digit code (MCC) identifying the type of business or service provided by the merchant.

Returns:

  • (String) 


95
 
# File 'lib/increase/models/card_validation.rb', line 95

required :merchant_category_code, String

#merchant_city_name ⇒ String

The city where the merchant (typically your business) is located.

Returns:

  • (String) 


101
 
# File 'lib/increase/models/card_validation.rb', line 101

required :merchant_city_name, String

#merchant_name ⇒ String

The merchant name that will appear in the cardholder’s statement descriptor. Typically your business name.

Returns:

  • (String) 


108
 
# File 'lib/increase/models/card_validation.rb', line 108

required :merchant_name, String

#merchant_postal_code ⇒ String

The postal code for the merchant’s (typically your business’s) location.

Returns:

  • (String) 


114
 
# File 'lib/increase/models/card_validation.rb', line 114

required :merchant_postal_code, String

#merchant_state ⇒ String

The U.S. state where the merchant (typically your business) is located.

Returns:

  • (String) 


120
 
# File 'lib/increase/models/card_validation.rb', line 120

required :merchant_state, String

#status ⇒ Symbol, Increase::Models::CardValidation::Status

The lifecycle status of the validation.

Returns:



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

required :status, enum: -> { Increase::CardValidation::Status }

#submission ⇒ Increase::Models::CardValidation::Submission?

After the validation is submitted to the card network, this will contain supplemental details.

Returns:



133
 
# File 'lib/increase/models/card_validation.rb', line 133

required :submission, -> { Increase::CardValidation::Submission }, nil?: true

#type ⇒ Symbol, Increase::Models::CardValidation::Type

A constant representing the object’s type. For this resource it will always be ‘card_validation`.

Returns:



140
 
# File 'lib/increase/models/card_validation.rb', line 140

required :type, enum: -> { Increase::CardValidation::Type }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/card_validation.rb', line 415