MivaPay is Miva’s PCI-compliant credit card vault, that works with all major payment gateways supported by Miva. Those gateways include:

MivaPay provides a way to save customer cards on an account level, as well as an order level, which allows merchants to issue refunds, add to existing orders, reference past orders and complete orders as needed.

Credit card information is encrypted, saved and tokenized by MivaPay. Then when a saved card is used again, the token is sent back to MivaPay, the card number is decrypted and sent over a secure server to the payment gateway for authorization. The response, but not the card number, is sent back to Miva and saved with the order.

MivaPay makes checking out faster, makes PCI compliance easier to manage and allows for merchants to use the Subscription functionality of the Miva admin.

On this Page

Setting up MivaPay

Because MivaPay is part of the Miva Admin, there is no module to install, however there is some set up that must be done before it can be used.

To get started, click Settings in the bottom left corner of the admin, and then click Payment Settings. On the page that opens, click the Settings tab.


Under the MivaPay Settings header, click the box next to Enabled to enable MivaPay for your site.


The Base URL is set for you and should not be changed.

Once you have enabled MivaPay, you will need the following information:

All three of these can be found in your my.miva account at https://my.miva.com/



If you do not have access to your my.miva account, please contact support at support@miva.com

Once you have the needed information, enter them in the appropriate boxes. Once finished, click the Update button.

Group Payment Card Types into Single Payment Method with Description

Clicking this box changes the way a customer sees the credit card options available to them. If it is unchecked, all of the store’s credit card options will appear. If it is clicked, the generic term “Credit Card,” or whatever phrase or term is entered in that field, will display at checkout.

Configuring Payment Cards

Payment Cards are the card types, which are linked to MivaPay, that your store accepts as payment. They also establish an individual payment method and determine which Payment Gateway to use.

To begin, if you are already on the Payment Settings page, make sure you are in the Payment Method Rules tab. Then, click the More button (three dots) and select Payment Card Types.


In the window that opens, you will map each card type to the MivaPay supported payment method you choose. Only payment gateways which support MivaPay can be selected. The available gateways include all of the built-in Miva Payment Gateways:

To edit a Payment Card Type, select a row and click the edit button in the Linked Payment Method column for that row.


From the dropdown, select the Payment Gateway and the card type to map to the Payment Card Type. Then click Save Changes. Repeat this step for all the Payment Card Types you wish to accept in your store.

After you’ve set the gateway for each card type, close the window.

MivaPay CVV Settings

In order to use the CVV (Card Verification Value) settings, you must enable CVV for each payment method under Payment Card Types. After those are enabled, the CVV settings can be configured by clicking the Payment Settings header, and then the Settings tab.

In the MivaPay Settings section, there are three settings:

Each setting has the same three options:

CVV: Checkout: Payment Card Type

If Hidden is selected, a customer will not see the CVV field when completing the payment process.

If Optional is selected, the customer will see the CVV field, but will not be required to fill it in, so the font for CVV: will not be in bold, which signifies the value is required.

If Required is selected, the customer will be required to fill out the CVV field to continue the checkout process.

CVV: Checkout: Stored Payment Card

This setting is for when a customer has a card stored already in their wallet. The options behave exactly the same way as explained above.

CVV: Order Processing: Payment Card Type

This setting is for phone or custom orders and is only seen in the admin. The options behave exactly the same way as explained above.

Customer Mangement of MivaPay Cards

When a customer logs into their account, they will be able to manage their cards that are saved in the system.

To do so, the customer will log in to your store, and then click the My Account link.

On the page that opens, there are two ways to manage their cards. They can select Edit Cards or Add New Card in the left hand navigation, under Payment Options, or they can click View All next to the Payment Options heading on the main screen.


Clicking View All or Edit Cards takes you to the Customer Payment Cards screen.


On this screen a customer will see any cards they have already saved at your store. Clicking the Edit button to the left of the card opens the Customer Payment Card: Edit screen. Clicking Delete opens a dialog box warning the customer that the action cannot be undone, and asks them to confirm.

Customers can add a new card by clicking the Add New Card button, which open the Customer Payment Card: Add screen.


The customer selects the Card Type in the drop down menu, and then enters the required information below that. When finished, they click Save.


Clicking the Add New Card heading on the left hand navigation also takes the customer to the Customer Payment Card: Add screen.

Managing Customer Cards from the Miva Admin

Just like a customer can, shop owners can also add, edit or delete a customer’s card in the Miva admin.

To do so, navigate to your customer’s Customer Dashboard.

Once on the dashboard, scroll to the Payment Cards section. You have two options: Edit a card, or add a New Card.

