Set up a Scheme

We recommend that you use the sandbox environment for accessing the Tenant portal if you are trying to set up a Scheme for the first time.

Once you have set up an App, you effectively have a route through which a payment can process. However, most of the time you will have multiple Apps and you might want to use one App over the others for certain conditions. Duck Creek Payments Orchestrator uses Schemes to let you specify these conditions and instruct the Payments Orchestrator application on which App to use if the conditions are met.

Basically, Schemes let you define the payment options that your customers can see.

Before you Start

Before you start following this guide, you should understand the concepts related to the Payments Orchestrator application. You should also have installed the Apps (or set up Reward Groups) that you want to use with the Scheme.

Inside a Scheme

Components of a Scheme

A Scheme consists of three main components:

Component	Description
Drafts	Drafts are copies of changes made to a Scheme's setup that you have saved.
Rules	Rules let you specify the conditions within a Scheme.
Apps	Apps let you integrate with a Payment Service Provider.

Types of Schemes

As soon as you installed and configured the App(s), you will need to create a Scheme. Currently, you can create two types of Scheme within the Payments Orchestrator application:

Collect Scheme, which defines the payment options that your customers will see when they want to make a payment to you.
Payout Scheme, which defines the payment options that your customers will see when they want to receive a payment from you.

More about Drafts

At any given time, only one Draft of the Scheme can be published (or active).

When are Drafts useful?

Say you published a scheme to let your customers pay for your services using American Express cards. After a few weeks you realized that the interchange fee were just too high, so you'd like to remove American Express cards from your Collect Scheme after the end of the month.

In such case, you can remove American Express cards from your Collect Scheme and save the new setup as a Draft. When the month ends, you can unpublish (or deactivate) the current version of the Scheme and publish (or activate) the Draft version that you had saved earlier.

What are the actions related to a Draft?

Actions	Description
Add	Add as many Drafts to your scheme as required.
Publish	Publish a Draft to make that version of the Scheme setup active. The active Draft will be applied immediately and its setup will be used to process the next collection or payout.
Update	Update any Draft, excluding an active Draft. To update an active Draft, create a new Draft that mirrors the setup of the active Draft, publish that new Draft then update the primary Draft.
Delete	Delete any Draft, excluding an active Draft.

How it works?

When you are setting up a Scheme, you specify the conditions that must be met for the Payments Orchestrator application to process a payment through an App.
Whenever the Payments Orchestrator application receives a payment instruction, the application compares the payment instruction against the rules of all active Schemes.
If the payment conditions match the conditions specified in a Scheme, the Payments Orchestrator application uses the App associated with the Scheme to process the payment.

If two Rules match the payment conditions of a transaction, the Rule whose order comes before the other Rules is used to process the transaction.

How to Set Up and Publish a Scheme?

Login to your Tenant Portal.
Click Collect under Schemes menu from the left-sidebar. The Collect schemes page appears with a list of existing Schemes (if you have created them).
Click the button on the top-right corner of the page. The Collect scheme setup page appears.
In the page, you will find four sections: Details, Customer agreement settings, Scheme rules, and Apps. Fill the available fields with relevant information. Refer to the table below for more information on each field.

