Class CardUpdateParams.Builder
-
- All Implemented Interfaces:
public final class CardUpdateParams.BuilderA builder for CardUpdateParams.
-
-
Method Summary
Modifier and Type Method Description final CardUpdateParams.BuildercardToken(String cardToken)final CardUpdateParams.BuildercardToken(Optional<String> cardToken)Alias for calling Builder.cardToken with cardToken.orElse(null).final CardUpdateParams.Builderbody(CardUpdateParams.Body body)Sets the entire request body. final CardUpdateParams.Buildercomment(String comment)Additional context or information related to the card. final CardUpdateParams.Buildercomment(JsonField<String> comment)Sets Builder.comment to an arbitrary JSON value. final CardUpdateParams.BuilderdigitalCardArtToken(String digitalCardArtToken)Specifies the digital card art to be displayed in the user’s digital wallet after tokenization. final CardUpdateParams.BuilderdigitalCardArtToken(JsonField<String> digitalCardArtToken)Sets Builder.digitalCardArtToken to an arbitrary JSON value. final CardUpdateParams.Buildermemo(String memo)Friendly name to identify the card. final CardUpdateParams.Buildermemo(JsonField<String> memo)Sets Builder.memo to an arbitrary JSON value. final CardUpdateParams.BuildernetworkProgramToken(String networkProgramToken)Globally unique identifier for the card's network program. final CardUpdateParams.BuildernetworkProgramToken(JsonField<String> networkProgramToken)Sets Builder.networkProgramToken to an arbitrary JSON value. final CardUpdateParams.Builderpin(String pin)Encrypted PIN block (in base64). final CardUpdateParams.Builderpin(JsonField<String> pin)Sets Builder.pin to an arbitrary JSON value. final CardUpdateParams.BuilderpinStatus(CardUpdateParams.PinStatus pinStatus)Indicates if a card is blocked due a PIN status issue (e.g. final CardUpdateParams.BuilderpinStatus(JsonField<CardUpdateParams.PinStatus> pinStatus)Sets Builder.pinStatus to an arbitrary JSON value. final CardUpdateParams.BuilderspendLimit(Long spendLimit)Amount (in cents) to limit approved authorizations (e.g. final CardUpdateParams.BuilderspendLimit(JsonField<Long> spendLimit)Sets Builder.spendLimit to an arbitrary JSON value. final CardUpdateParams.BuilderspendLimitDuration(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 CardUpdateParams.BuilderspendLimitDuration(JsonField<SpendLimitDuration> spendLimitDuration)Sets Builder.spendLimitDuration to an arbitrary JSON value. final CardUpdateParams.Builderstate(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 CardUpdateParams.Builderstate(JsonField<CardUpdateParams.State> state)Sets Builder.state to an arbitrary JSON value. final CardUpdateParams.Buildersubstatus(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 CardUpdateParams.Buildersubstatus(JsonField<CardUpdateParams.Substatus> substatus)Sets Builder.substatus to an arbitrary JSON value. final CardUpdateParams.BuilderadditionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)final CardUpdateParams.BuilderputAdditionalBodyProperty(String key, JsonValue value)final CardUpdateParams.BuilderputAllAdditionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)final CardUpdateParams.BuilderremoveAdditionalBodyProperty(String key)final CardUpdateParams.BuilderremoveAllAdditionalBodyProperties(Set<String> keys)final CardUpdateParams.BuilderadditionalHeaders(Headers additionalHeaders)final CardUpdateParams.BuilderadditionalHeaders(Map<String, Iterable<String>> additionalHeaders)final CardUpdateParams.BuilderputAdditionalHeader(String name, String value)final CardUpdateParams.BuilderputAdditionalHeaders(String name, Iterable<String> values)final CardUpdateParams.BuilderputAllAdditionalHeaders(Headers additionalHeaders)final CardUpdateParams.BuilderputAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)final CardUpdateParams.BuilderreplaceAdditionalHeaders(String name, String value)final CardUpdateParams.BuilderreplaceAdditionalHeaders(String name, Iterable<String> values)final CardUpdateParams.BuilderreplaceAllAdditionalHeaders(Headers additionalHeaders)final CardUpdateParams.BuilderreplaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)final CardUpdateParams.BuilderremoveAdditionalHeaders(String name)final CardUpdateParams.BuilderremoveAllAdditionalHeaders(Set<String> names)final CardUpdateParams.BuilderadditionalQueryParams(QueryParams additionalQueryParams)final CardUpdateParams.BuilderadditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)final CardUpdateParams.BuilderputAdditionalQueryParam(String key, String value)final CardUpdateParams.BuilderputAdditionalQueryParams(String key, Iterable<String> values)final CardUpdateParams.BuilderputAllAdditionalQueryParams(QueryParams additionalQueryParams)final CardUpdateParams.BuilderputAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)final CardUpdateParams.BuilderreplaceAdditionalQueryParams(String key, String value)final CardUpdateParams.BuilderreplaceAdditionalQueryParams(String key, Iterable<String> values)final CardUpdateParams.BuilderreplaceAllAdditionalQueryParams(QueryParams additionalQueryParams)final CardUpdateParams.BuilderreplaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)final CardUpdateParams.BuilderremoveAdditionalQueryParams(String key)final CardUpdateParams.BuilderremoveAllAdditionalQueryParams(Set<String> keys)final CardUpdateParamsbuild()Returns an immutable instance of CardUpdateParams. -
-
Method Detail
-
cardToken
final CardUpdateParams.Builder cardToken(String cardToken)
-
cardToken
final CardUpdateParams.Builder cardToken(Optional<String> cardToken)
Alias for calling Builder.cardToken with
cardToken.orElse(null).
-
body
final CardUpdateParams.Builder body(CardUpdateParams.Body body)
Sets the entire request body.
This is generally only useful if you are already constructing the body separately. Otherwise, it's more convenient to use the top-level setters instead:
-
comment
final CardUpdateParams.Builder comment(String comment)
Additional context or information related to the card.
-
comment
final CardUpdateParams.Builder comment(JsonField<String> comment)
Sets Builder.comment to an arbitrary JSON value.
You should usually call Builder.comment with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
digitalCardArtToken
final CardUpdateParams.Builder digitalCardArtToken(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.
-
digitalCardArtToken
final CardUpdateParams.Builder digitalCardArtToken(JsonField<String> digitalCardArtToken)
Sets Builder.digitalCardArtToken to an arbitrary JSON value.
You should usually call Builder.digitalCardArtToken with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
memo
final CardUpdateParams.Builder memo(String memo)
Friendly name to identify the card.
-
memo
final CardUpdateParams.Builder memo(JsonField<String> memo)
Sets Builder.memo to an arbitrary JSON value.
You should usually call Builder.memo with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
networkProgramToken
final CardUpdateParams.Builder networkProgramToken(String networkProgramToken)
Globally unique identifier for the card's network program. Currently applicable to Visa cards participating in Account Level Management only.
-
networkProgramToken
final CardUpdateParams.Builder networkProgramToken(JsonField<String> networkProgramToken)
Sets Builder.networkProgramToken to an arbitrary JSON value.
You should usually call Builder.networkProgramToken with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
pin
final CardUpdateParams.Builder pin(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.
-
pin
final CardUpdateParams.Builder pin(JsonField<String> pin)
Sets Builder.pin to an arbitrary JSON value.
You should usually call Builder.pin with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
pinStatus
final CardUpdateParams.Builder pinStatus(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.
-
pinStatus
final CardUpdateParams.Builder pinStatus(JsonField<CardUpdateParams.PinStatus> pinStatus)
Sets Builder.pinStatus to an arbitrary JSON value.
You should usually call Builder.pinStatus with a well-typed PinStatus value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
spendLimit
final CardUpdateParams.Builder spendLimit(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.
-
spendLimit
final CardUpdateParams.Builder spendLimit(JsonField<Long> spendLimit)
Sets Builder.spendLimit to an arbitrary JSON value.
You should usually call Builder.spendLimit with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
spendLimitDuration
final CardUpdateParams.Builder spendLimitDuration(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.
-
spendLimitDuration
final CardUpdateParams.Builder spendLimitDuration(JsonField<SpendLimitDuration> spendLimitDuration)
Sets Builder.spendLimitDuration to an arbitrary JSON value.
You should usually call Builder.spendLimitDuration with a well-typed SpendLimitDuration value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
state
final CardUpdateParams.Builder state(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.
-
state
final CardUpdateParams.Builder state(JsonField<CardUpdateParams.State> state)
Sets Builder.state to an arbitrary JSON value.
You should usually call Builder.state with a well-typed State value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
substatus
final CardUpdateParams.Builder substatus(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.
-
substatus
final CardUpdateParams.Builder substatus(JsonField<CardUpdateParams.Substatus> substatus)
Sets Builder.substatus to an arbitrary JSON value.
You should usually call Builder.substatus with a well-typed Substatus value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
additionalBodyProperties
final CardUpdateParams.Builder additionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)
-
putAdditionalBodyProperty
final CardUpdateParams.Builder putAdditionalBodyProperty(String key, JsonValue value)
-
putAllAdditionalBodyProperties
final CardUpdateParams.Builder putAllAdditionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)
-
removeAdditionalBodyProperty
final CardUpdateParams.Builder removeAdditionalBodyProperty(String key)
-
removeAllAdditionalBodyProperties
final CardUpdateParams.Builder removeAllAdditionalBodyProperties(Set<String> keys)
-
additionalHeaders
final CardUpdateParams.Builder additionalHeaders(Headers additionalHeaders)
-
additionalHeaders
final CardUpdateParams.Builder additionalHeaders(Map<String, Iterable<String>> additionalHeaders)
-
putAdditionalHeader
final CardUpdateParams.Builder putAdditionalHeader(String name, String value)
-
putAdditionalHeaders
final CardUpdateParams.Builder putAdditionalHeaders(String name, Iterable<String> values)
-
putAllAdditionalHeaders
final CardUpdateParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)
-
putAllAdditionalHeaders
final CardUpdateParams.Builder putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)
-
replaceAdditionalHeaders
final CardUpdateParams.Builder replaceAdditionalHeaders(String name, String value)
-
replaceAdditionalHeaders
final CardUpdateParams.Builder replaceAdditionalHeaders(String name, Iterable<String> values)
-
replaceAllAdditionalHeaders
final CardUpdateParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)
-
replaceAllAdditionalHeaders
final CardUpdateParams.Builder replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)
-
removeAdditionalHeaders
final CardUpdateParams.Builder removeAdditionalHeaders(String name)
-
removeAllAdditionalHeaders
final CardUpdateParams.Builder removeAllAdditionalHeaders(Set<String> names)
-
additionalQueryParams
final CardUpdateParams.Builder additionalQueryParams(QueryParams additionalQueryParams)
-
additionalQueryParams
final CardUpdateParams.Builder additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)
-
putAdditionalQueryParam
final CardUpdateParams.Builder putAdditionalQueryParam(String key, String value)
-
putAdditionalQueryParams
final CardUpdateParams.Builder putAdditionalQueryParams(String key, Iterable<String> values)
-
putAllAdditionalQueryParams
final CardUpdateParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)
-
putAllAdditionalQueryParams
final CardUpdateParams.Builder putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)
-
replaceAdditionalQueryParams
final CardUpdateParams.Builder replaceAdditionalQueryParams(String key, String value)
-
replaceAdditionalQueryParams
final CardUpdateParams.Builder replaceAdditionalQueryParams(String key, Iterable<String> values)
-
replaceAllAdditionalQueryParams
final CardUpdateParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)
-
replaceAllAdditionalQueryParams
final CardUpdateParams.Builder replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)
-
removeAdditionalQueryParams
final CardUpdateParams.Builder removeAdditionalQueryParams(String key)
-
removeAllAdditionalQueryParams
final CardUpdateParams.Builder removeAllAdditionalQueryParams(Set<String> keys)
-
build
final CardUpdateParams build()
Returns an immutable instance of CardUpdateParams.
Further updates to this Builder will not mutate the returned instance.
-
-
-