Install and Configure an App

We recommend that you use the sandbox environment for accessing the Tenant portal, if you are trying to install and configure Apps for the first time.

When you are trying to communicate with a Payment Service Provider, you will have to follow a tedious setup process ensuring all the integrations are correct.Duck Creek has designed and constructed the interfaces to integrate with most of the Payment Service Providers. These interfaces are shipped along with Duck Creek Payments and are referred to as Apps.

Before you Start

Before you start following this guide, you should understand the concepts related to the Payments application. You must also have access to the Tenant Portal and permission to install and configure Apps.

How it works?

You can find a list of Apps through the Marketplace, where each App is associated with a Payment Service Provider. Once you have installed the App of your choice, you will be asked to submit the credentials that you use to connect with the Payment Service Provider (PSP), along with the PSP's features that you want to use.

Depending on the App you are trying to configure, the credentials can be as simple as the username and password that you use to login with the Payment Service Provider or as complex as a set of API and Webhook keys.

All the information that you enter through the Apps are stored in a secret vault that is encrypted and secure.

After you have configured and saved the App, you can then have Payments use the Apps and transact with the PSPs on your behalf.

Follow this guide to learn how to install and configure an App in the Tenant portal.

How to Install and Configure Apps

Step 1: Go to Apps

Login to the Tenant Portal
Select Apps under Marketplace menu from the left sidebar. The Installed apps page appears with a list of all the installed apps (if any).

Step 2: Find your App in App Marketplace

In the Installed apps page, click:

the button next to the Search box, or

the larger Add box that you will see the Installed apps page.

The App marketplace page appears with a list of all the Apps. Use one of the following options to search for your desired App.

Search box next to the Hide filter button to search the name of the PSP

Filter panel next to the left-side bar to narrow down the search

Mouse/keyboard to scroll and locate the App

Step 3: Install the App

Once you have located the App you want to install, click on the Add button next to the App.
A confirmation box will appear, prompting you to install. Click Yes, install.
The App's setup page appears and a slide-in banner on the top of the page will notify that App installation has completed.

Step 4: Configure the App

If you are returning to configure an App that you have installed, you will have to Go to Installed apps page and click on the App you want to configure.

In the App's setup page, provide all the necessary information. The information required to provide during the configuration depends on the PSP.

You can receive the personal credentials that you will have to enter during the App configuration from your PSP.

Enable all the features that you want to use with Payments.
Click to securely store all the information you have provided.
A slide-in banner on the top of the page will notify that App has been configured successfully. You will also see the border around the App's setup page light up in green (as opposed to the initial red) indicating the App configuration is valid.

Troubleshooting

I have installed the wrong App and want to remove it.

You can't remove an installed App that you have referenced in an existing Collection Scheme or Payout Scheme. Payments will display an error message if you attempt to remove such Apps.

Uninstalling an App will remove all the information and configuration associated with the App.

If you have installed the wrong App, you can easily remove that App from the Installed apps page. Follow the steps below to remove an App.

Go to Installed apps page
From the list of Installed apps, select that title of the App that you want to remove.

If you do not see the App you had installed, click the button next to the Search box. Then, on the App marketplace page click the Show Installed apps button to narrow down to the Apps you have installed.

The App's setup page appears. Click on the Unistall App button on the top right corner of the page.
A confirmation box will appear, prompting you to confirm your choice. Click Yes, uninstall.
A slide-in banner on the top of the page will notify that the App has been removed successfully.

Payments didn't provide the information required to configure an App. Who should I talk to?

The information required to configure an App can only be provided by your PSP. Contact your PSP to get the information required to setup the App.

I can not see the App for my PSP.

Duck Creek is constantly adding Apps to support new PSPs. If you don't see the App associated with your PSP, reach out to your Account Manager to check if the App to support your PSP is currently in-development.

How can I see all the features an App supports.

There are two ways to see all the features an App supports.

You can go to the App marketplace and click on the Learn more button next to the App you want to explore.
You can go to the App's setup page and click on the App information button on the top right of the page.