Class CardCreateParams.Body
-
- All Implemented Interfaces:
public final class CardCreateParams.Body
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classCardCreateParams.Body.BuilderA builder for Body.
-
Method Summary
Modifier and Type Method Description final CardCreateParams.Typetype()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 Optional<String>accountToken()Globally unique identifier for the account that the card will be associated with. final Optional<String>cardProgramToken()For card programs with more than one BIN range. final Optional<Carrier>carrier()final Optional<String>digitalCardArtToken()Specifies the digital card art to be displayed in the user’s digital wallet after tokenization. final Optional<String>expMonth()Two digit (MM) expiry month. final Optional<String>expYear()Four digit (yyyy) expiry year. final Optional<String>memo()Friendly name to identify the card. final Optional<String>pin()Encrypted PIN block (in base64). final Optional<String>productId()Only applicable to cards of type PHYSICAL.final Optional<String>replacementAccountToken()Restricted field limited to select use cases. final Optional<String>replacementFor()Globally unique identifier for the card that this card will replace. final Optional<ShippingAddress>shippingAddress()final Optional<CardCreateParams.ShippingMethod>shippingMethod()Shipping method for the card. 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<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 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 JsonField<String>_accountToken()Globally unique identifier for the account that the card will be associated with. final JsonField<String>_cardProgramToken()For card programs with more than one BIN range. final JsonField<Carrier>_carrier()final JsonField<String>_digitalCardArtToken()Specifies the digital card art to be displayed in the user’s digital wallet after tokenization. final JsonField<String>_expMonth()Two digit (MM) expiry month. final JsonField<String>_expYear()Four digit (yyyy) expiry year. final JsonField<String>_memo()Friendly name to identify the card. final JsonField<String>_pin()Encrypted PIN block (in base64). final JsonField<String>_productId()Only applicable to cards of type PHYSICAL.final JsonField<String>_replacementAccountToken()Restricted field limited to select use cases. final JsonField<String>_replacementFor()Globally unique identifier for the card that this card will replace. final JsonField<ShippingAddress>_shippingAddress()final JsonField<CardCreateParams.ShippingMethod>_shippingMethod()Shipping method for the card. final JsonField<Long>_spendLimit()Amount (in cents) to limit approved authorizations (e.g. final 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 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 Map<String, JsonValue>_additionalProperties()final CardCreateParams.Bodyvalidate()final CardCreateParams.Body.BuildertoBuilder()Booleanequals(Object other)IntegerhashCode()StringtoString()final static CardCreateParams.Body.Builderbuilder()Returns a mutable builder for constructing an instance of Body. -
-
Method Detail
-
type
final 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 Optional<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 Optional<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.
-
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.
-
expMonth
final Optional<String> expMonth()
Two digit (MM) expiry month. If neither
exp_monthnorexp_yearis provided, an expiration date will be generated.
-
expYear
final Optional<String> expYear()
Four digit (yyyy) expiry year. If neither
exp_monthnorexp_yearis provided, an expiration date will be generated.
-
pin
final Optional<String> pin()
Encrypted PIN block (in base64). Applies to cards of type
PHYSICALandVIRTUAL. See Encrypted PIN Block.
-
productId
final Optional<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 Optional<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 Optional<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 Optional<ShippingAddress> shippingAddress()
-
shippingMethod
final Optional<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 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<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.
-
_type
final 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 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 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.
-
_digitalCardArtToken
final 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 JsonField<String> _expMonth()
Two digit (MM) expiry month. If neither
exp_monthnorexp_yearis provided, an expiration date will be generated.
-
_expYear
final JsonField<String> _expYear()
Four digit (yyyy) expiry year. If neither
exp_monthnorexp_yearis provided, an expiration date will be generated.
-
_pin
final JsonField<String> _pin()
Encrypted PIN block (in base64). Applies to cards of type
PHYSICALandVIRTUAL. See Encrypted PIN Block.
-
_productId
final 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 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 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 JsonField<ShippingAddress> _shippingAddress()
-
_shippingMethod
final 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 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 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 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.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
validate
final CardCreateParams.Body validate()
-
toBuilder
final CardCreateParams.Body.Builder toBuilder()
-
builder
final static CardCreateParams.Body.Builder builder()
Returns a mutable builder for constructing an instance of Body.
The following fields are required:
.type()
-
-
-