Provision card (Digital Wallet)

post

https://sandbox.lithic.com/v1/cards/{card_token}/provision

Beta: Google Pay provisioning on this API version uses the UPP (Unified Push Provisioning) flow. Google Pay UPP is not currently available in the sandbox environment. Apple Pay and Samsung Pay behavior is unchanged on this version.

Allow your cardholders to directly add payment cards to the device's digital wallet (e.g. Apple Pay) with one touch from your app.

This requires some additional setup and configuration. Please Contact Us or your Customer Success representative for more information.

Path Params

card_token

uuid

required

The unique token of the card to add to the device's digital wallet.

Body Params

Update request.

certificate

string

Only applicable if digital_wallet is APPLE_PAY. Omit to receive only activationData in the response. Apple's public leaf certificate. Base64 encoded in PEM format with headers (-----BEGIN CERTIFICATE-----) and trailers omitted. Provided by the device's wallet.

client_wallet_account_id

string

Only applicable if digital_wallet is GOOGLE_PAY or SAMSUNG_PAY. Consumer ID that identifies the wallet account holder entity. Required for both wallets regardless of network, though the value is only used for cards on the Visa network and is ignored on Amex and Mastercard.

client_device_id

string

Only applicable if digital_wallet is GOOGLE_PAY or SAMSUNG_PAY. Stable device identification set by the wallet provider. Required for SAMSUNG_PAY and optional for GOOGLE_PAY, regardless of network. The value is only used for cards on the Visa network and is ignored on Amex and Mastercard.

digital_wallet

string

enum

Name of digital wallet provider.

Allowed:

google_opc_requested

boolean

Defaults to false

Only applicable if digital_wallet is GOOGLE_PAY. Set to true to also receive google_provisioning_payload (the FPAN flow) alongside provisioning_payload (the tokenization flow). Requires server_session_id.

nonce

string

Only applicable if digital_wallet is APPLE_PAY. Omit to receive only activationData in the response. Base64 cryptographic nonce provided by the device's wallet.

nonce_signature

string

Only applicable if digital_wallet is APPLE_PAY. Omit to receive only activationData in the response. Base64 cryptographic nonce provided by the device's wallet.

server_session_id

uuid

Only applicable if digital_wallet is GOOGLE_PAY. Google Pay Push Provisioning session identifier required for the FPAN flow. Required when google_opc_requested is true; accepted and ignored otherwise.

Responses


User has not been authenticated	Invalid or missing API key
API key is not active	The API key used is no longer active
Could not find API key	The API key provided is not associated with any user
Please provide API key in Authorization header	The Authorization header is not in the request
Please provide API key in the form Authorization: [api-key]	The Authorization header is not formatted properly
Insufficient privileges. Issuing API key required	Write access requires an Issuing API key. Reach out at lithic.com/contact
Insufficient privileges to create virtual cards.	Creating virtual cards requires an additional privilege


Rate limited, too many requests per second	User has exceeded their per second rate limit
Rate limited, reached daily limit	User has exceeded their daily rate limit
Rate limited, too many keys tried	One IP has queried too many different API keys

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Returns provisioning_payload, a cryptographic payload representing a payment card that can be passed to a device's digital wallet. Each digital wallet has a different API; consult the wallet's documentation for more info.

400A parameter in the query given in the request does not match the valid queries for the endpoint.

404The specified resource was not found.

422Unprocessable entity.