24/7 Support: 800.608.6482

Get Started

Reference Guide

Intuit Merchant Services

Intuit Merchant Services (previously known as QuickBook Merchant Services) is a real-time gateway, similar to Authorize.Net. You must have a merchant account set up with Intuit before you can use Intuit Merchant Services in your store.

Intuit API Endpoint URL: This field is pre-set with the path to the Intuit API. You will probably never need to change it.

Connection Ticket: The Connection Ticked is a credential that you get when you set up your Intuit merchant account. It looks something like this: SGM-FUR-26-f6LzmXod3wdT_5MSeFCShH

Apply for an IPS merchant account or generate a connection ticket: If you do not already have an Intuit merchant account, you can click on this link to visit the page to apply for one. You must have a merchant account set up with Intuit before you can use Intuit Merchant Services in your store.

CVV2 Message: The text that you enter in this field will appear in your on-line store during checkout when your customer enters their credit card information. Merchants usually use this field to describe the purpose of the CVV2 field.

Transaction Type: Authorize Only, Capture Later: Authorization occurs when the user clicks the Submit button in the Payments page in your on-line store. To capture funds you must edit the order in Miva Merchant admin and click on the Capture button.

Automatic Capture: Authorization and Capture happen right away.

Note that these settings also affect you when you manually create an order. For example:

  1. Set the Charge Method to Sale (Automatic Capture).
  2. Manually create an order.
  3. Edit the order and click the Authorize button. In the Authorize dialog box, select a payment type associated with PayPal Payments Advanced and click OK.

In the Edit Order screen, you can see that the Capture button is greyed out and the funds were automatically captured after authorization.

Store Entire CC Number: If you select this option, the customer's entire credit card number is attached to the order. If you do not select this option, only the last four digits of the customer's credit card are attached to the order.

Available Payment Methods: Select the payment options you want to offer your customers in the OPAY screen.

Require CVV2 in Administrative Interface: This option only affects you when you are manually creating an order through the Miva Merchant admin interface. If you enable this option, you must enter a CVV2 number in the Authorize dialog box when you create or edit the order. If you do not enable this option, the Authorize dialog box will still have a CVV2 field, but you can ignore it.

Payment > PayPal Express Checkout and/or Payments Pro

Use this module to enable any of the following PayPal services:

Express Checkout with API Credentials: Also requires only a standard PayPal account. This option permits refunds and voids, and can be configured for immediate or delayed capture. With delayed capture the funds are authorized when the customer completes the order, but you have to manually capture the funds when you edit an order.

PayPal Payments Pro:To use this option you must set up a PayPal Payments Pro account (a merchant account) with PayPal, which requires an additional monthly fee.

  • Includes PayPal Express Checkout.
  • Supports refunds and voids.
  • Can be configured for immediate or delayed capture.
  • Gives your on-line store direct access to credit card transactions. When your customers go through checkout, they will see the PayPal Express Checkout option, but will also see options for Visa, MasterCard, Discover, and American Express.

Template Changes for PayPal Express Checkout

PayPal Express Checkout in Miva Merchant changed in PR8 Update 11.

  • If you did not use PayPal Express Checkout before PR8 Update 11, you don't have to do anything. All the changes that you need are included in PR8 Update 11.
  • If you were using PayPal Express Checkout in your store before PR8 Update 11, you have to make the template changes in the PR8 Update 11 Template Changes.

Template Changes for PayPal Express Checkout

Before you can complete the instructions in this section, you must have a "standard" free account with PayPal.

  1. Go to Menu> Payment > Add/Remove Modules > Available Modules tab.
  2. Click the Install button under PayPal Express Checkout and/or Payments Pro.
  3. In the PayPal Express Checkout and/or Payments Pro API Credentials tab:
  4. 3.1. Set the Operation Mode to Production.

    3.2. Select your Currency.

    3.3 Select the E-mail address to receive PayPal Payment radio button. Enter the email address associated with your PayPal account.

  5. Click Update.
  6. Select the Payment Settings > PayPal Express Checkout Tab and make any required changes.
  7. Click Update.

To Configure PayPal Express Checkout with API Credentials

