Configuration
Install and Configure an App
Apps and Marketplace
Before starting your interaction with Imburse, you need to connect with payment providers. Imburse transacts or communicates with the providers on your behalf with the Apps integration.
You can perform the following actions either in the Tenant portal or by requesting API calls:
This section includes a step-by-step procedure on how to work with Apps in the Tenant portal.
Add and install an App
In the Tenant portal, add and install the required App. To do so, perform the following steps:
- Login into the Tenant Portal.
- Navigate to the left-sidebar menu.
- Select Apps under Marketplace.
- Click the button to see the list of all available Apps.
Alternatively, you can search for the App by entering the App name in the search field. Narrow and customize your search results to find exactly what you want by applying the following filter settings:
- App Type
- Direction
- Payment Method
- Transaction Types
- Networks
- Click Add to install the selected App. The following confirmation window appears:
Are you sure that you wish to install the App?
- Confirm your choice by clicking . The App setup page appears along with the notification message:
The App is installed. Please enter your App configuration details below.
- You can now proceed with the App configuration.
Configure an App
To configure an App, perform the following steps:
- In the Tenant portal, navigate to the left-sidebar menu.
- Select Apps under Marketplace.
- Navigate to the required App page by clicking the App tile. The App setup page appears.
- Enter your client ID into the Client ID field.
- Enter your secret ID into the Secret ID field.
- Populate other fields under App features, such as Sepa Direct Debit Core, Sepa Credit Transfer, and some more depending on your payment requirements.
- Save your configuration settings by clicking .
Uninstall an App
You can only uninstall an App that is not being referenced in an existing Collection Scheme or Payout Scheme.
To uninstall an App, perform the following steps:
- In the Tenant portal, navigate to the left-sidebar menu.
- Select Apps under Marketplace. The list of installed Apps appears.
- Navigate to the required App page by clicking the App tile. The App setup page appears.
- Click . The confirmation window along with a caution appears.
- Click to confirm your choice. Your App is uninstalled now.
Set up Schemes
By using Schemes, Imburse platform can route payment instructions to the appropriate partner. A Scheme consists of three main components:
Component | Description |
---|---|
Drafts | With Drafts, you can add multiple draft scheme versions to be published at any one time. For more information, see Concept: Drafts. |
Rules | Adding Rules to your draft scheme allows you to explicitly control the payout options available in your scheme. For more information, see Concept: Rules. |
Apps | The Apps determine the available payment methods and partner integrations. For more information, see Concept: Apps. |
Collection and Payout Schemes
As soon as you installed and configured the App(s), you will need to create a Scheme, depending on its purpose:
- Collection Scheme defines the available payment options proposed to your customers.
- Payout Scheme defines the available payout options proposed to your customers.
Schemes workflow
Schemes work as follows: 1. As a customer, you define a scheme with a set of rules where each rule can have one or more associated Apps. 2. Payment instructions for that scheme have their attributes compared to each rule. 3. The matched rule determines the Apps available to process the instruction. 4. The financial instrument, such as a mobile phone number, card number, and more, is then used to determine the payment method and App combination to use for processing the payment.
Create a Scheme
To create Collect Schemes or Payout Schemes, perform the following steps:
- In the Tenant portal, navigate to the left-sidebar menu.
- Select Collect under Schemes.
- Click the button in the top right corner. The Collect scheme setup page appears where it is possible to define and order matching rules with associated Apps.
If you already have previously created Schemes, they will be displayed at this stage.
- Under Details, enter a Scheme meaningful name to the Name field, such as:
- Enter a Scheme code to the Code field, such as:
- Under Rules, specify your Scheme criteria by selecting values for the following fields:
- Country. Select the value from the drop-down list. For example, Germany.
- Currency, Select the value from the drop-down list. For example, EUR.
- Value. Specify the value range. For example, from 10 to 1000.
- To associate an App with the Scheme Rule, under Apps, click , and then select the App from the catalog of the already installed Apps.
When the App is added, you will see it along with the payment method displayed in the rule section.
- To save the draft, click in the upper left corner.
In this step, a Scheme ID is generated. You will receive a notification that the scheme is created.
- Click to make this draft available. The following confirmation message appears:
Are you sure that you wish to publish this draft? Please make sure you have saved any changes before publishing.
- Click . When the draft is published, you will receive a notification. After that, valid instructions will be matched with its Scheme ID and processed through the Partner’s App.
Add Reward Groups (optional)
For Payout Schemes, add Rewards Groups to propose rewards as a payout option. For example, a country-specific Amazon Gift Card rewards, such as Amazon.co.uk or Amazon.de. You can add as many Reward Groups as you need. For more information, see Concept: Rewards.To create Rewards Group, perform the following steps:
- In the Tenant portal, navigate to the left-sidebar menu.
- Select Rewards under Marketplace.
- Click in the top right corner. Add Rewards Group page appears.
- Enter a unique and meaningful name for your Reward Group, such as:
The name is displayed in the Client Portal UI to identify the Reward Groups added to a Payout Collection Rule.
- Under Rewards, click Add to add rewards to your group.
- Click .
Customize Imburse solution with Theming
By using Theming, you can customize the Imburse white-label solution to ensure consistency and alignment with your brand. Themes can be created and configured by editing colors, fonts, and even logos in the Tenant portal. By default, a predefined theme template is already available. It can be modified either by setting your new Theme to default or by assigning it as an attribute to the API request.
Create your own Theme
- In the Tenant portal, navigate to the left-sidebar menu.
- Select SDK under Developers.
- Click to see the page with all your existing themes displayed. Here, you can add a new theme and edit the existing one.
- Click in the top right corner. The configuration page for your Theme appears.
- Enter a meaningful name for your Theme. Additionally, you can set this theme as a default theme.
- If required, add description, change the text color, the font, and add a new background color.