Get card embed iframe

get

https://sandbox.lithic.com/v1/embed

Returns a Lithic-hosted HTML document for a single card detail or PIN setting control. Use
the URL, including its query parameters, as the src of an iframe. The session must be created
on your server with POST /v1/cards/{card_token}/embed.

Query Params

session

string

required

The short-lived credential returned by the session creation endpoint. Treat it as
sensitive and use it only in the iframe src.

type

string

enum

required

The type of embed to return.
CARD_EMBED sessions support PAN, CVV, EXP_MONTH, and EXP_YEAR.
PIN_SETTING_EMBED sessions support only PIN_SETTING.

Allowed:

styles

string

length ≤ 4096

Optional base64-encoded JSON object containing CSS property and value pairs to apply to
the iframe. URL-encode the base64 value when adding it to the query string. Styles that
load external resources are not permitted. The encoded value cannot exceed 4096 characters.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses


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

Loading…

Response

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

text/html

application/json

200Lithic-hosted card embed HTML.

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

401The embed session is missing, invalid, expired, or not authorized for the requested type.

404The specified resource was not found.