Clicking Edit opens the Customer Payment Cards screen.


Clicking the “Ending in XXXX” link opens the Edit Customer Payment Card box.


Once you are finished editing the card, click the Save button.

Clicking the Add New from the Customer Payment Cards batchlist, or Add Card in the Customer Payment Cards screen, opens the Add Customer Payment Card box.


Once you have entered the required information, click the Add button.

Order-Level Saved Cards

The Miva admin will save, in tokenized form, a customer’s card for every order, regardless of whether the customer is logged in or not. The saved card appears just like any other card and allows store owners to do new authorizations against it.

To enable this setting, in the MivaPay settings, click the box next to “Retain Order Payment Cards for 30 Days.”



You can keep order-level saved cards longer if you desire, and should decide upon a minimum amount of time needed to retain the card number. For example if you sell custom-made products, and delivery takes 90 days, you could set the value to 90 days to give you access to the card to do new authorizations during that time period.

Excluding Non-MivaPay Card Types

You are able to exclude certain payment methods for non-MivaPay methods and prevent them from being an option at checkout.

To do so, in the Payment Method Rules tab, click on the payment method you want to exclude. In the box that opens there are two ways to accomplish this.


One, you can click the box next to Exclude this Method Unless Permitted by Products. This then creates an exclusion for that payment type and keeps it from showing at checkout. It’s important to note, however, that you can still allow it on the product level if desired.

Alternately, in the same box, you can click the drop down menu next to the payment method you want to exclude, and select “Excluded By” which will prevent the method from showing at checkout.

For additional information on exclusions and payment method rules, visit: https://docs.miva.com/miva10/reference-guide/payment-modules-payment-method-rules#edit-pymt-method-rules

Copy Order with Payment Data

The Miva admin also gives you the ability to copy an order and use the existing order as a starting point. On the order screen, you click the New Order button and the admin copies both the Customer Assigned and the Bill To/Ship To information.


And if you have MivaPay enabled on your store, and order-level saved cards also enabled, the function will also copy any order-saved cards from one order to the new order. This allows you to create a new order for a customer and not have to ask for their credit card information again.

Automatic Card Expiration Emails

The Miva admin can automatically email customers to update their saved card when that card is about to expire. Each customer only gets one email notification.

To customize the email template, click the Order Fulfillment header on the left of the page. The email is titled “Payment Card Expiring.” Clicking on the title opens the Edit Email box.


For more information on Template Based Emails click here.

This is also where the timing of when the email is sent can be configured and if it is sent for all expired cards or for just those attached to a subscription.


The email notification is handled by Miva’s scheduled tasks function. You can edit the settings for this or other scheduled tasks by clicking Settings, then Store Settings, and then clicking the Scheduled Tasks tab. Clicking the “Payment Card Expiring” scheduled task allows you to edit the task.


Using Braintree's Fraud Prevention Tools

If you use Braintree with MivaPay, you can take advantage of Braintree's built-in fraud prevention tools, which rely on collecting device data, which gets passed in the payment request.

This is accomplished by adding additional device tracker javascript, which is used by Braintree's fraud protection system.

To use the fraud prevention tool, you must first manually add code to the OPAY page to collect the device_id. This device ID gets saved into a hidden input and when the form is submitted, it is sent to MivaPay, and then on to Braintree to get a fraud score.


This code must be added inside the main form on the OPAY page so that it is sent along with the rest of the form data.


This code requires an Authorization Token that must be generated in your Braintree account using the steps outlined here.

Available options for dataCollector.kount.environment are:

To confirm the new code is working, you should be able to inspect the OPAY page and see that the hidden input has a value. It will contain a JSON object. You can also look at the data which gets submitted in the form:

MivaPay Guardian

MivaPay has monitoring features that allows the Miva admin to detect and log certain actions that could mean there is possible tampering or fraudulent activity. MivaPay Guardian looks for the following scenarios and will log the activity if any of the following use cases are found:

If any of these actions are detected they will be logged for further review by Miva.

More Information on MivaPay

For more information on MivaPay, please visit the links below.

MivaPay Page

Looking for Developer Docs?

We have a whole section for that, including: Developer Training Series, Template Language docs, Module Development tutorials and much, much more.

Head to the Developer Section

This website uses cookies to identify visitors, track visitors to our website, store login session information and to remember your user preferences. By continuing to use this site you agree to our use of cookies. Learn More.

This website uses cookies. By continuing to use this site you agree to our use of cookies. Learn More.


Copyright © 1997 – 2021 Miva©, Miva Merchant©, MivaPay©, MivaCon© Miva, Inc. All Rights Reserved.