Get card embed iframe

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
string
required

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

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:
string
length ≤ 4096

Optional base64-encoded JSON object containing base CSS declarations and nested
pseudo-class declarations 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.

Supported pseudo-classes are :first-child, :last-child, :enabled, :read-write,
:read-only, :placeholder-shown, :valid, :invalid, :disabled, :hover,
:focus-within, :focus, :focus-visible, and :active.

string
length ≤ 4096

Optional standard base64-encoded JSON configuration for the requested iframe. URL-encode
the base64 value when adding it to the query string. The encoded value cannot exceed 4096
characters; malformed or oversized values are rejected with a 400 response.

PIN_SETTING supports a pin_setting object with an optional placeholder string and an
optional layout. placeholder defaults to an empty string and applies only to the
single-input layout. layout accepts SINGLE_INPUT or MULTI_INPUT and defaults to
SINGLE_INPUT. The multi-input layout renders one single-digit input for each digit allowed
by the embed session's max_pin_length.

Decoded example: {"pin_setting":{"layout":"MULTI_INPUT"}}

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/html
application/json