Before you can complete the instructions in this section, you must:

  • Have a "standard" free account with PayPal.
  • Your PayPal account must be upgraded to use API access.
  • Paypal

  1. Go to Menu> Payment > Add/Remove Modules > Available Modules tab.
  2. Click the Install button under PayPal Express Checkout and/or Payments Pro.
  3. In the PayPal Express Checkout and/or Payments Pro API Credentials tab:
  4. 3.1. Set the Operation Mode to Production.

    3.2. Select your Currency.

    3.3. Select the API Credentials for payments and post-checkout operations radio button.

    3.4. Set the Account Type to Express Checkout.

    3.5. Set the API Username, API Password, API Authentication Method, and API Signature / Certificate. Please see Payment Settings > PayPal Express Checkout and/or Payments Pro API Credentials Tab.

  5. Click Update.
  6. Select the Payment Settings > PayPal Express Checkout Tab and make any required changes.
  7. Click Update.

To Configure PayPal Payments Pro

Before you can complete the instructions in this section, you must go to PayPal.com and setup a Payments Pro account. This is a merchant account that requires an additional monthly fee.

  1. Go to Menu > Payment > Add/Remove Modules > Available Modules tab.
  2. Click the Install button under PayPal Express Checkout and/or Payments Pro.
  3. In the PayPal Express Checkout and/or Payments Pro API Credentials tab:
  4. 3.1. Set the Operation Mode to Production.

    3.2. Select your Currency.

    3.3. Select the API Credentials for payments and post-checkout operations radio button.

    3.4. Set the Account Type to PayPal Payments Pro.

    3.5. Set the API Username, API Password, API Authentication Method, and API Signature / Certificate. Please see Payment Settings > PayPal Express Checkout and/or Payments Pro API Credentials Tab.

  5. Click Update.
  6. Select the Payment Settings > PayPal Express Checkout Tab and make any required changes
  7. Click Update.
  8. Select the Payment Settings > PayPal Payments Pro Tab and make any required changes.
  9. Click Update.

PayPal Express Checkout and/or Payments Pro API Credentials

Operation Mode: Production: Select this mode if you are ready to use one of the PayPal methods in your store.

Sandbox: Generally you would only select this mode if you are a developer and you want to test one or more of the PayPal payment methods. Before you can use sandbox mode, you must go to developer.paypal.com and sign up for a Sandbox account.

Currency: Select the currency for payments that you receive. Usually this matches the currency you have set for your store (see Edit Store > Settings > Currency Formatting drop-down list.)

E-mail address to receive PayPal Payment: Select this option if you want to enable only PayPal Express Checkout. Enter the email address associated with your PayPal account.

Account Type: Express Checkout: Select this option if you want to use Express Checkout with API Credentials.

PayPal Payments Pro: Select this option if you want to use PayPal Payments Pro.

API Username: The API credentials, username, password, authentication method, and signature/certificate are used by PayPal to authenticate your online store and your shopping carts. You create these credentials when you either:

  • Update your standard PayPal account for API Access.
  • Create a PayPal Payments Pro account.

API Password: See API Username.

API Authentication Method: Select Signature unless PayPal has specifically instructed you otherwise. This is the method that PayPal uses to authenticate your store's shopping cart to prevent someone spoofing or otherwise tampering with a cart or payment.

API Signature / Certificate: See API Username.

PayPal Express Checkout

Transaction Mode: Immediate Sale: Select this option to have capture occur immediately. Note that this field is greyed out and selected by default if you selected "Email address to receive PayPal Payment radio button" in the "PayPal Express Checkout and/or Payments Pro API Credentials" tab.

Authorization with Delayed Capture:

If you select this option, authorization will happen immediately, but the funds will not be captured until you manually edit the order in the Miva Merchant admin and click the Capture button.

Note that these settings also affect you when you manually create an order. For example:

  1. Set the Transaction Mode to Immediate Sale.
  2. Manually create an order.
  3. Edit the order and click the Authorize button. In the Authorize dialog box, select a payment type associated with PayPal Payments Advanced and click OK.
  4. In the Edit Order screen, you can see that the Capture button is greyed out and the funds were automatically captured after authorization.

Enable In Context Checkout: PayPal's in-context checkout is similar to the in-line checkout used by Amazon Payments. If you enable this feature, customers can log into their PayPal accounts and make shipping and payment selections without leaving your store. If you do not enable this feature, the customer is redirected to a PayPal web page to login and select shipping and payment. Tracking tools, such as Google Analytics, cannot track your customers when they are on a PayPal page.

PayPal's in-context checkout is a little different from Amazon's.

Order Details

When you use the PayPal in-context feature:

  • The customer does not leave your store during authorization or checkout.
  • The customer logs into their PayPal account with a popup window that appears on top your store page.
  • Information is taken from the customer's PayPal account, placed into a standard Miva Merchant page (OCST, in the example above) and can be edited.

