Class: Lithic::Models::NonPCICard

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/lithic/models/non_pci_card.rb

Overview

See Also:

Direct Known Subclasses

Card

Defined Under Namespace

Modules: PinStatus, State, Substatus, Type Classes: Funding

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(token:, account_token:, card_program_token:, created:, funding:, last_four:, pin_status:, spend_limit:, spend_limit_duration:, state:, type:, auth_rule_tokens: nil, bulk_order_token: nil, cardholder_currency: nil, comment: nil, digital_card_art_token: nil, exp_month: nil, exp_year: nil, hostname: nil, memo: nil, network_program_token: nil, pending_commands: nil, product_id: nil, replacement_for: nil, substatus: nil) ⇒ Object

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

Card details without PCI information

Clos

t

ca

Parameters:

  • token (String) —

    Globally unique identifier.

  • account_token (String) —

    Globally unique identifier for the account to which the card belongs.

  • card_program_token (String) —

    Globally unique identifier for the card program on which the card exists.

  • created (Time) —

    An RFC 3339 timestamp for when the card was created. UTC time zone.

  • funding (Lithic::Models::NonPCICard::Funding) —

    Deprecated: Funding account for the card.

  • last_four (String) —

    Last four digits of the card number.

  • pin_status (Symbol, Lithic::Models::NonPCICard::PinStatus) —

    Indicates if a card is blocked due a PIN status issue (e.g. excessive incorrect

  • spend_limit (Integer) —

    Amount (in cents) to limit approved authorizations (e.g. 100000 would be a $1,00

  • spend_limit_duration (Symbol, Lithic::Models::SpendLimitDuration) —

    Spend limit duration values:

  • state (Symbol, Lithic::Models::NonPCICard::State) —

    Card state values: * ‘CLOSED` - Card will no longer approve authorizations.

  • type (Symbol, Lithic::Models::NonPCICard::Type) —

    Card types: * ‘VIRTUAL` - Card will authorize at any merchant and can be added

  • auth_rule_tokens (Array<String>) (defaults to: nil) —

    List of identifiers for the Auth Rule(s) that are applied on the card. This fiel

  • bulk_order_token (String, nil) (defaults to: nil) —

    Globally unique identifier for the bulk order associated with this card. Only ap

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

    3-character alphabetic ISO 4217 code for the currency of the cardholder.

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

    Additional context or information related to the card.

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

    Specifies the digital card art to be displayed in the user’s digital wallet afte

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

    Two digit (MM) expiry month.

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

    Four digit (yyyy) expiry year.

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

    Hostname of card’s locked merchant (will be empty if not applicable).

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

    Friendly name to identify the card.

  • network_program_token (String, nil) (defaults to: nil) —

    Globally unique identifier for the card’s network program. Null if the card is n

  • pending_commands (Array<String>) (defaults to: nil) —

    Indicates if there are offline PIN changes pending card interaction with an offl

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

    Only applicable to cards of type ‘PHYSICAL`. This must be configured with Lithic

  • replacement_for (String, nil) (defaults to: nil) —

    If the card is a replacement for another card, the globally unique identifier fo

  • substatus (Symbol, Lithic::Models::NonPCICard::Substatus) (defaults to: nil) —

    Card state substatus values: * ‘LOST` - The physical card is no longer in the




# File 'lib/lithic/models/non_pci_card.rb', line 227

Instance Attribute Details

#account_token ⇒ String

Globally unique identifier for the account to which the card belongs.

Returns:

  • (String) 


17
 
# File 'lib/lithic/models/non_pci_card.rb', line 17

required :account_token, String

#auth_rule_tokens ⇒ Array<String>?

Deprecated.

List of identifiers for the Auth Rule(s) that are applied on the card. This field is deprecated and will no longer be populated in the ‘Card` object. The key will be removed from the schema in a future release. Use the `/auth_rules` endpoints to fetch Auth Rule information instead.

Returns:

  • (Array<String>, nil) 


118
 
# File 'lib/lithic/models/non_pci_card.rb', line 118

optional :auth_rule_tokens, Lithic::Internal::Type::ArrayOf[String]

#bulk_order_token ⇒ String?

Globally unique identifier for the bulk order associated with this card. Only applicable to physical cards that are part of a bulk shipment

Returns:

  • (String, nil) 


125
 
# File 'lib/lithic/models/non_pci_card.rb', line 125

optional :bulk_order_token, String, nil?: true

#card_program_token ⇒ String

Globally unique identifier for the card program on which the card exists.

Returns:

  • (String) 


23
 
# File 'lib/lithic/models/non_pci_card.rb', line 23

required :card_program_token, String

#cardholder_currency ⇒ String?

3-character alphabetic ISO 4217 code for the currency of the cardholder.

Returns:

  • (String, nil) 


131
 
# File 'lib/lithic/models/non_pci_card.rb', line 131

optional :cardholder_currency, String

#comment ⇒ String?

Additional context or information related to the card.

Returns:

  • (String, nil) 


137
 
# File 'lib/lithic/models/non_pci_card.rb', line 137

optional :comment, String

#created ⇒ Time

An RFC 3339 timestamp for when the card was created. UTC time zone.

Returns:

  • (Time) 


29
 
# File 'lib/lithic/models/non_pci_card.rb', line 29

required :created, Time

#digital_card_art_token ⇒ String?

Specifies the digital card art to be displayed in the user’s digital wallet after tokenization. This artwork must be approved by Mastercard and configured by Lithic to use.

Returns:

  • (String, nil) 


145
 
# File 'lib/lithic/models/non_pci_card.rb', line 145

optional :digital_card_art_token, String

#exp_month ⇒ String?

Two digit (MM) expiry month.

Returns:

  • (String, nil) 


151
 
# File 'lib/lithic/models/non_pci_card.rb', line 151

optional :exp_month, String

#exp_year ⇒ String?

Four digit (yyyy) expiry year.

Returns:

  • (String, nil) 


157
 
# File 'lib/lithic/models/non_pci_card.rb', line 157

optional :exp_year, String

#funding ⇒ Lithic::Models::NonPCICard::Funding

Deprecated: Funding account for the card.

Returns:



35
 
# File 'lib/lithic/models/non_pci_card.rb', line 35

required :funding, -> { Lithic::NonPCICard::Funding }

#hostname ⇒ String?

Hostname of card’s locked merchant (will be empty if not applicable).

Returns:

  • (String, nil) 


163
 
# File 'lib/lithic/models/non_pci_card.rb', line 163

optional :hostname, String

#last_four ⇒ String

Last four digits of the card number.

Returns:

  • (String) 


41
 
# File 'lib/lithic/models/non_pci_card.rb', line 41

required :last_four, String

#memo ⇒ String?

Friendly name to identify the card.

Returns:

  • (String, nil) 


169
 
# File 'lib/lithic/models/non_pci_card.rb', line 169

optional :memo, String

#network_program_token ⇒ String?

Globally unique identifier for the card’s network program. Null if the card is not associated with a network program. Currently applicable to Visa cards participating in Account Level Management only

Returns:

  • (String, nil) 


177
 
# File 'lib/lithic/models/non_pci_card.rb', line 177

optional :network_program_token, String, nil?: true

#pending_commands ⇒ Array<String>?

Indicates if there are offline PIN changes pending card interaction with an offline PIN terminal. Possible commands are: CHANGE_PIN, UNBLOCK_PIN. Applicable only to cards issued in markets supporting offline PINs.

Returns:

  • (Array<String>, nil) 


185
 
# File 'lib/lithic/models/non_pci_card.rb', line 185

optional :pending_commands, Lithic::Internal::Type::ArrayOf[String]

#pin_status ⇒ Symbol, Lithic::Models::NonPCICard::PinStatus

Indicates if a card is blocked due a PIN status issue (e.g. excessive incorrect attempts).

Returns:



48
 
# File 'lib/lithic/models/non_pci_card.rb', line 48

required :pin_status, enum: -> { Lithic::NonPCICard::PinStatus }

#product_id ⇒ String?

Only applicable to cards of type ‘PHYSICAL`. This must be configured with Lithic before use. Specifies the configuration (i.e., physical card art) that the card should be manufactured with.

Returns:

  • (String, nil) 


193
 
# File 'lib/lithic/models/non_pci_card.rb', line 193

optional :product_id, String

#replacement_for ⇒ String?

If the card is a replacement for another card, the globally unique identifier for the card that was replaced.

Returns:

  • (String, nil) 


200
 
# File 'lib/lithic/models/non_pci_card.rb', line 200

optional :replacement_for, String, nil?: true

#spend_limit ⇒ Integer

Amount (in cents) to limit approved authorizations (e.g. 100000 would be a $1,000 limit). Transaction requests above the spend limit will be declined.

Returns:

  • (Integer) 


55
 
# File 'lib/lithic/models/non_pci_card.rb', line 55

required :spend_limit, Integer

#spend_limit_duration ⇒ Symbol, Lithic::Models::SpendLimitDuration

Spend limit duration values:

  • ‘ANNUALLY` - Card will authorize transactions up to spend limit for the trailing year.

  • ‘FOREVER` - Card will authorize only up to spend limit for the entire lifetime of the card.

  • ‘MONTHLY` - Card will authorize transactions up to spend limit for the trailing month. To support recurring monthly payments, which can occur on different day every month, the time window we consider for monthly velocity starts 6 days after the current calendar date one month prior.

  • ‘TRANSACTION` - Card will authorize multiple transactions if each individual transaction is under the spend limit.

Returns:



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

required :spend_limit_duration, enum: -> { Lithic::SpendLimitDuration }

#state ⇒ Symbol, Lithic::Models::NonPCICard::State

Card state values: _ ‘CLOSED` - Card will no longer approve authorizations. Closing a card cannot be undone. _ `OPEN` - Card will approve authorizations (if they match card and account parameters). _ `PAUSED` - Card will decline authorizations, but can be resumed at a later time. _ `PENDING_FULFILLMENT` - The initial state for cards of type `PHYSICAL`. The card is provisioned pending manufacturing and fulfillment. Cards in this state can accept authorizations for e-commerce purchases, but not for “Card Present” purchases where the physical card itself is present. * `PENDING_ACTIVATION` - At regular intervals, cards of type `PHYSICAL` in state `PENDING_FULFILLMENT` are sent to the card production warehouse and updated to state `PENDING_ACTIVATION`. Similar to `PENDING_FULFILLMENT`, cards in this state can be used for e-commerce transactions or can be added to mobile wallets. API clients should update the card’s state to ‘OPEN` only after the cardholder confirms receipt of the card. In sandbox, the same daily batch fulfillment occurs, but no cards are actually manufactured.

Returns:



92
 
# File 'lib/lithic/models/non_pci_card.rb', line 92

required :state, enum: -> { Lithic::NonPCICard::State }

#substatus ⇒ Symbol, ...

Card state substatus values: _ ‘LOST` - The physical card is no longer in the cardholder’s possession due to being lost or never received by the cardholder. _ ‘COMPROMISED` - Card information has been exposed, potentially leading to unauthorized access. This may involve physical card theft, cloning, or online data breaches. _ `DAMAGED` - The physical card is not functioning properly, such as having chip failures or a demagnetized magnetic stripe. _ `END_USER_REQUEST` - The cardholder requested the closure of the card for reasons unrelated to fraud or damage, such as switching to a different product or closing the account. _ `ISSUER_REQUEST` - The issuer closed the card for reasons unrelated to fraud or damage, such as account inactivity, product or policy changes, or technology upgrades. _ `NOT_ACTIVE` - The card hasn’t had any transaction activity for a specified period, applicable to statuses like `PAUSED` or `CLOSED`. _ `SUSPICIOUS_ACTIVITY` - The card has one or more suspicious transactions or activities that require review. This can involve prompting the cardholder to confirm legitimate use or report confirmed fraud. _ `INTERNAL_REVIEW` - The card is temporarily paused pending further internal review. _ `EXPIRED` - The card has expired and has been closed without being reissued. _ `UNDELIVERABLE` - The card cannot be delivered to the cardholder and has been returned. * `OTHER` - The reason for the status does not fall into any of the above categories. A comment can be provided to specify the reason.

Returns:



225
 
# File 'lib/lithic/models/non_pci_card.rb', line 225

optional :substatus, enum: -> { Lithic::NonPCICard::Substatus }

#token ⇒ String

Globally unique identifier.

Returns:

  • (String) 


11
 
# File 'lib/lithic/models/non_pci_card.rb', line 11

required :token, String

#type ⇒ Symbol, Lithic::Models::NonPCICard::Type

Card types: _ ‘VIRTUAL` - Card will authorize at any merchant and can be added to a digital wallet like Apple Pay or Google Pay (if the card program is digital wallet-enabled). _ `PHYSICAL` - Manufactured and sent to the cardholder. We offer white label branding, credit, ATM, PIN debit, chip/EMV, NFC and magstripe functionality. _ `SINGLE_USE` - Card is closed upon first successful authorization. _ `MERCHANT_LOCKED` - [Deprecated] Card is locked to the first merchant that successfully authorizes the card. _ `UNLOCKED` - [Deprecated] Similar behavior to VIRTUAL cards, please use VIRTUAL instead. _ `DIGITAL_WALLET` - [Deprecated] Similar behavior to VIRTUAL cards, please use VIRTUAL instead.

Returns:



107
 
# File 'lib/lithic/models/non_pci_card.rb', line 107

required :type, enum: -> { Lithic::NonPCICard::Type }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/lithic/models/non_pci_card.rb', line 384