CardEmbedParams

Handling full card PANs and CVV codes requires that you comply with the Payment Card Industry Data Security Standards (PCI DSS). Some clients choose to reduce their compliance obligations by leveraging our embedded card UI solution documented below.

In this setup, PANs and CVV codes are presented to the end-user via a card UI that we provide, optionally styled in the customer's branding using a specified css stylesheet. A user's browser makes the request directly to api.lithic.com, so card PANs and CVVs never touch the API customer's servers while full card data is displayed to their end-users. The response contains an HTML document (see Embedded Card UI or Changelog for upcoming changes in January). This means that the url for the request can be inserted straight into the src attribute of an iframe.

<iframe id="card-iframe"
src="https://sandbox.lithic.com/v1/embed/card?embed_request=eyJjc3MiO...;hmac=r8tx1..."
allow="clipboard-write" class="content"></iframe>

You should compute the request payload on the server side. You can render it (or the whole iframe) on the server or make an ajax call from your front end code, but do not ever embed your API key into front end code, as doing so introduces a serious security vulnerability.

Types

Link copied to clipboard
class Builder

A builder for CardEmbedParams.

Link copied to clipboard
object Companion

Functions

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
open override fun _headers(): Headers

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

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

A base64 encoded JSON string of an EmbedRequest to specify which card to load.

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
fun hmac(): String

SHA256 HMAC of the embed_request JSON string with base64 digest.

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