CardCreateParams

Create a new virtual or physical card. Parameters shipping_address and product_id only apply to physical cards.

Types

Link copied to clipboard
class Body
Link copied to clipboard
class Builder

A builder for CardCreateParams.

Link copied to clipboard
object Companion
Link copied to clipboard

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

Link copied to clipboard
class ShippingMethod : Enum

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

Link copied to clipboard
class State : Enum

Card state values:

Link copied to clipboard
class Type : Enum

Card types:

Functions

Link copied to clipboard

Returns the raw JSON value of accountToken.

Link copied to clipboard

Additional headers to send with the request.

Link copied to clipboard

Additional query param to send with the request.

Link copied to clipboard
Link copied to clipboard

Returns the raw JSON value of cardProgramToken.

Link copied to clipboard

Returns the raw JSON value of carrier.

Link copied to clipboard

Returns the raw JSON value of digitalCardArtToken.

Link copied to clipboard

Returns the raw JSON value of expMonth.

Link copied to clipboard

Returns the raw JSON value of expYear.

Link copied to clipboard
open override fun _headers(): Headers

The full set of headers in the parameters, including both fixed and additional headers.

Link copied to clipboard

Returns the raw JSON value of memo.

Link copied to clipboard

Returns the raw JSON value of pin.

Link copied to clipboard

Returns the raw JSON value of productId.

Link copied to clipboard
open override fun _queryParams(): QueryParams

The full set of query params in the parameters, including both fixed and additional query params.

Link copied to clipboard
Link copied to clipboard

Returns the raw JSON value of replacementComment.

Link copied to clipboard

Returns the raw JSON value of replacementFor.

Link copied to clipboard

Returns the raw JSON value of shippingAddress.

Link copied to clipboard
Link copied to clipboard

Returns the raw JSON value of spendLimit.

Link copied to clipboard
Link copied to clipboard

Returns the raw JSON value of state.

Link copied to clipboard

Returns the raw JSON value of type.

Link copied to clipboard

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

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
Link copied to clipboard

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
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard

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

Link copied to clipboard
fun expYear(): String?

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

Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
fun memo(): String?

Friendly name to identify the card.

Link copied to clipboard
fun pin(): String?

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

Link copied to clipboard

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

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

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

Link copied to clipboard

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

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

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

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

Spend limit duration values:

Link copied to clipboard

Card state values:

Link copied to clipboard
Link copied to clipboard
open override fun toString(): String
Link copied to clipboard

Card types: