Work with test merchants in sandbox

United States
Canada
Europe
Latin America

Test merchant accounts let you simulate merchant interactions with your application. This includes installing your app, assigning permissions, and then testing all the features of your app. When you sign up to create your sandbox developer account, you can create a test merchant after entering your developer and account information.

On the Test Merchants page in the Developer Dashboard, you can:

  • Create and access multiple test merchant accounts.
  • Manage your login credentials to access test merchants' information.
  • View and manage your test merchant business information. You can click the Settings icon next to the merchant name. See Manage test merchants for more information.

Create your first test merchant

On the Global Developer Dashboard, a Default Test Merchant account is created when you create your global developer account. However, on the sandbox Developer Dashboard, when you create a sandbox developer account, you need to create your first test merchant.

Create additional test merchants

You can create additional test merchants for each country in a region where you want to publish your app. You can add test merchants with different settings to simulate the effects of different regions, time zones, currencies, or permissions schemes.

A specific payment gateway is configured based on the address you enter for your test merchant. For example, if you want to create an app for use in Canada, create your test merchant using a Canadian address. The test merchant you create processes test transactions using the correct gateway for that region.

  1. Log in to the Developer Dashboard.
  2. Do one of the following:
  • From the Dashboard drop-down menu, under Developer Account, click Create test location.
  • From the left navigation menu, in the bottom panel, click Test Merchants.
    The Test Merchants page displays the list of test merchants.
Test Merchants page - Create test location

Test Merchants page - Create test location

  1. Click Add Test Merchant. The Create your Test Merchant page appears.
Create your Test Merchant page

Create your Test Merchant page

  1. Add information in the following fields:
  2. Click Create Account. The merchant you added displays in the test merchants list.
FieldDescription
Merchant NameName of the merchant that displays on the Test Merchants page and Dev Kits associated with the account.
CountryCountry where the merchant is located.
Zip/Postal CodePostal code for the merchant location.
Address LineStreet and building information for the merchant location.
CityCity of the merchant location.
State/ProvinceState or province of the merchant. If the selected country does not have states or provinces, enter n/a.
Phone NumberPhone number for the merchant.
CurrencyCurrency accepted by the merchant.
TimezoneTimezone for the merchant.
Employee Passcode LengthPasscode of 4- or 6-digits that employees of the merchant business must use to log on to the test device.

Update test merchant settings

You can update settings only for test merchants in the United States (US) region.

  1. Log into the Developer Dashboard.

  2. From the left navigation menu, in the bottom panel, click Test Merchants. The Test Merchants page displays the list of test merchants.

Test Merchants - Settings icon

Test Merchants - Settings icon

  1. From the Actions column, click the Settings icon next to a merchant name. The Settings pop-up appears.
Test Merchants - Settings pop-up

Test Merchants - Settings pop-up

Note: If the Settings page fails to load, add a new test merchant for the US region to use this feature.

  1. Update the following information:
FieldDescription
Card EntitlementsSelect checkboxes for the card types your merchant can use to process payments.
Note: You need to select at least one card type to proceed.
Credit Card SurchargingUse the toggle icon to turn on the feature and enter the fee in percentage (%) that the merchant can charge a customer for payment using a credit card. A merchant decides the surcharge percentage based on state rules. They can view the credit surcharge fee applied to transactions in the Virtual Terminal and on Clover devices and receipts. For more information, see:

- Use test cards for surcharging
- Clover Credit Card Surcharging policy
Smart TippingUse the toggle icon to turn on or off the Smart Tipping feature that displays on the Merchant Dashboard. If Smart Tipping is available, merchants can add a flat tip amount to the total sales value through their merchant settings.
Service PlansSelect a merchant service plan from the drop-down list. See Test an app with different merchant service plans.
Default: Standard Merchant Plans for the test merchants in the United States (US) region.
  1. Click Save. The Test Merchants page displays a confirmation message.

Use test cards for surcharging

Use the following cards to test the surcharging feature:

Card typeCard issuerCard numberCVVExpiry date
CreditMastercard®5405 9800 0000 830320112/23
CreditVisa®4005 5192 0000 0004 20120112/23

Update test merchant business information

You can update the merchant's business information only on the Developer Dashboard and not through the Setup app on a Clover device. To change your test merchant's business information:

  1. Log into the Developer Dashboard.
  2. From the left navigation menu, in the bottom panel, click Test Merchants. The Test Merchants page displays the list of test merchants.
Test Merchants - Launch Dashboard icon

Test Merchants - Launch Dashboard icon

  1. From the Actions column, click the Launch Dashboard icon next to a merchant name. The Merchant Dashboard appears.
  2. From the left navigation menu, click Account & Setup. The Account & Setup page appears.
  3. In the About Your Business section, click Business Information. The Business Information page appears.
Merchant Dashboard - Account & Setup > Business Information page

Merchant Dashboard - Account & Setup > Business Information page

  1. Update the relevant information.
  2. Click Save.