Class CardUpdateParams

  • All Implemented Interfaces:
    com.lithic.api.core.Params

    
    public final class CardUpdateParams
     implements Params
                        

    Update the specified properties of the card. Unsupplied properties will remain unchanged.

    Note: setting a card to a CLOSED state is a final action that cannot be undone.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      public final class CardUpdateParams.Builder

      A builder for CardUpdateParams.

      public final class CardUpdateParams.Body
      public final class CardUpdateParams.PinStatus

      Indicates if a card is blocked due a PIN status issue (e.g. excessive incorrect attempts). Can only be set to OK to unblock a card.

      public final class CardUpdateParams.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.

      public final class CardUpdateParams.Substatus

      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 should be provided to specify the reason.

    • Field Summary

      Fields 
      Modifier and Type Field Description
    • Constructor Summary

      Constructors 
      Constructor Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Constructor Detail

    • Method Detail

      • networkProgramToken

         final Optional<String> networkProgramToken()

        Globally unique identifier for the card's network program. Currently applicable to Visa cards participating in Account Level Management only.

      • pin

         final Optional<String> pin()

        Encrypted PIN block (in base64). Only applies to cards of type PHYSICAL and VIRTUAL. Changing PIN also resets PIN status to OK. See Encrypted PIN Block.

      • spendLimit

         final Optional<Long> spendLimit()

        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. Note that a spend limit of 0 is effectively no limit, and should only be used to reset or remove a prior limit. Only a limit of 1 or above will result in declined transactions due to checks against the card limit.

      • spendLimitDuration

         final Optional<SpendLimitDuration> 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.

      • state

         final Optional<CardUpdateParams.State> 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.

      • substatus

         final Optional<CardUpdateParams.Substatus> substatus()

        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 should be provided to specify the reason.

      • _memo

         final JsonField<String> _memo()

        Returns the raw JSON value of memo.

        Unlike memo, this method doesn't throw if the JSON field has an unexpected type.

      • _pin

         final JsonField<String> _pin()

        Returns the raw JSON value of pin.

        Unlike pin, this method doesn't throw if the JSON field has an unexpected type.

      • _headers

         Headers _headers()

        The full set of headers in the parameters, including both fixed and additional headers.

      • _queryParams

         QueryParams _queryParams()

        The full set of query params in the parameters, including both fixed and additional query params.