Archive
Storefront;isBold;icon_storefront
Stencil
Stored Credit Card Management

Stored Credit Card Management

Stored Credit Card management gives customer’s the ability to manage their stored credit cards from the My Account page of the storefront. In the Cornerstone theme, shoppers with store accounts will have the ability to add new cards, delete cards, select a default card, and edit the billing details of existing cards from their customer account area of the storefront.

Stored Credit Card Management

Theme Versions

Cornerstone versions 2.6.0+ include the ability to manage Stored Credit Cards (opens in a new tab) (BigCommerce Support).

Prerequisites

Adding Stored Credit Card Management

Stored Credit Card Management was added to Cornerstone in pull request #1376 (opens in a new tab). To add Stored Credit Cards to pre-2.6.0 Cornerstone or Marketplace themes, copy the changes from PR #1376 (opens in a new tab) to your theme. This section will walk through each individual commit (opens in a new tab), highlighting the changes that you will need to make to your template files.

Step 1: Add Payment Methods Page (opens in a new tab)

  • Create the new Payment Methods page on a shopper’s account by editing the following files:
    • lang/en.json
    • templates/components/account/navigation.html
    • templates/pages/account/payment-methods.html

Payment Methods Page Addition Example

Step 2: Add Translations (opens in a new tab)

  • Makes the Payments Method page translatable by modifying the following:
    • lang/en.json
    • templates/components/account/navigation.html files

Step 3: Include Credit Card Listing (opens in a new tab)

  • Group the credit cards by payment providers
  • Include the payment method icons
  • Account for mobile and desktop layouts
  • Account for translations

Icons have been used to identify the credit card type. The data only provides the card brand in the credit card details.

image

Step 4: Add Credit Card Actions (opens in a new tab)

  • add Edit, Delete, and Add buttons

Implementation of Add, Edit, and Delete Methods

Step 5: Implement Delete Payment Method (opens in a new tab)

  • Bind the delete button's front end and back end

First, the click will trigger window confirm. The confirmation modal has been added to prevent unintended action. Then, on confirming, a post request will be sent. The action is initiated through a localized form post request in the template which uses a delete_url (opens in a new tab) key provided in the credit card details data. Finally, there will be a redirect to the credit card listing.

Step 6: Implement Edit Payment Method (opens in a new tab)

  • Add the design for credit card details and the edit billing address form, synced with existing address fields validation

The action is initiated via a redirect (opens in a new tab) to the edit page. The page uses HTML, CSS, and JavaScript for the billing address validation. The "name on card" label and values are also removed, as we do not store name along with the vaulted credit card. The full edit-payment-method.html (opens in a new tab) can be viewed in the Cornerstone GitHub Repo.

Edit Payment Method Form

Step 7: Implement Add Payment Method (opens in a new tab)

  • Adding new icon lock.svg
  • Unify the CSS classes for the add and edit form.
  • Add a new template for edit form with an injection of global variables into context.
  • Extend the account.js file with a new method to initiate credit card and billing address fields validations, mapping form fields name and value to body request.
  • Add a payment-method.js file for credit card validations and helpers with unit test.

The add form will use ajax to validate and submit the credit card details (this differs from the way the edit form validates and submits). The payment-method.js file (opens in a new tab) has been designed to be dragged and used in themes to simplify its implementation.

The add-payment-method.html template (opens in a new tab) also requires some customization because variables need to pass through handlebars in order to be used by JavaScript. From line 20 to 25 of the template (opens in a new tab), we store variables, mostly for building the request url and header. The request body will directly use the form data. More validations and extra mapping (opens in a new tab) are added to the add-payment-method.html template as well.

Example of the addition of the Add Payment Method

Step 8: Add Default Instrument (opens in a new tab)

  • Add HTML and CSS for a single checkbox, default instrument
  • Capture form data on ADD and transform to boolean
  • Fix HTML credit card for tabulation navigation
  • Fix for states reload list via AJAX

Add default instrument checkbox to edit and add form

Utilizing GitHub Automation to Merge the Changes

Since this feature involves heavy code changes, it may be easier to merge the necessary code into your theme by utilizing GitHub's automated process for syncing a fork. See GitHub's documentation on Syncing a Fork (opens in a new tab) for more details on this method.

FAQ

Where is the card data stored?

Card data is stored securely with the payment gateway.

Is storing credit cards PCI compliant?

Card data is stored securely with the payment gateway. The BigCommerce store is NOT storing the payment data.

Can shoppers modify their stored card?

After adding a card, shoppers will only be able to modify the billing address. If other credit card details need to be modified (such as expiration date), the shopper must delete and re-add the card.

Resources

Related Articles

Did you find what you were looking for?
Staying Current with Platform ChangesAdd Google Data Tags