How do I configure gift card settings for Magento 2?

Note: For guidance on how you configure your gift card settings for Magento 1, visit How do I configure gift card settings for Magento 1?

Using our Payment extension, your customers can use gift cards to pay for the goods and services they buy from your Magento store.

When you configure the gift card settings, you can apply the following:

  • Title – This is the title of your gift card section, which your Magento store displays to the customer in the shopping cart. You can change the title to suit your business.
An example of a title.
  • Max Length – This is the maximum number of characters that your customers can type in the gift card section in the shopping cart.
  • Cache lifetime – This is the interval at which Magento sends balance inquiries to our Payment Platform. When a customer enters a gift card number and clicks Add Gift Card, Magento does the following:

    - Checks with our Payment Platform if the gift card has sufficient funds to pay for part of, or all of the transaction.

    - Stores the response in its cache.

    - When the cache lifetime resets, Magento checks again with our Payment Platform if the gift card has sufficient funds to pay for part of, or all of the transaction.

  • When the customer completes their order, Magento checks again with our Payment Platform before capturing the funds, this is part of Magento’s fraud protection.
  • PIN – Enable this option to accept gift cards with a PIN. When using a gift card without a PIN, customers leave the PIN (if available) field empty.
An example shopping cart with the gift card section highlighted.

How to configure gift card settings

Step 1. Log on to Magento Admin.

Step 2. From the side menu, select STORES.

The Magento Admin Dashboard with the Stores button highlighted on the side menu.

Step 3. From the Stores menu, select Configuration.

The Stores menu with a call out for the Configuration link.

Step 4. From the Configuration page, navigate to Cayan (Gift Card) settings:

  a. Select SALES to expand the SALES submenu.

The Configuration menu with a call out for the Sales dropdown menu.

  b. Select Cayan Gift Card.

The Sales menu with a call out for the Cayan Gift Card link.

Step 5. Configure your gift card settings:

  a. From the Enable drop-down menu, select Yes.

  b. Type the Title to display in the gift card section of the checkout.

  c. Type the Max Length of the gift card numbers you want to accept in your Magento store.

  d. Type the Cache Lifetime. Magento Admin measures the cache lifetime in seconds, for example, if you want a cache lifetime of 15 minutes, type 900.

  e. (Optional) From the PIN drop-down menu, select Yes to accept gift cards with PINs.

The Cayan (Gift Card) settings with call outs for the text boxes you need to fill in.

Step 6. Click Save Config.

Note: Magento Admin completes the API URL by default. Do not edit or delete the API URL.

Modified on: Wed, 27 Feb, 2019 at 8:54 AM