Class CardCreateParams.Builder
-
- All Implemented Interfaces:
public final class CardCreateParams.BuilderA builder for CardCreateParams.
-
-
Method Summary
Modifier and Type Method Description final CardCreateParams.Buildertype(CardCreateParams.Type 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. Reach out at lithic.com/contact for more information.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.
final CardCreateParams.Buildertype(JsonField<CardCreateParams.Type> 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. Reach out at lithic.com/contact for more information.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.
final CardCreateParams.BuilderaccountToken(String accountToken)Globally unique identifier for the account that the card will be associated with. final CardCreateParams.BuilderaccountToken(JsonField<String> accountToken)Globally unique identifier for the account that the card will be associated with. final CardCreateParams.BuildercardProgramToken(String cardProgramToken)For card programs with more than one BIN range. final CardCreateParams.BuildercardProgramToken(JsonField<String> cardProgramToken)For card programs with more than one BIN range. final CardCreateParams.Buildercarrier(Carrier carrier)final CardCreateParams.Buildercarrier(JsonField<Carrier> carrier)final CardCreateParams.BuilderdigitalCardArtToken(String digitalCardArtToken)Specifies the digital card art to be displayed in the user’s digital wallet after tokenization. final CardCreateParams.BuilderdigitalCardArtToken(JsonField<String> digitalCardArtToken)Specifies the digital card art to be displayed in the user’s digital wallet after tokenization. final CardCreateParams.BuilderexpMonth(String expMonth)Two digit (MM) expiry month. final CardCreateParams.BuilderexpMonth(JsonField<String> expMonth)Two digit (MM) expiry month. final CardCreateParams.BuilderexpYear(String expYear)Four digit (yyyy) expiry year. final CardCreateParams.BuilderexpYear(JsonField<String> expYear)Four digit (yyyy) expiry year. final CardCreateParams.Buildermemo(String memo)Friendly name to identify the card. final CardCreateParams.Buildermemo(JsonField<String> memo)Friendly name to identify the card. final CardCreateParams.Builderpin(String pin)Encrypted PIN block (in base64). final CardCreateParams.Builderpin(JsonField<String> pin)Encrypted PIN block (in base64). final CardCreateParams.BuilderproductId(String productId)Only applicable to cards of type PHYSICAL.final CardCreateParams.BuilderproductId(JsonField<String> productId)Only applicable to cards of type PHYSICAL.final CardCreateParams.BuilderreplacementAccountToken(String replacementAccountToken)Restricted field limited to select use cases. final CardCreateParams.BuilderreplacementAccountToken(JsonField<String> replacementAccountToken)Restricted field limited to select use cases. final CardCreateParams.BuilderreplacementFor(String replacementFor)Globally unique identifier for the card that this card will replace. final CardCreateParams.BuilderreplacementFor(JsonField<String> replacementFor)Globally unique identifier for the card that this card will replace. final CardCreateParams.BuildershippingAddress(ShippingAddress shippingAddress)final CardCreateParams.BuildershippingAddress(JsonField<ShippingAddress> shippingAddress)final CardCreateParams.BuildershippingMethod(CardCreateParams.ShippingMethod shippingMethod)Shipping method for the card. final CardCreateParams.BuildershippingMethod(JsonField<CardCreateParams.ShippingMethod> shippingMethod)Shipping method for the card. final CardCreateParams.BuilderspendLimit(Long spendLimit)Amount (in cents) to limit approved authorizations (e.g. final CardCreateParams.BuilderspendLimit(JsonField<Long> spendLimit)Amount (in cents) to limit approved authorizations (e.g. final CardCreateParams.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 CardCreateParams.BuilderspendLimitDuration(JsonField<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 CardCreateParams.Builderstate(CardCreateParams.State state)Card state values: 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 CardCreateParams.Builderstate(JsonField<CardCreateParams.State> state)Card state values: 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 CardCreateParams.BuilderadditionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)final CardCreateParams.BuilderputAdditionalBodyProperty(String key, JsonValue value)final CardCreateParams.BuilderputAllAdditionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)final CardCreateParams.BuilderremoveAdditionalBodyProperty(String key)final CardCreateParams.BuilderremoveAllAdditionalBodyProperties(Set<String> keys)final CardCreateParams.BuilderadditionalHeaders(Headers additionalHeaders)final CardCreateParams.BuilderadditionalHeaders(Map<String, Iterable<String>> additionalHeaders)final CardCreateParams.BuilderputAdditionalHeader(String name, String value)final CardCreateParams.BuilderputAdditionalHeaders(String name, Iterable<String> values)final CardCreateParams.BuilderputAllAdditionalHeaders(Headers additionalHeaders)final CardCreateParams.BuilderputAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)final CardCreateParams.BuilderreplaceAdditionalHeaders(String name, String value)final CardCreateParams.BuilderreplaceAdditionalHeaders(String name, Iterable<String> values)final CardCreateParams.BuilderreplaceAllAdditionalHeaders(Headers additionalHeaders)final CardCreateParams.BuilderreplaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)final CardCreateParams.BuilderremoveAdditionalHeaders(String name)final CardCreateParams.BuilderremoveAllAdditionalHeaders(Set<String> names)final CardCreateParams.BuilderadditionalQueryParams(QueryParams additionalQueryParams)final CardCreateParams.BuilderadditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)final CardCreateParams.BuilderputAdditionalQueryParam(String key, String value)final CardCreateParams.BuilderputAdditionalQueryParams(String key, Iterable<String> values)final CardCreateParams.BuilderputAllAdditionalQueryParams(QueryParams additionalQueryParams)final CardCreateParams.BuilderputAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)final CardCreateParams.BuilderreplaceAdditionalQueryParams(String key, String value)final CardCreateParams.BuilderreplaceAdditionalQueryParams(String key, Iterable<String> values)final CardCreateParams.BuilderreplaceAllAdditionalQueryParams(QueryParams additionalQueryParams)final CardCreateParams.BuilderreplaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)final CardCreateParams.BuilderremoveAdditionalQueryParams(String key)final CardCreateParams.BuilderremoveAllAdditionalQueryParams(Set<String> keys)final CardCreateParamsbuild()-
-
Method Detail
-
type
final CardCreateParams.Builder type(CardCreateParams.Type 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. Reach out at lithic.com/contact for more information.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.
-
type
final CardCreateParams.Builder type(JsonField<CardCreateParams.Type> 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. Reach out at lithic.com/contact for more information.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.
-
accountToken
final CardCreateParams.Builder accountToken(String accountToken)
Globally unique identifier for the account that the card will be associated with. Required for programs enrolling users using the /account_holders endpoint. See doc:managing-your-program for more information.
-
accountToken
final CardCreateParams.Builder accountToken(JsonField<String> accountToken)
Globally unique identifier for the account that the card will be associated with. Required for programs enrolling users using the /account_holders endpoint. See doc:managing-your-program for more information.
-
cardProgramToken
final CardCreateParams.Builder cardProgramToken(String cardProgramToken)
For card programs with more than one BIN range. This must be configured with Lithic before use. Identifies the card program/BIN range under which to create the card. If omitted, will utilize the program's default
card_program_token. In Sandbox, use 00000000-0000-0000-1000-000000000000 and 00000000-0000-0000-2000-000000000000 to test creating cards on specific card programs.
-
cardProgramToken
final CardCreateParams.Builder cardProgramToken(JsonField<String> cardProgramToken)
For card programs with more than one BIN range. This must be configured with Lithic before use. Identifies the card program/BIN range under which to create the card. If omitted, will utilize the program's default
card_program_token. In Sandbox, use 00000000-0000-0000-1000-000000000000 and 00000000-0000-0000-2000-000000000000 to test creating cards on specific card programs.
-
carrier
final CardCreateParams.Builder carrier(Carrier carrier)
-
carrier
final CardCreateParams.Builder carrier(JsonField<Carrier> carrier)
-
digitalCardArtToken
final CardCreateParams.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 CardCreateParams.Builder digitalCardArtToken(JsonField<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.
-
expMonth
final CardCreateParams.Builder expMonth(String expMonth)
Two digit (MM) expiry month. If neither
exp_monthnorexp_yearis provided, an expiration date will be generated.
-
expMonth
final CardCreateParams.Builder expMonth(JsonField<String> expMonth)
Two digit (MM) expiry month. If neither
exp_monthnorexp_yearis provided, an expiration date will be generated.
-
expYear
final CardCreateParams.Builder expYear(String expYear)
Four digit (yyyy) expiry year. If neither
exp_monthnorexp_yearis provided, an expiration date will be generated.
-
expYear
final CardCreateParams.Builder expYear(JsonField<String> expYear)
Four digit (yyyy) expiry year. If neither
exp_monthnorexp_yearis provided, an expiration date will be generated.
-
memo
final CardCreateParams.Builder memo(String memo)
Friendly name to identify the card.
-
memo
final CardCreateParams.Builder memo(JsonField<String> memo)
Friendly name to identify the card.
-
pin
final CardCreateParams.Builder pin(String pin)
Encrypted PIN block (in base64). Applies to cards of type
PHYSICALandVIRTUAL. See Encrypted PIN Block.
-
pin
final CardCreateParams.Builder pin(JsonField<String> pin)
Encrypted PIN block (in base64). Applies to cards of type
PHYSICALandVIRTUAL. See Encrypted PIN Block.
-
productId
final CardCreateParams.Builder productId(String productId)
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.
-
productId
final CardCreateParams.Builder productId(JsonField<String> productId)
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.
-
replacementAccountToken
final CardCreateParams.Builder replacementAccountToken(String replacementAccountToken)
Restricted field limited to select use cases. Lithic will reach out directly if this field should be used. Globally unique identifier for the replacement card's account. If this field is specified,
replacement_formust also be specified. Ifreplacement_foris specified and this field is omitted, the replacement card's account will be inferred from the card being replaced.
-
replacementAccountToken
final CardCreateParams.Builder replacementAccountToken(JsonField<String> replacementAccountToken)
Restricted field limited to select use cases. Lithic will reach out directly if this field should be used. Globally unique identifier for the replacement card's account. If this field is specified,
replacement_formust also be specified. Ifreplacement_foris specified and this field is omitted, the replacement card's account will be inferred from the card being replaced.
-
replacementFor
final CardCreateParams.Builder replacementFor(String replacementFor)
Globally unique identifier for the card that this card will replace. If the card type is
PHYSICALit will be replaced by aPHYSICALcard. If the card type isVIRTUALit will be replaced by aVIRTUALcard.
-
replacementFor
final CardCreateParams.Builder replacementFor(JsonField<String> replacementFor)
Globally unique identifier for the card that this card will replace. If the card type is
PHYSICALit will be replaced by aPHYSICALcard. If the card type isVIRTUALit will be replaced by aVIRTUALcard.
-
shippingAddress
final CardCreateParams.Builder shippingAddress(ShippingAddress shippingAddress)
-
shippingAddress
final CardCreateParams.Builder shippingAddress(JsonField<ShippingAddress> shippingAddress)
-
shippingMethod
final CardCreateParams.Builder shippingMethod(CardCreateParams.ShippingMethod shippingMethod)
Shipping method for the card. Only applies to cards of type PHYSICAL. Use of options besides
STANDARDrequire additional permissions.STANDARD- USPS regular mail or similar international option, with no trackingSTANDARD_WITH_TRACKING- USPS regular mail or similar international option, with trackingPRIORITY- USPS Priority, 1-3 day shipping, with trackingEXPRESS- FedEx Express, 3-day shipping, with tracking2_DAY- FedEx 2-day shipping, with trackingEXPEDITED- FedEx Standard Overnight or similar international option, with tracking
-
shippingMethod
final CardCreateParams.Builder shippingMethod(JsonField<CardCreateParams.ShippingMethod> shippingMethod)
Shipping method for the card. Only applies to cards of type PHYSICAL. Use of options besides
STANDARDrequire additional permissions.STANDARD- USPS regular mail or similar international option, with no trackingSTANDARD_WITH_TRACKING- USPS regular mail or similar international option, with trackingPRIORITY- USPS Priority, 1-3 day shipping, with trackingEXPRESS- FedEx Express, 3-day shipping, with tracking2_DAY- FedEx 2-day shipping, with trackingEXPEDITED- FedEx Standard Overnight or similar international option, with tracking
-
spendLimit
final CardCreateParams.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 CardCreateParams.Builder spendLimit(JsonField<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 CardCreateParams.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 CardCreateParams.Builder spendLimitDuration(JsonField<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 CardCreateParams.Builder state(CardCreateParams.State state)
Card state values:
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 CardCreateParams.Builder state(JsonField<CardCreateParams.State> state)
Card state values:
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.
-
additionalBodyProperties
final CardCreateParams.Builder additionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)
-
putAdditionalBodyProperty
final CardCreateParams.Builder putAdditionalBodyProperty(String key, JsonValue value)
-
putAllAdditionalBodyProperties
final CardCreateParams.Builder putAllAdditionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)
-
removeAdditionalBodyProperty
final CardCreateParams.Builder removeAdditionalBodyProperty(String key)
-
removeAllAdditionalBodyProperties
final CardCreateParams.Builder removeAllAdditionalBodyProperties(Set<String> keys)
-
additionalHeaders
final CardCreateParams.Builder additionalHeaders(Headers additionalHeaders)
-
additionalHeaders
final CardCreateParams.Builder additionalHeaders(Map<String, Iterable<String>> additionalHeaders)
-
putAdditionalHeader
final CardCreateParams.Builder putAdditionalHeader(String name, String value)
-
putAdditionalHeaders
final CardCreateParams.Builder putAdditionalHeaders(String name, Iterable<String> values)
-
putAllAdditionalHeaders
final CardCreateParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)
-
putAllAdditionalHeaders
final CardCreateParams.Builder putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)
-
replaceAdditionalHeaders
final CardCreateParams.Builder replaceAdditionalHeaders(String name, String value)
-
replaceAdditionalHeaders
final CardCreateParams.Builder replaceAdditionalHeaders(String name, Iterable<String> values)
-
replaceAllAdditionalHeaders
final CardCreateParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)
-
replaceAllAdditionalHeaders
final CardCreateParams.Builder replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)
-
removeAdditionalHeaders
final CardCreateParams.Builder removeAdditionalHeaders(String name)
-
removeAllAdditionalHeaders
final CardCreateParams.Builder removeAllAdditionalHeaders(Set<String> names)
-
additionalQueryParams
final CardCreateParams.Builder additionalQueryParams(QueryParams additionalQueryParams)
-
additionalQueryParams
final CardCreateParams.Builder additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)
-
putAdditionalQueryParam
final CardCreateParams.Builder putAdditionalQueryParam(String key, String value)
-
putAdditionalQueryParams
final CardCreateParams.Builder putAdditionalQueryParams(String key, Iterable<String> values)
-
putAllAdditionalQueryParams
final CardCreateParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)
-
putAllAdditionalQueryParams
final CardCreateParams.Builder putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)
-
replaceAdditionalQueryParams
final CardCreateParams.Builder replaceAdditionalQueryParams(String key, String value)
-
replaceAdditionalQueryParams
final CardCreateParams.Builder replaceAdditionalQueryParams(String key, Iterable<String> values)
-
replaceAllAdditionalQueryParams
final CardCreateParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)
-
replaceAllAdditionalQueryParams
final CardCreateParams.Builder replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)
-
removeAdditionalQueryParams
final CardCreateParams.Builder removeAdditionalQueryParams(String key)
-
removeAllAdditionalQueryParams
final CardCreateParams.Builder removeAllAdditionalQueryParams(Set<String> keys)
-
build
final CardCreateParams build()
-
-
-