When you use the Amazon Payments in-line feature:

  • The customer does not leave your store during authorization or checkout.
  • Your store page has a "widget" (a type of control) built into it. These page widgets let your customer log into their Amazon account and select shipping and payment information.
  • Information is taken from the customer's Amazon account, placed in a custom Miva Merchant page (Amazon Payments - OCST, in this example) and cannot be edited.

Display PayPal Credit Button: PayPal Credit is a credit product from PayPal. If you enable this feature, a PayPal Credit Button will appear in the Basket Contents screen (BASK) as a payment option.

Packaging Rules

The PayPal Credit feature currently does not support in-context verification or in-context authorization. If the customer selects PayPal Credit, they:

  1. Are redirected to a PayPal page where they login to their PayPal account.
  2. Make their shipping and payment selections.
  3. Return to your store to complete checkout.

Use Customer's PayPal Shipping Address for Miva Merchant Orders: Use Customer's PayPal Shipping Address for Miva Merchant Orders: Select this option if you want to use the customer's PayPal shipping address as the destination address.

Send Order Details: If you select this option, all items, quantities and prices in the order are sent to PayPal. If you do not select this option, only the order total is sent to PayPal.

Order Description: Whatever you enter in this field will show up in the customer's PayPal account as a note for the transaction.

Order Review Message: When the customer returns to your on-line store after paying with PayPal, they see a confirmation page right before the invoice page, which will show whatever text you enter in this field.

Until the customer clicks the OK button in the confirmation page in your online store, they haven't authorized payment. The "authorization" in the customer's PayPal account just authorizes your on-line store to complete a transaction with the customers PayPal account. It doesn't authorize the fund transfer.

Locale: Select the country where your account with PayPal was created. If you were in the United States when you created your PayPal account, select "United States".

Page Style: This field and the fields below give you some minor control over the PayPal login screen that the customer will first see if they select PayPal Express as the payment method. Whatever page style template you selected in your merchant's PayPal account, you should enter here.

Header Image URL: Enter a server path to an image, or use the upload button to upload an image to your store server. The image that you reference here will show up at the top of the PayPal login screen when your customer chooses to pay with PayPal. The max image size is 750x90 pixels.

Header Border Color: Enter a 6 digit hex number. That color will be used as the header border color in the PayPal login screen when your customer chooses to pay with PayPal.

Header Background Color: Enter a 6 digit hex number. That color will be used as the header background color in the PayPal login screen when your customer chooses to pay with PayPal.

Page Background Color: Enter a 6 digit hex number. That color will be used as the page background color in the PayPal login screen when your customer chooses to pay with PayPal.

PayPal Express In-context Checkout

If you enable the PayPal Express in-context checkout, the checkout screens in your store will look slightly different to the customer.

Packaging Rules

In the Basket Contents screen (BASK), the customer clicks the "Checkout with PayPal" button.

Paypal

While they are still in the Basket Contents screen (BASK), the customer enters their PayPal credentials in a popup window and clicks the Log In button.

Paypal

Another popup window opens in front of the Basket Contents screen. The customer makes their "ship to" and "pay with" selections and clicks the Continue button.

Paypal Order Details

The customer returns to the Order Details screen (OCST) in your store. The Ship To information that the customer selected from their PayPal account is populated into this screen an can be edited. The customer clicks the Continue button when they are done.

Shipping Payment

The payment information that the customer selected from their PayPal account is populated into the Shipping/Payment screen (OSEL). The customer can edit the information and clicks the Continue button when they are done.

Payment Info

Payment Info

The customer sees the standard Payment Information confirmation screen (OPAY). The customer clicks the Continue button to confirm that the order is correct.

Invoice

The customer sees your invoice screen (INVC).

PayPal Express Credit

PayPal Credit in Miva Merchant currently does not support in-context checkout.

Paypal Credit

The customer goes to the Basket Contents page (BASK) and clicks the PayPal Credit Button.

Test Store

The customer leaves your store and goes to a PayPal page. If the customer already has PayPal Credit set up in their PayPal account (as in this case) they are asked to enter their credentials. If the customer does not have a PayPal Credit account, they are taken to a page to apply for one.

Test Store

At a PayPal page, the customer selects their billing and payment options and clicks the Continue button.

Order Details

The customer returns to the Order Details screen (OCST) in your store. The Ship To information that the customer selected from their PayPal account is populated into this screen an can be edited. The customer clicks the Continue button when they are done.

Payment Info

The payment information that the customer selected from their PayPal account is populated into the Shipping/Payment screen (OSEL). The customer can edit the information and clicks the Continue button when they are done.

