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
CLOSEDstate is a final action that cannot be undone.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classCardUpdateParams.BuilderA builder for CardUpdateParams.
public final classCardUpdateParams.Bodypublic final classCardUpdateParams.PinStatusIndicates if a card is blocked due a PIN status issue (e.g. excessive incorrect attempts). Can only be set to
OKto unblock a card.public final classCardUpdateParams.StateCard 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.
-
Method Summary
Modifier and Type Method Description final Optional<String>cardToken()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>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 JsonField<String>_digitalCardArtToken()Returns the raw JSON value of digitalCardArtToken. final JsonField<String>_memo()Returns the raw JSON value of memo. 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 Map<String, JsonValue>_additionalBodyProperties()final Headers_additionalHeaders()final QueryParams_additionalQueryParams()final CardUpdateParams.BuildertoBuilder()final CardUpdateParams.Body_body()final String_pathParam(Integer index)Headers_headers()The full set of headers in the parameters, including both fixed and additional headers. QueryParams_queryParams()The full set of query params in the parameters, including both fixed and additional query params. Booleanequals(Object other)IntegerhashCode()StringtoString()final static CardUpdateParamsnone()final static CardUpdateParams.Builderbuilder()Returns a mutable builder for constructing an instance of CardUpdateParams. -
-
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.
-
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.
-
_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.
-
_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.
-
_additionalBodyProperties
final Map<String, JsonValue> _additionalBodyProperties()
-
_additionalHeaders
final Headers _additionalHeaders()
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
-
toBuilder
final CardUpdateParams.Builder toBuilder()
-
_body
final CardUpdateParams.Body _body()
-
_pathParam
final String _pathParam(Integer index)
-
_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.
-
none
final static CardUpdateParams none()
-
builder
final static CardUpdateParams.Builder builder()
Returns a mutable builder for constructing an instance of CardUpdateParams.
-
-
-