GET/api/v2/cards/{cardId}/widget

Get secure widget URL for displaying card details in an iframe

Authentication

Send your API key in the x-api-key header on every request.

Request parameters
Field	Type	Required	Description
userId (query)	unknown	No	User ID (mandatory)
verificationToken (query)	string	No
cardId (path)	unknown	Yes	Card ID (mandatory)

200 — OK

Response 200 fields
Field	Type	Required	Description
Success	boolean	No	Indicates if the client access token generation was successful
WidgetUrl	string	No	The iframe URL for the the card platform widget (deprecated - not used in Widget.js integration)
WidgetToken	string	No	Client access token for Widget.js integration
ExpiresIn	unknown	No	Token expiration time in seconds (5 minutes for client access tokens)
ErrorCode	string	No	Error code if the operation failed
ErrorMessage	string	No	Human-readable error message if the operation failed
CardId	unknown	No	Card ID for reference
Config	object	No

400 — Bad Request

Response 400 fields
Field	Type	Required
Message	string	No
Code	string	No
Status	unknown	No
ValidationErrors	object	No
Details	string	No

401 — Unauthorized

Response 401 fields
Field	Type	Required
Message	string	No
Code	string	No
Status	unknown	No
ValidationErrors	object	No
Details	string	No

404 — Not Found

Response 404 fields
Field	Type	Required
Message	string	No
Code	string	No
Status	unknown	No
ValidationErrors	object	No
Details	string	No

500 — Internal Server Error

Response 500 fields
Field	Type	Required
Message	string	No
Code	string	No
Status	unknown	No
ValidationErrors	object	No
Details	string	No

curl -X GET "https://{base_url}/api/v2/cards/{cardId}/widget" \
  -H "x-api-key: YOUR_API_KEY"

This page is generated from the live OpenAPI specification and always matches the current API.