Class CardUpdateParams.Body
-
- All Implemented Interfaces:
public final class CardUpdateParams.Body
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classCardUpdateParams.Body.BuilderA builder for Body.
-
Method Summary
Modifier and Type Method Description final Optional<String>comment()Additional context or information related to the card. final Optional<String>digitalCardArtToken()Specifies the digital card art to be displayed in the user’s digital wallet after tokenization. final Optional<String>memo()Friendly name to identify the card. final Optional<String>networkProgramToken()Globally unique identifier for the card's network program. final Optional<String>pin()Encrypted PIN block (in base64). final Optional<CardUpdateParams.PinStatus>pinStatus()Indicates if a card is blocked due a PIN status issue (e.g. final Optional<Long>spendLimit()Amount (in cents) to limit approved authorizations (e.g. 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.
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.
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 likePAUSEDorCLOSED.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.
final JsonField<String>_comment()Returns the raw JSON value of comment. final JsonField<String>_digitalCardArtToken()Returns the raw JSON value of digitalCardArtToken. final JsonField<String>_memo()Returns the raw JSON value of memo. final JsonField<String>_networkProgramToken()Returns the raw JSON value of networkProgramToken. final JsonField<String>_pin()Returns the raw JSON value of pin. final JsonField<CardUpdateParams.PinStatus>_pinStatus()Returns the raw JSON value of pinStatus. final JsonField<Long>_spendLimit()Returns the raw JSON value of spendLimit. final JsonField<SpendLimitDuration>_spendLimitDuration()Returns the raw JSON value of spendLimitDuration. final JsonField<CardUpdateParams.State>_state()Returns the raw JSON value of state. final JsonField<CardUpdateParams.Substatus>_substatus()Returns the raw JSON value of substatus. final Map<String, JsonValue>_additionalProperties()final CardUpdateParams.Body.BuildertoBuilder()final CardUpdateParams.Bodyvalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static CardUpdateParams.Body.Builderbuilder()Returns a mutable builder for constructing an instance of Body. -
-
Method Detail
-
digitalCardArtToken
final Optional<String> digitalCardArtToken()
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. See Flexible Card Art Guide.
-
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
PHYSICALandVIRTUAL. Changing PIN also resets PIN status toOK. See Encrypted PIN Block.
-
pinStatus
final Optional<CardUpdateParams.PinStatus> pinStatus()
Indicates if a card is blocked due a PIN status issue (e.g. excessive incorrect attempts). Can only be set to
OKto unblock a card.
-
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 likePAUSEDorCLOSED.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.
-
_comment
final JsonField<String> _comment()
Returns the raw JSON value of comment.
Unlike comment, this method doesn't throw if the JSON field has an unexpected type.
-
_digitalCardArtToken
final JsonField<String> _digitalCardArtToken()
Returns the raw JSON value of digitalCardArtToken.
Unlike digitalCardArtToken, this method doesn't throw if the JSON field has an unexpected type.
-
_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.
-
_networkProgramToken
final JsonField<String> _networkProgramToken()
Returns the raw JSON value of networkProgramToken.
Unlike networkProgramToken, 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.
-
_pinStatus
final JsonField<CardUpdateParams.PinStatus> _pinStatus()
Returns the raw JSON value of pinStatus.
Unlike pinStatus, this method doesn't throw if the JSON field has an unexpected type.
-
_spendLimit
final JsonField<Long> _spendLimit()
Returns the raw JSON value of spendLimit.
Unlike spendLimit, this method doesn't throw if the JSON field has an unexpected type.
-
_spendLimitDuration
final JsonField<SpendLimitDuration> _spendLimitDuration()
Returns the raw JSON value of spendLimitDuration.
Unlike spendLimitDuration, this method doesn't throw if the JSON field has an unexpected type.
-
_state
final JsonField<CardUpdateParams.State> _state()
Returns the raw JSON value of state.
Unlike state, this method doesn't throw if the JSON field has an unexpected type.
-
_substatus
final JsonField<CardUpdateParams.Substatus> _substatus()
Returns the raw JSON value of substatus.
Unlike substatus, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final CardUpdateParams.Body.Builder toBuilder()
-
validate
final CardUpdateParams.Body validate()
-
builder
final static CardUpdateParams.Body.Builder builder()
Returns a mutable builder for constructing an instance of Body.
-
-
-