Payment Info

The customer sees the standard Payment Information confirmation screen (OPAY). The customer clicks the Continue button to confirm that the order is correct.

Payment Info

The customer sees your invoice screen (INVC).

PayPal Payments Pro

Send Order Details: If you select this option, all items, quantities and item prices in the order are sent to PayPal. If you do not select this option, only the order total is sent to PayPal.

Transaction Mode: Immediate Sale: Select this option to have authorization and capture occur immediately. Note that this field is greyed out and selected by default if you selected "E-mail address to receive PayPal Payment radio button" in the "PayPal Express Checkout and/or Payments Pro API Credentials" tab.

Authorization with Delayed Capture: If you select this option, authorization will happen immediately, but the funds will not be captured until you manually edit the order in the Miva Merchant admin and click the Capture button.

Note that these settings also affect you when you manually create an order. For example:

  1. Set the Transaction Mode to Immediate Sale.
  2. Manually create an order.
  3. Edit the order and click the Authorize button. In the Authorize dialog box, select a payment type associated with PayPal Payments Advanced and click OK.

In the Edit Order screen, you can see that the Capture button is greyed out and the funds were automatically captured after authorization.

Available Payment Methods: Select the payment methods that you want to offer your customers during checkout.

Require CVV2 in Administrative Interface: This option only affects you when you are manually creating an order through the Miva Merchant admin interface. If you enable this option, you must enter a CVV2 number in the Authorize dialog box when you create or edit the order. If you do not enable this option, the Authorize dialog box will still have a CVV2 field, but you can ignore it.

Order Description: Whatever you enter in this field will show up in the customer's PayPal account as a note for the transaction.

Payment > PayPal Payments Advanced and/or Payflow Gateway

