Getting REST API Credentials from the Developer Portal for your Clover Payment Gateway

In this guide, we walk you through the steps to retrieve REST API keys and credentials for your Clover Payment Gateway integration.  

With the REST API credentials linked to your online store, you will be able to unlock powerful capabilities such as security features, refund processing and more.  

Follow the steps outlined below to get your REST API credentials from the Fiserv developer portal.  

Step 1: Navigate to the Fiserv Developer Portal  

The first step to retrieving your REST API credentials is to visit the Fiserv Developer Portal: https://fiserv.dev/.  

Then, click the sign up button at the top of the page, or navigate directly to the registration page through this link: https://portal.fiserv.dev/user/registration  

Step 2: Create an Account 

Complete the sign up form, giving accurate details such as your name, company, job title and email address.  

In the dropdown menu, you should also select “merchant” from the list.  

After submitting the sign up form, you will receive an activation email in the inbox of the provided address. Please open this email and “activate your account” by following the instructions provided in the message. An activation page will be opened.  

Following this, you will receive another email containing a verification code. On the activation page, please enter the verification code from the second email.  

You will also be prompted to create a new password and set language and currency preferences. Please select GBP as the currency. This does not impact the currency used on your online store, and you will still be able to set your currency prefernces in the payment gateway.   

Complete the remaining fields, such as providing a mobile number (optional) and the consent tick boxes, and click continue.

Step 3: Finish the Account Set Up    

To finish setting up your Fiserv account, we recommend enabling the two-factor authentication setting using the “one-time password via email” option. 

After you have followed the instructions to set this up, you will receive a confirmation that your account has been successfully set up and ready to use.

You will be prompted to login once again. Please proceed with this.  

Step 4: Request Your REST API Key

The final step is requesting your REST API key. In your account, navigate to the “Request an API Key” page. On this page, there will be two tabs – in the “standard” tab, please select “create new key”.  

A pop up will appear, where you will need to choose between a Sandbox or Production environment. Please select the sandbox option for test or development websites, and production for live environments.  

You will also need to choose an appropriate name for the Key. We advise using something relevant and descriptive so it can be easily identified.  

After completing these details, you can generate the API key. Click on the key you have just created in the list that is generated to view its details and to locate the Secret Key.    

Linking Your API Key and Store

Once you have created the REST API key, you will need to request that it is linked to your merchant store.  

Sandbox (Test) Environments

Please send an email to cloverukipgconnect@fiserv.com with the below information:  

• API key name 
• Store ID (please ensure this is the ID of the store you would like to link) 
• Email address used to create the account 

Once linked, your sandbox environment and features will be ready to use.  

Production (Live) Environments 

For production environments, the API key and API secret will not be received straight away. Once ready, please send an email to cloverukipgconnect@fiserv.com with the below information:  

• API key name 
• Store ID (please ensure this is the ID of the store you would like to link) 
• Email address used to create the account

Once linked, your production environment and features will be ready to use.  

Please note, merchants are required to send the email to the Clover Gateway Fiserv mailbox, NOT third-parties on their behalf. 

Payment.JS

If you will be using the Payment.JS payment method, you will also need to share the below webhook URL with Fiserv to link the account.    

Magento: https://example.com/clover/paymentjs/webhook    

WooCommerce: https://example.com/wc-api/clover-paymentjs-webhook   

Please ensure ‘example.com’ is changed to the relevant domain.  

We recommend using an email template like the below:  

“Hi Fiserv team, 

Can you please link the below STORE ID with the REST API Key and Payment.JS webhook URL?   

• Store ID:   
• Email Address:   
• Key Name:   
• Webhook URL: 

Can you please disable CVV verification and confirm once this is done? 

Thanks   

SENDER_NAME” 

Refunds

In order to issue refunds when using the redirect payment solution, you will also need to notify Fiserv to connect your store ID and REST API key.   

We recommend sending an email like the below, with your relevant details to cloverukipgconnect@fiserv.com  

“Hi Fiserv team,   

Can you please link the below STORE ID with the REST API Key?   

• Store ID:   
• Email Address:   
• Key Name:  

Can you please confirm once this is done?   

Thanks   

SENDER_NAME”  

How to Configure the New REST API in Your WordPress Dashboard

Once you have received your REST API Key and Secret, you are ready to integrate them with your WordPress website. To do this, please follow the below steps: 

1. Log into your WordPress dashboard as the administrator  
2. In the menu on the left, navigate to WooCommerce >> Settings >> Payments  
3. Click “Manage” under the Payments section to access the Clover Payment Gateway plugin  
4. Locate  the New REST API tab. This is where you can input the API Key and Secret from your Fiserv account 

How to Configure the New REST API in Your Magento Dashboard

Once you have received your REST API Key and Secret, you are ready to integrate them with your Magento website. To do this, please follow the below steps: 

1. Log into your Magento dashboard as the administrator  
2. In the menu on the left, navigate to Sales >> Payment Methods >> Autify Digital >> Clover 
3. Input the API Key and Secret from your Fiserv account 
4. Click the “Save” button  

Conclusion 

You have now successfully retrieved your REST API credentials and linked them to your Clover Payment Gateway integration and website. You are ready to unlock the full potential of your payment gateway and benefit from all its features and functions.  

If you require any further support, please do not hesitate to contact us.