increase-test
POST/cards/{card_id}/create_details_iframe

Create a card details iframe

Creates an iframe URL for displaying a card's sensitive details. Use card_id to identify the card, and optionally provide physical_card_id to control the card's appearance in the iframe. Treat the returned iframe URL as opaque and use the embedded card component documentation for styling and usage.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 1 body field
card_idstringrequired
The identifier of the card to create an iframe for.

Optional card display configuration for the iframe.

physical_card_idstringoptional
The identifier of the Physical Card to create an iframe for. This will inform the appearance of the card rendered in the iframe.

3 status codes
200Returns an iframe URL object containing the opaque `iframe_url`, its `expires_at` timestamp, and the `card_iframe_url` type.
expires_atstringrequired
The time the iframe URL will expire.
iframe_urlstringrequired
The iframe URL for the Card. Treat this as an opaque URL.
typestringrequired
A constant representing the object's type. For this resource it will always be `card_iframe_url`.
Allowed:card_iframe_url
4XXReturned when the request fails with a client error.
5XXReturned when the request fails with a server error.

Error handling

The card_id path parameter must identify the card to display. If provided, physical_card_id must identify the physical card whose appearance should be rendered in the iframe.