Use this module to configure one of three PayPal products:

  • PayPal Payments Advanced: PayPal Payments Advanced combines a merchant account (with a monthly fee) and a gateway in one product. Unlike PayPal Payments Pro, with this method you cannot store the customer's credit card information along with their order.
  • This product uses a "hosted checkout" which places an iFrame in your checkout pages. From the customer's perspective they are entering their credit card information in your on-line store, however, the information is being sent directly to PayPal. As of this writing (08/01/12), this method makes PayPal responsible for compliance with the Payment Card Industry standards for secure transactions. Please note that this is subject to change.

  • Payflow Link: Payflow Link is a payment gateway that does not include a merchant account. Like PayPal Payments Advanced, with this method PayPal is currently responsible for PCI compliance with transaction security.
  • Payflow Pro: Like Payflow Link, this method is a gateway only. Unlike the other two methods it does not add an iFrame to your checkout pages for credit card transactions. The credit card transaction takes place within your on-line store.
  • Product Name Includes a Merchant Account (with Monthly Fee) Adds an iFrame to Your Checkout Pages Includes a Gateway
    PayPal Payments Advanced

    Payflow Link
    Payflow Link

    Payment Solution: Select the PayPal product you are using. If you haven't already signed up for one of the products, you can click on a Sign Up link to go to PayPal's website.

    Host: The URL that Miva Merchant uses to make transaction requests. This field is auto-populated and you should never need to change it.

    Partner: The partner is the seller or reseller that gives you access to the payment gateway. When you create your PayPal account you will be told the partner information. It will generally be either PayPal or Miva Merchant.

    Merchant Login: When you sign up for a PayPal product you get a single merchant login and one or more user logins. The merchant login is like the "master" login for your account. There is only one merchant login and password. However, you can also create as many user logins as you wish. For example, you might use your company name as your merchant login and then create user logins for different employees in your company.

    User: The user account name that you want to use.

    Password: The password for your merchant login.

    Transaction Timeout: Defaults to 30 seconds. When your on-line store sends a request to a gateway (authorize/refund/void/capture), Miva Merchant starts a timer. If Miva Merchant doesn't get a response from the gateway before the transaction timeout, both Miva Merchant and the gateway cancel the request.

    CVV2 Message: Only applies if you are using Payflow Pro. The text that you enter in this field will appear in your on-line store during checkout when your customer enters their credit card information. Merchants usually use this field to describe the purpose of the CVV2 field.

    Charge Method: Sale (Automatic Capture): If you select this option, authorize and capture will occur when the user clicks the Submit button in the Payments page in your on-line store.

    PreAuth (Authorize Only, Capture Later): Authorization occurs when the user clicks the Submit button in the Payments page in your on-line store. To capture funds you must either:

    • Edit the order in Miva Merchant admin and click on the Capture button.
    • Log into your PayPal account and manually capture the funds.
    • Note that these settings also affect you when you manually create an order. For example:

      1. Set the Charge Method to Sale (Automatic Capture).
      2. Manually create an order.
      3. Edit the order and click the Authorize button. In the Authorize dialog box, select a payment type associated with PayPal Payments Advanced and click OK.
      4. In the Edit Order screen, you can see that the Capture button is greyed out and the funds were automatically captured after authorization.

    Store Entire Credit Card Number:

    • If you are using Payflow Pro, and you select this option, the customer's entire credit card number is attached to the order. (You can view the credit card information by editing the order).
    • If you are using Payflow Pro and you don't select this option, only the last four digits of the customer's credit card are attached to the order.
    • If you are using Payflow Link or Payflow Pro, the last four digits of the customer's credit card are always attached to the order, regardless of whether you check this box or not.

    Available Payment Methods: If you are using Payflow Pro, the payment methods that you choose here will show up in the payments drop-down list during checkout. If you are using Payflow Link or Payflow Pro, the drop down list will show whatever you select here, but the iFrame will only accept American Express, Discover, MasterCard and Visa.

    Require CVV2 in Administrative Interface: This option only affects you when you are manually creating an order through the Miva Merchant admin interface. If you enable this option, you must enter a CVV2 number in the Authorize dialog box when you create or edit the order. If you do not enable this option, the Authorize dialog box will still have a CVV2 field, but you can ignore it.

    Payment > PayPal Payments Standard

    PayPal Payments Standard, also called PayPal Instant Payment Notification, is PayPal's oldest product.

    • Setup is easy and requires only an email address.
    • Does not support voids, refunds, or delayed capture.
    • No monthly fees.
    • Does not require a merchant account.

    If the customer selects this payment method in your store, they are taken to the PayPal site and can pay with any method they have configured in their account. Please note that you should not enable both Payments Standard and PayPal Express Checkout. There's very little difference between the two products, and if you enable both, the text "PayPal" will appear twice in the Pay With drop-down list.

    Business Email: Your PayPal email address.

    PayPal URL: The URL that Miva Merchant uses to make transaction requests. This field is auto-populated and you should never need to change it.

    Currency: Select the currency for payments that you receive. Usually this matches the currency you have set for your store (see Edit Store > Settings > Currency Formatting drop-down list.)

    Prompt Shoppers for Shipping Address (on PayPal side): If you enable this option, when the customer reaches the PayPal website they will be prompted to confirm the shipping address that they have on file with PayPal. The most secure method you can use to guarantee the customer's shipping address is to enable this option and the next option "Use Customer's PayPal Shipping Address". You've asked the customer to confirm their shipping address, and you are guaranteeing that your on-line store will ship to that address.

    Use Customer's PayPal Shipping Address for Miva Merchant Orders: If you enable this option, the address that the customer has on file with PayPal will be used as their shipping address. See above.

    Message: The message that you enter in this field will appear in the OPAY (Payment Information) page in your on-line store. Merchants usually use this field to explain to the customer that, when the customer clicks the Submit button in the Payment Information page, they will be taken to the PayPal website to complete payment. When they've finished paying, they will automatically return to the INVC (Invoice) page in your on-line store.

    Instructions: These instructions describe how to configure your PayPal Payments Standard account so that an order is correctly created in your Miva Merchant store. If you don't configure your PayPal account correctly, you will receive payment from your customer, but the order might not be created in your on-line store, or it might not be created correctly. You will receive payment, but you might not have enough information to fulfill the order.

    Payment > Add/Remove Modules

    To Add Payment Modules

    1. Go to the Menu> Payment > Add/Remove Modules tab.
    2. Select the Available Modules section.
    3. Click on the Install button for the payment module that you want to add.

    To Remove Payment Modules

    1. Go to the Menu> Payment > Add/Remove Modules tab.
    2. Select the Installed Modules section.
    3. Click on the Remove button for the payment module that you want to remove.

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

Miva believes that all online businesses should have access to a scalable ecommerce platform that can meet their unique business requirements. Miva offers PCI compliant ecommerce, hosting, and custom website design and development solutions. Miva customers have processed over $100 billion in online sales since 1997.

Copyright © 2016 Miva, Inc - All Rights Reserved   Privacy Policy | Store Policy

Links
Contact Us
Receive Tips & Updates

Copyright © 2016 Miva, Inc - All Rights Reserved

Back To The Top