Constructor Detail

Method Detail

• body

   final CardCreateParams.Builder body(CardCreateParams.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:

  • type

  • accountToken

  • cardProgramToken

  • carrier

  • digitalCardArtToken

  • etc.

• 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)

  Sets Builder.type to an arbitrary JSON value.

  You should usually call Builder.type with a well-typed Type value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• 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)

  Sets Builder.accountToken to an arbitrary JSON value.

  You should usually call Builder.accountToken with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• 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)

  Sets Builder.cardProgramToken to an arbitrary JSON value.

  You should usually call Builder.cardProgramToken with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• carrier

   final CardCreateParams.Builder carrier(Carrier carrier)

• carrier

   final CardCreateParams.Builder carrier(JsonField<Carrier> carrier)

  Sets Builder.carrier to an arbitrary JSON value.

  You should usually call Builder.carrier with a well-typed Carrier value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• 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)

  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.

• expMonth

   final CardCreateParams.Builder expMonth(String expMonth)

  Two digit (MM) expiry month. If neither exp_month nor exp_year is provided, an expiration date will be generated.

• expMonth

   final CardCreateParams.Builder expMonth(JsonField<String> expMonth)

  Sets Builder.expMonth to an arbitrary JSON value.

  You should usually call Builder.expMonth with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• expYear

   final CardCreateParams.Builder expYear(String expYear)

  Four digit (yyyy) expiry year. If neither exp_month nor exp_year is provided, an expiration date will be generated.

• expYear

   final CardCreateParams.Builder expYear(JsonField<String> expYear)

  Sets Builder.expYear to an arbitrary JSON value.

  You should usually call Builder.expYear 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 CardCreateParams.Builder memo(String memo)

  Friendly name to identify the card.

• memo

   final CardCreateParams.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.

• pin

   final CardCreateParams.Builder pin(String pin)

  Encrypted PIN block (in base64). Applies to cards of type PHYSICAL and VIRTUAL. See Encrypted PIN Block.

• pin

   final CardCreateParams.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.

• 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)

  Sets Builder.productId to an arbitrary JSON value.

  You should usually call Builder.productId with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• 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_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.

• replacementAccountToken

   final CardCreateParams.Builder replacementAccountToken(JsonField<String> replacementAccountToken)

  Sets Builder.replacementAccountToken to an arbitrary JSON value.

  You should usually call Builder.replacementAccountToken with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• replacementComment

   final CardCreateParams.Builder replacementComment(String replacementComment)

  Additional context or information related to the card that this card will replace.

• replacementComment

   final CardCreateParams.Builder replacementComment(JsonField<String> replacementComment)

  Sets Builder.replacementComment to an arbitrary JSON value.

  You should usually call Builder.replacementComment with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• replacementFor

   final CardCreateParams.Builder replacementFor(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.

• replacementFor

   final CardCreateParams.Builder replacementFor(JsonField<String> replacementFor)

  Sets Builder.replacementFor to an arbitrary JSON value.

  You should usually call Builder.replacementFor with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• replacementSubstatus

   final CardCreateParams.Builder replacementSubstatus(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.

• replacementSubstatus

   final CardCreateParams.Builder replacementSubstatus(JsonField<CardCreateParams.ReplacementSubstatus> replacementSubstatus)

  Sets Builder.replacementSubstatus to an arbitrary JSON value.

  You should usually call Builder.replacementSubstatus with a well-typed ReplacementSubstatus value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• shippingAddress

   final CardCreateParams.Builder shippingAddress(ShippingAddress shippingAddress)

• shippingAddress

   final CardCreateParams.Builder shippingAddress(JsonField<ShippingAddress> shippingAddress)

  Sets Builder.shippingAddress to an arbitrary JSON value.

  You should usually call Builder.shippingAddress with a well-typed ShippingAddress value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• shippingMethod

   final CardCreateParams.Builder shippingMethod(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

• shippingMethod

   final CardCreateParams.Builder shippingMethod(JsonField<CardCreateParams.ShippingMethod> shippingMethod)

  Sets Builder.shippingMethod to an arbitrary JSON value.

  You should usually call Builder.shippingMethod with a well-typed ShippingMethod value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• 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)

  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 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)

  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 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)

  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.

• 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()

  Returns an immutable instance of CardCreateParams.

  Further updates to this Builder will not mutate the returned instance.

  The following fields are required:

  .type()