All Implemented Interfaces:


public final class CardCreateParams.Body

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`CardCreateParams.Body.Builder`	A builder for Body.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`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.
`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>`	`replacementComment()`	Additional context or information related to the card that this card will replace.
`final Optional<String>`	`replacementFor()`	Globally unique identifier for the card that this card will replace.
`final Optional<CardCreateParams.ReplacementSubstatus>`	`replacementSubstatus()`	Card state substatus values for the card that this card will replace: `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 like `PAUSED` or `CLOSED`. `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 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()`	Returns the raw JSON value of type.
`final JsonField<String>`	`_accountToken()`	Returns the raw JSON value of accountToken.
`final JsonField<String>`	`_cardProgramToken()`	Returns the raw JSON value of cardProgramToken.
`final JsonField<Carrier>`	`_carrier()`	Returns the raw JSON value of carrier.
`final JsonField<String>`	`_digitalCardArtToken()`	Returns the raw JSON value of digitalCardArtToken.
`final JsonField<String>`	`_expMonth()`	Returns the raw JSON value of expMonth.
`final JsonField<String>`	`_expYear()`	Returns the raw JSON value of expYear.
`final JsonField<String>`	`_memo()`	Returns the raw JSON value of memo.
`final JsonField<String>`	`_pin()`	Returns the raw JSON value of pin.
`final JsonField<String>`	`_productId()`	Returns the raw JSON value of productId.
`final JsonField<String>`	`_replacementAccountToken()`	Returns the raw JSON value of replacementAccountToken.
`final JsonField<String>`	`_replacementComment()`	Returns the raw JSON value of replacementComment.
`final JsonField<String>`	`_replacementFor()`	Returns the raw JSON value of replacementFor.
`final JsonField<CardCreateParams.ReplacementSubstatus>`	`_replacementSubstatus()`	Returns the raw JSON value of replacementSubstatus.
`final JsonField<ShippingAddress>`	`_shippingAddress()`	Returns the raw JSON value of shippingAddress.
`final JsonField<CardCreateParams.ShippingMethod>`	`_shippingMethod()`	Returns the raw JSON value of shippingMethod.
`final JsonField<Long>`	`_spendLimit()`	Returns the raw JSON value of spendLimit.
`final JsonField<SpendLimitDuration>`	`_spendLimitDuration()`	Returns the raw JSON value of spendLimitDuration.
`final JsonField<CardCreateParams.State>`	`_state()`	Returns the raw JSON value of state.
`final Map<String, JsonValue>`	`_additionalProperties()`
`final CardCreateParams.Body.Builder`	`toBuilder()`
`final CardCreateParams.Body`	`validate()`
`final Boolean`	`isValid()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static CardCreateParams.Body.Builder`	`builder()`	Returns a mutable builder for constructing an instance of Body.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- 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.
  - carrier
```
 final Optional<Carrier> carrier()
```
  - 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_month nor exp_year is provided, an expiration date will be generated.
  - expYear
```
 final Optional<String> expYear()
```
    Four digit (yyyy) expiry year. If neither exp_month nor exp_year is provided, an expiration date will be generated.
  - memo
```
 final Optional<String> memo()
```
    Friendly name to identify the card.
  - pin
```
 final Optional<String> pin()
```
    Encrypted PIN block (in base64). Applies to cards of type PHYSICAL and VIRTUAL. 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_for must also be specified. If replacement_for is specified and this field is omitted, the replacement card's account will be inferred from the card being replaced.
  - replacementComment
```
 final Optional<String> replacementComment()
```
    Additional context or information related to the card that this card will replace.
  - replacementFor
```
 final Optional<String> replacementFor()
```
    Globally unique identifier for the card that this card will replace. If the card type is PHYSICAL it will be replaced by a PHYSICAL card. If the card type is VIRTUAL it will be replaced by a VIRTUAL card.
  - replacementSubstatus
```
 final Optional<CardCreateParams.ReplacementSubstatus> replacementSubstatus()
```
    Card state substatus values for the card that this card will replace:
    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 like PAUSED or CLOSED.
    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.
  - 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 STANDARD require additional permissions.
    STANDARD - USPS regular mail or similar international option, with no tracking
    STANDARD_WITH_TRACKING - USPS regular mail or similar international option, with tracking
    PRIORITY - USPS Priority, 1-3 day shipping, with tracking
    EXPRESS - FedEx or UPS depending on card manufacturer, Express, 3-day shipping, with tracking
    2_DAY - FedEx or UPS depending on card manufacturer, 2-day shipping, with tracking
    EXPEDITED - FedEx or UPS depending on card manufacturer, 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()
