Miva

---

Install the Miva module for Credit Key

Installing the Module on your Domain

1. The name of the module is creditkey.mvc. Extract it from the ZIP file provided, if necessary.
2. Log into your Miva Merchant administration backend (for example, https://www.domain.com/mm5/admin.mvc)
3. Navigate to Settings > Domain Settings.
4. Click on the Modules tab
5. Click the Add Module button
6. On the next screen, labeled “Add Module”, click the “Upload” button.
7. In the popup window, click the “Choose File” button (depending on your browser, the button label may be different.)
8. Navigate to the creditkey.mvc file on your hard drive and select it.
9. Click the “Upload” button on the popup window.
10. The popup window will disappear, returning you to the Add Module screen. Click the “Add” button near the top right.

Assigning the Module to your Store

1. Navigate to Settings > Payment Settings.
2. Click the “…” button in the upper right, then choose “Add/Remove Modules”
3. Locate the Credit Key module. Click the “Install” button inside the its box.
4. If you have multiple stores on your domain, repeat steps 1-3 above for each store that you want to integrate with Credit Key.

Configuring the Module

1. Go to Settings > Payment Settings and then click the Credit Key tab. It may be located under the “More” tab.
2. Choose Staging or Production for the environment you want to use.
3. Enter your public and private keys in the appropriate boxes.
4. If desired, enter the minimum amounts at which promotional messaging will be displayed on the product detail page (PROD), the basket page (BASK) and during checkout (OSEL).
5. Choose an alignment for the promotional messaging: right, left, or centered. This only affects the basket (BASK) page.
6. Click the “Update” button in the top right to save your settings.

Create the User Interface Item

This should have been done for you when you installed the module. If not, perform the steps below.

1. Click User Interface in the left column.
2. Click on the Items tab.
3. Click the “Add Item” button
4. In the “Code” box, enter “creditkey”.
5. Click the “Look Up” button to find the Credit Key module.
6. Click the “Add” button to create the item.

Assign the Item to the Pages

This should have been done for you when you installed the module. If not, perform the steps below.

1. Click User Interface in the left column.
2. Click the Items tab
3. Search the Items list for an item with the code “creditkey”
4. Click that item to edit it (click under the “Module” column)
5. Click the “Pages” tab
6. Assign the item to the pages “PROD” and “BASK” using the toggles in the “Assigned” column.
7. If you do not see these pages, click the Filters dropdown in the upper right and choose “Show All”.

Editing Placement of the Promotional Messaging

By default, the code for promotional messaging should have been added to the PROD and BASK pages on your store. These are controlled by placing the following tag in your store’s PROD and BASK page templates:

<mvt:item name="creditkey" param="container" />

To check whether this was added, or to move the tag to a new location on the page, perform the following steps:

1. Click User Interface in the left column
2. Search the page list for “PROD”
3. Click “Product Display” – the page with “PROD” as its code
4. Search the “Product Display Layout” template (not the main template) for the above tag
5. If it’s not there, add it. The suggested location is above the add to cart button
6. If you wish to move the tag, you can delete its original location and add it to a new location. The promotional graphic will appear wherever you have added the tag

Nearly identical steps are used for the basket page:

1. Click User Interface in the left column
2. Search the page list for “BASK”
3. Click “Basket Contents” – the page with “BASK” as its code
4. Search the “Basket Contents” template (not the main template) for the above tag
5. If it’s not there, add it. The suggested location is above the checkout button
6. If you wish to move the tag, you can delete its original location and add it to a new location. The promotional graphic will appear wherever you have added the tag

Upgrading the Module on your Domain

The process to upgrade the Credit Key module on your store is similar to the installation process.

1. Extract creditkey.mvc from the ZIP file provided.
2. og into your Miva Merchant administration backend (for example, https://www.domain.com/mm5/admin.mvc)
3. Navigate to Settings > Domain Settings.
4. Click on the Modules tab
5. In the box labeled “Search Modules...”, type in Credit Key and then click the Enter button.
6. Click the entry in the table, in the Name column, where it says “Credit Key”
7. On the next screen, click the “Files” tab.
8. Click the “Upload” button.
9. In the popup window, click the “Choose File” button (depending on your browser, the button label may be different.)
10. Navigate to the new version of creditkey.mvc file on your hard drive and select it.
11. Check the “Overwrite” checkbox.
12. Click the “Upload” button on the popup window.
13. The popup window will disappear, returning you to the Edit Module screen. Click the “Update” button near the top right.

Uninstalling the Module from your Store/Domain

Before you can uninstall the module, you will need to archive or delete any orders that use it. See https://docs.miva.com/reference-guide/regular-archiving for more information about archiving orders.

Once that has been done, complete the following steps:

1. Click User Interface
2. Choose the Items tab
3. Search for “creditkey”
4. In the Module column, click “Credit Key”
5. Click the Pages tab
6. Unassign the item from all pages to which it’s assigned
7. Click the Item tab
8. Click the “…” button and choose Delete Item from the dropdown.
9. Go to Settings > Payment Settings
10. Click the “…” button and choose “Add/Remove Modules”
11. Locate the “Credit Key” box, click the “…” button within its box, and choose “Uninstall”. If you receive any errors, make sure you have completed the steps above.
12. Repeat above steps for additional stores, if you have more than one on your domain.
13. Go to Settings > Domain Settings.
14. Click the Modules tab.
15. In the “Search Modules...” box, type in Credit Key and click the Enter button
16. Click the entry in the table, in the Name column, where it says “Credit Key”
17. In the upper right of the next screen, click the “...” button, and choose “Delete Module”
18. If you wish to leave the creditkey.mvc file on your server, uncheck the “Delete module file /mm5/5.00/modules/payment/creditkey.mvc” checkbox. Otherwise, leave it checked.
19. Click the orange “Delete” button in the upper right.

Questions? Contact Credit Key Support