Section	Field	Description
The Details section holds general information about a Scheme and defines a name and a code of the Scheme.
Details	Name	Enter a name for your Scheme.
Details	Code	Enter a code for your Scheme.
The Customer agreement settings section defines how customer payment details will be handled. Newly-created schemes must have a customer agreement setting defined. If a payment method is not supported by the customer agreement setting selected, the system will present you with a dialog box with the option to cancel the selection or proceed with applying the setting.
Customer agreement settings	Single use financial instruments	When this option is selected, the following conditions apply: Financial instruments can only be successfully transacted once. After the financial instrument is successfully transacted, it is marked as Locked or Inactive depending on the financial instrumen type, preventing it from being used again. It will still contain useful metadata for the purposes of supporting future reporting, analysis, and chargebacks/refunds. When a financial instrument is associated with an Instruction, it will be marked as Locked. This prevents multiple Instructions from being created and associated with a financial instrument. If you try to create another Instruction where the financial instrument is locked, the Instruction will fail. When an Instruction has been associated with a single use agreement and the financial instrument is marked as Locked, the Instruction can be canceled and the financial instrument will be marked as Active again. There is no limit on how many times an Instruction can be created and canceled, but the financial instrument can only be used for one successful payment. Afterwards, it is marked as Locked or Inactive and cannot be used for transactions. If a transaction fails for a single use financial instrument, it will be unlocked and marked as Active. This allows you to attempt the transaction again without requiring another customer journey. After a successful transaction, the financial instrument will be marked as Locked or Inactive again. If there are five failed attempts to use a single use financial instrument, it will be marked as Inactive state to prevent indefinite attempts. This allows it to fail more quickly when being used in a feedback loop.
Customer agreement settings	Re-use financial instruments	When this option is selected, payment details will be stored in order to allow future payments to be processed by you. You can define a Client Name which will be included in the disclaimer wording during the checkout process.
The Scheme rules section lets you specify the conditions that must be met before the application can use the Apps associated with this Rule to process the transaction. You can add multiple rules to a Scheme. If two (or more) Rules meet the conditions specified in the payment instruction, the Rule whose order comes before the other Rules' will be used to process the transaction. It is the best practice to keep the Rule with the minimum and generic condition before the Rules with more specific conditions. Arrange the order of a Rule by holding the sort icon using the mouse click and dragging the Rule on top of the other.
Scheme rules	Countries	Use the dropdown list to select a country. If the payment instruction is for the country you select here, the application will further evaluate this rule to see if additional conditions are met.
Scheme rules	Currencies	Use the dropdown list to select a currency. If the payment instruction is for the currency you select here, the application will further evaluate this rule to see if additional conditions are met.
Scheme rules	Value from	Enter a numeric value or use the counter control at the right of this field to select a numeric value. If the amount in the payment instruction is greater than the amount you enter here, the application will further evaluate this rule to see if additional conditions are met.
Scheme rules	to	Enter a numeric value or use the counter control at the right of this field to select a numeric value. If the amount in the payment instruction is lesser than the amount you enter here and all other conditions are met, the application will use this rule to process the transaction.
Scheme rules: Apps		Click the button to load the Apps widget, which lets you choose from the Apps that you have installed. The chosen App will be used to route the payment, if the payment instruction matches the condition specified in the Rule.

(Optional) To add additional Rules, click on the at the bottom of the page and follow the instructions shown in step 4.
Click the Save button at the top of the page to save your Scheme as a Draft. A slide-in banner on the top of the page will notify that the Draft has been saved.

A new field, Scheme ID, will also appear on the page with randomly generated value next it. You must specify this value whenever you want to use a published version of this Scheme with a payment Instruction.
Click the Publish button on the top of the page to make this Draft available to use with payment Instructions.
A confirmation box will appear, prompting you to confirm your choice. Click Yes, publish. A slide-in banner on the top of the page will notify that the Draft has been published.

Troubleshooting

I want to publish a different Draft.

If you have saved multiple Drafts of a Scheme, you can view them by going to the Collection (or Payout) schemes page. Follow the steps below to publish a different Draft.

Goto Collect (or Payout) schemes page and find the Scheme.
Click the Edit button that you will find towards the far-right of the Scheme's name. The Collect (or Payout) scheme setup page appears.
Click the View history button. The Scheme drafts page appears.
(Optional) Click the Edit button that you will find towards the far-right of the Draft's name to ensure the correct Draft. Alternatively, use the date and time under the Last Modified column to ensure the correct Draft.
Click the Publish button.
A confirmation box will appear, prompting you to confirm your choice. Click Yes, publish. A slide-in banner on the top of the page will notify that the Draft has been published. You will also notice Published label next to the name of the Draft that has been published.

I want to remove a Rule.

Click on the remove icon on the top right corner of the Rule box to remove a Rule. When prompted to confirm your choice, Click Yes, remove rule.

I want to change a Scheme.

You can change a Scheme from Collection (or Payout) schemes page. Follow the steps below to publish a different Draft.

Goto Collect (or Payout) schemes page and find the Scheme.
Click the Edit button that you will find towards the far-right of the Scheme's name. The Collect (or Payout) scheme setup page appears.
Make the necessary changes and click the Save button.

I want to remove a Scheme.

You can't remove a Scheme that is already in use.

You can remove a Scheme from Collection (or Payout) schemes page. Follow the steps below to publish a different Draft.

Goto Collect (or Payout) schemes page and find the Scheme.
Click the Delete button that you will find towards the far-right of the Scheme's name.
A confirmation box will appear, prompting you to confirm your choice. Click Yes, delete. A slide-in banner on the top of the page will notify that the Scheme has been removed.