- Read the Quick Start guide.
- Obtain a user token.
- Obtain a card token that is associated with the user token, if working with the Set PIN widget.
- Have a parent web application in which to integrate the widget. This application must use HTTPS.
Data security compliance
You must comply with PCI DSS data security requirements if you want to store, transmit, or process sensitive card data such as the card holder's primary account number (PAN), personal identification number (PIN), and card expiration date. The process of becoming PCI DSS certified to store, transmit and process such data directly is both time consuming and expensive. The Activate Card and Set PIN widgets handle the encrypted transmission of sensitive card data, and can help you comply with some aspects of the PCI compliance burden. Marqeta is fully PCI-Level 1 compliant, and securely handles the unencrypted, sensitive card data.
The Activate Card and Set PIN widgets are customizable iframes that enable the card holder to provide sensitive card data to the Marqeta platform. When you embed a widget in your application, your servers never store, transmit, or process the card data so you are not required to be PCI DSS compliant. Embed the iframe in the parent page of your web application where you want the functionality of the widget to occur. You configure the iframe by passing query parameters in the iframe's source URL. The Marqeta platform then processes the iframe.
Note: Embed the iframe using a web element when adding a widget to a mobile application. This applies to both Android and iOS.
You can integrate the following widgets:
- Activate Card – Allows authenticated card holders to activate their program-specific cards.
- Set PIN – Allows card holders to set their online EMV PIN code.
Upon successful completion, the Activate Card widget renders the Set PIN widget automatically.
The Activate Card and Set PIN widgets apply to many use cases. For example, an alternative lender who leverages an authorized user model might have these widgets display as part of providing loans to businesses. The widgets would enable the business owners to activate their card, then choose their own PIN.
Note: Your application must provide a login method to authenticate the user. Widgets do not provide user authentication; they only validate that the user-entered data matches the card data on the Marqeta platform.
Before integrating widgets into your application, you must submit your customized style attributes to Marqeta. Marqeta provides the Marqeta Widget Style Preview page as a testing ground for you to determine how you want your widgets to look.
The following styles are customizable:
|Style Category||Attributes and Values|
|Error message styles||Errors are displayed above the widget in a flash-message style list.
Any global styles you define are overridden by more specific style category declarations. For example, if you define a font stack in both the Global Styles category and the Button Styles category, the fonts of the Button Styles stack will apply to the buttons. Other styles are unaffected by this declaration.
The widget are accessible from base URLs for both sandbox and production environments.
Depending on your environment, use one of the following base URLs as the source of the iframe:
Using query parameters, you can specify the language to use when rendering the widget, as well as customize the message displayed upon successful completion of the widget's task.
Build your iframe content for the desired widget by adding the appropriate query parameters:
|application_id||string||Yes||The application ID for use with widgets, obtained from Marqeta in Step Two.|
|one_time_token||string||Yes||User's one-time authentication token, generated via
|user_token||string||Yes||Existing user token. Send a
|card_token||string||Yes, if Set PIN widget||Existing card token that is associated with the user token. Send a
Note: Only applies to the Set PIN widget.
|success_url||string||Yes||HTTPS URL of the page that is loaded in the iframe upon successful completion.
The success_url must use HTTPS as the protocol; most browsers do not allow HTTP content to be loaded into the iframe window. In addition, the protocol must be specified for the widget to recognize it as a valid success_url. This URL must not be enclosed in quotation marks, but it can be URL encoded.
When calling a widget in an iframe, make sure the page provided does not set the X-Frame-Options to DENY or SAMEORIGIN; otherwise the iframe cannot display in modern browsers. If using the widget directly in the browser window, the redirect does not require the X-Frame-Options header.
If the success_url is invalid or not provided, the widget displays a generic message informing the card holder that the request has been successfully processed.
|display_headers||boolean||No||If set to false, the widget's standard headers are not displayed above the iframe.
|locale||string||No||The language to use when rendering the widget. This parameter is a language tag composed of a language code and a country code. The following language tag values are supported:
Validation and error handling
The one-time user authentication token you create expires 120 minutes from when the Card Activation widget appears on-screen. The card holder must complete the card activation during this period. After the Card Activation widget closes, the timer resets to zero to allow the card holder another 120 minutes to set the PIN in the Set PIN widget.
After the card data has been supplied to the widget, the widget performs a number of validations before sending the data to Marqeta's servers. The card holder has five attempts to correctly input data in the Activate Card or the Set PIN widget. After five failed attempts, the widget displays an error message. To try another five times, the card holder has to refresh the parent web page to force the generation of a new widget.
A card holder might successfully activate a card using the Activate Card widget, but fail to set a PIN using the Set PIN widget. In this case, the next time the card holder accesses the widgets, the Set PIN widget appears without displaying the Activate Card widget again.
Note: There is no way for the widget to inform the parent web page in the event of an error. If the widget encounters an error, the card holder must refresh the parent web page. Consider providing instructions to the card holder on how to do this.
Activate Card validation
The following validations are performed on the data entered in the widget when the card holder clicks or taps Activate Card:
- PAN has been entered in the widget.
- PAN is a valid card number.
- CVV has been entered in the widget.
- CVV is 3 or 4 characters in length.
- CVV is a numeric value.
If successful, the failure count and the timer are reset to 0, and the Activate Card widget automatically renders the Set PIN widget.
Set PIN validation
The following validations are performed on the data entered in the widget when the card holder clicks or taps Set PIN:
- PIN does not contain consecutive ascending or descending values, such as 1-2-3-4 or 9-8-7-6.
- PIN is not a single digit repeated four times, such as 2-2-2-2.
- PIN is not one of the most common PINs chosen by card holders.
- PIN confirmation value matches the PIN value.
If successful, the page specified by the success_url parameter is loaded.
This tutorial walks you through how to customize the Activate Card widget and integrate it with a web application in your sandbox environment.
The Activate Card and Set PIN widgets are not supported in the Marqeta shared sandbox.
Step One: Define the widget style attributes
Go to the Marqeta Widget Style Preview page to configure and preview the widget's styles. Choose attributes that match your web application. Send the finalized styles to Marqeta for implementation when you are ready to integrate a widget into your production environment.
Step Two: Obtain a new application ID from Marqeta
Contact your Marqeta representative to obtain an application ID, which is a value used specifically for embedding the Activate Card and Set PIN widgets. You must use the same application ID for both widgets. This value is typically provided when you begin working with Marqeta.
Step Three: Generate a one-time user authentication token
Configure your web application to send a POST request to /users/auth/onetime to generate a one-time user authentication token for the logged-in user. The single-use access token you create for the logged-in user is valid for one request only, and expires five minutes after it is generated. See the "Return single-use token" section of the Users page for more information about this endpoint.
The following is an example of a cURL request that generates a one-time user authentication token:
curl -X POST \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Basic dXNlcjM5MDQxNTM2ODY0MTY4OjRhN2VkNDlhLWZjOTctNDdmNy04NmY0LTUxN2VjZTE1ZGY5ZQ==' \
Note: After the one-time token is redeemed to render the parent web page, it cannot be reused. If the widget times out or the parent web page is refreshed by the card holder, a new one-time token must be generated and passed to the iframe.
Step Four: Add query parameters to the iframe
Build the iframe content for the widget by adding the appropriate query parameters from the table in the "iframe parameters" section.
Step Five: Embed the iframe in the parent website
Embed the iframe in the parent website, using the following as the iframe's source: https://widgets-sandbox.marqeta.com/activate_card. Since the iframe is requesting an HTTPS domain, the parent website URL must also use the HTTPS protocol.
When completed, the HTML for the iframe should resemble the following:
Below are samples of iframes you can create by following the tutorial's steps. In each of these samples, a success URL is specified and the headers are disabled. The base URL reflects whether the iframe is used in a sandbox or a production environment.
Activate Card widget, sandbox environment
Activate Card widget, production environment
Set PIN widget, sandbox environment
Set PIN widget, production environment