```
    Returns the raw JSON value of type.
    Unlike type, this method doesn't throw if the JSON field has an unexpected type.
  - _accountToken
```
 final JsonField<String> _accountToken()
```
    Returns the raw JSON value of accountToken.
    Unlike accountToken, this method doesn't throw if the JSON field has an unexpected type.
  - _cardProgramToken
```
 final JsonField<String> _cardProgramToken()
```
    Returns the raw JSON value of cardProgramToken.
    Unlike cardProgramToken, this method doesn't throw if the JSON field has an unexpected type.
  - _carrier
```
 final JsonField<Carrier> _carrier()
```
    Returns the raw JSON value of carrier.
    Unlike carrier, 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.
  - _expMonth
```
 final JsonField<String> _expMonth()
```
    Returns the raw JSON value of expMonth.
    Unlike expMonth, this method doesn't throw if the JSON field has an unexpected type.
  - _expYear
```
 final JsonField<String> _expYear()
```
    Returns the raw JSON value of expYear.
    Unlike expYear, 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.
  - _productId
```
 final JsonField<String> _productId()
```
    Returns the raw JSON value of productId.
    Unlike productId, this method doesn't throw if the JSON field has an unexpected type.
  - _replacementAccountToken
```
 final JsonField<String> _replacementAccountToken()
```
    Returns the raw JSON value of replacementAccountToken.
    Unlike replacementAccountToken, this method doesn't throw if the JSON field has an unexpected type.
  - _replacementComment
```
 final JsonField<String> _replacementComment()
```
    Returns the raw JSON value of replacementComment.
    Unlike replacementComment, this method doesn't throw if the JSON field has an unexpected type.
  - _replacementFor
```
 final JsonField<String> _replacementFor()
```
    Returns the raw JSON value of replacementFor.
    Unlike replacementFor, this method doesn't throw if the JSON field has an unexpected type.
  - _replacementSubstatus
```
 final JsonField<CardCreateParams.ReplacementSubstatus> _replacementSubstatus()
```
    Returns the raw JSON value of replacementSubstatus.
    Unlike replacementSubstatus, this method doesn't throw if the JSON field has an unexpected type.
  - _shippingAddress
```
 final JsonField<ShippingAddress> _shippingAddress()
```
    Returns the raw JSON value of shippingAddress.
    Unlike shippingAddress, this method doesn't throw if the JSON field has an unexpected type.
  - _shippingMethod
```
 final JsonField<CardCreateParams.ShippingMethod> _shippingMethod()
```
    Returns the raw JSON value of shippingMethod.
    Unlike shippingMethod, 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<CardCreateParams.State> _state()
```
    Returns the raw JSON value of state.
    Unlike state, this method doesn't throw if the JSON field has an unexpected type.
  - _additionalProperties
```
 final Map<String, JsonValue> _additionalProperties()
```
  - toBuilder
```
 final CardCreateParams.Body.Builder toBuilder()
```
  - validate
```
 final CardCreateParams.Body validate()
```
  - isValid
```
 final Boolean isValid()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static CardCreateParams.Body.Builder builder()
```
    Returns a mutable builder for constructing an instance of Body.
    The following fields are required:
    .type()

Class CardCreateParams.Body

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

type

accountToken

cardProgramToken

carrier

digitalCardArtToken

expMonth

expYear

memo

pin

productId

replacementAccountToken

replacementComment

replacementFor

replacementSubstatus

shippingAddress

shippingMethod

spendLimit

spendLimitDuration

state

_type

_accountToken

_cardProgramToken

_carrier

_digitalCardArtToken

_expMonth

_expYear

_memo

_pin

_productId

_replacementAccountToken

_replacementComment

_replacementFor

_replacementSubstatus

_shippingAddress

_shippingMethod

_spendLimit

_spendLimitDuration

_state

_additionalProperties

toBuilder

validate

isValid

equals

hashCode

toString

builder