Builder

class Builder

A builder for CardCreateParams.

Functions

Link copied to clipboard

Sets Builder.accountToken to an arbitrary JSON value.

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.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Sets the entire request body.

Link copied to clipboard

Returns an immutable instance of CardCreateParams.

Link copied to clipboard

Sets Builder.cardProgramToken to an arbitrary JSON value.

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.

Link copied to clipboard

Sets Builder.carrier to an arbitrary JSON value.

Link copied to clipboard

Sets Builder.digitalCardArtToken to an arbitrary JSON value.

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.

Link copied to clipboard

Sets Builder.expMonth to an arbitrary JSON value.

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

Link copied to clipboard

Sets Builder.expYear to an arbitrary JSON value.

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

Link copied to clipboard

Sets Builder.memo to an arbitrary JSON value.

Friendly name to identify the card.

Link copied to clipboard

Sets Builder.pin to an arbitrary JSON value.

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

Link copied to clipboard

Sets Builder.productId to an arbitrary JSON value.

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.

Link copied to clipboard
Link copied to clipboard

Sets Builder.replacementAccountToken to an arbitrary JSON value.

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.

Link copied to clipboard

Sets Builder.replacementComment to an arbitrary JSON value.

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

Link copied to clipboard

Sets Builder.replacementFor to an arbitrary JSON value.

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.

Link copied to clipboard

Sets Builder.replacementSubstatus to an arbitrary JSON value.

Card state substatus values for the card that this card will replace:

Link copied to clipboard
Link copied to clipboard

Sets Builder.shippingMethod to an arbitrary JSON value.

Shipping method for the card. Only applies to cards of type PHYSICAL. Use of options besides STANDARD require additional permissions.

Link copied to clipboard

Sets Builder.spendLimit to an arbitrary JSON value.

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.

Link copied to clipboard

Sets Builder.spendLimitDuration to an arbitrary JSON value.

Spend limit duration values:

Link copied to clipboard

Sets Builder.state to an arbitrary JSON value.

Card state values:

Link copied to clipboard