Create
Create card
Create a new virtual or physical card. Parameters shipping_address
and product_id
only apply to physical cards.
Body Parameters
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.
Globally unique identifier for the account that the card will be associated with. Required for programs enrolling users using the /account_holders endpoint. See Managing Your Program for more information.
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.
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.
Two digit (MM) expiry month. If neither exp_month
nor exp_year
is provided, an expiration date will be generated.
Four digit (yyyy) expiry year. If neither exp_month
nor exp_year
is provided, an expiration date will be generated.
Friendly name to identify the card.
Encrypted PIN block (in base64). Applies to cards of type PHYSICAL
and VIRTUAL
. See Encrypted PIN Block.
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.
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.
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.
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 trackingSTANDARD_WITH_TRACKING
- USPS regular mail or similar international option, with trackingPRIORITY
- USPS Priority, 1-3 day shipping, with trackingEXPRESS
- FedEx or UPS depending on card manufacturer, Express, 3-day shipping, with tracking2_DAY
- FedEx or UPS depending on card manufacturer, 2-day shipping, with trackingEXPEDITED
- FedEx or UPS depending on card manufacturer, Standard Overnight or similar international option, with tracking
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.
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.
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.
Returns
curl https://api.lithic.com/v1/cards \
-H 'Content-Type: application/json' \
-H "Authorization: $LITHIC_API_KEY" \
-d '{
"type": "VIRTUAL",
"exp_month": "06",
"exp_year": "2027",
"memo": "New Card",
"product_id": "1"
}'
{
"token": "7ef7d65c-9023-4da3-b113-3b8583fd7951",
"account_token": "f3f4918c-dee9-464d-a819-4aa42901d624",
"card_program_token": "5e9483eb-8103-4e16-9794-2106111b2eca",
"created": "2021-06-28T22:53:15Z",
"funding": {
"token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"created": "2019-12-27T18:11:19.117Z",
"last_four": "xxxx",
"state": "DELETED",
"type": "DEPOSITORY_CHECKING",
"account_name": "account_name",
"nickname": "x"
},
"last_four": "xxxx",
"pin_status": "OK",
"spend_limit": 1000,
"spend_limit_duration": "ANNUALLY",
"state": "CLOSED",
"type": "MERCHANT_LOCKED",
"auth_rule_tokens": [
"string"
],
"cardholder_currency": "USD",
"digital_card_art_token": "00000000-0000-0000-1000-000000000000",
"exp_month": "06",
"exp_year": "2027",
"hostname": "hostname",
"memo": "New Card",
"pending_commands": [
"string"
],
"product_id": "1",
"replacement_for": "5e9483eb-8103-4e16-9794-2106111b2eca",
"cvv": "776",
"pan": "4111111289144142"
}