Programme Manager Portal

The Programme Manager Portal enables the Programme Manager to create various programmes from existing applications, define different configurations for each programme and manage instances (identities, instruments and transactions), pertaining to the programmes.

This Portal is available to the Programme Managers on two different environments; staging and production. This is to help the Programme Manager test the programmes and configurations on the staging environment and when the programme is approved it can then be made available on the production environment. Each Portal on the available environments will offer different functionalities according to the particular environment. These differences will be explained at a later stage when going through each functionality.

Accessing the Portal

To log in, use one of our supported browsers to go to:
https://pm-portal.openpayments.cloud/portal/{tenantId} or https://pm-portal.stg.openpayments.cloud/portal/{tenantId}
which redirects you to the production or staging environment respectively.

(The Programme Manager Portal has been tested on the latest versions of Chrome and Firefox. The Portal might not provide you with the best experience and might have some issues on other browsers.) Please check your credentials (provided to you via an email) to find your username and tenant id.

After entering your username and password, click the Login button.

Login

To exit, click on the Logout link from the top right corner on any page.

Logout

Programme Manager Users

When a Programme Manager is created by the OPC Administrator, a root user is automatically created. If you click on the ‘Administration’ menu item and select ‘Programme Manager Users’ you will be redirected to the list of users that can login to the Portal. As you can see from the example below, the root user is created and is in an active state.

Programme Manager Users

Add User

To add a new user, select the ‘Add User’ button on the bottom left of the Programme Manager Users screen.

You will be redirected to the following screen where you will be prompted to add the user configuration:

Create Programme Manager User

All fields are mandatory and will be validated on input. To save the new user details, select the ‘Submit’ button. Confirmation will be received that the user was successfully created. On returning to the Programme Manager Users screen you will see the user you have just invited to register (with a state of ‘Invited’).

Edit User

You can edit details of a user at any time and regardless of their state (which can be one of active, inactive or invited). Simply select ‘Manage User’ from the list of available users:

Manage Programme Manager User

You will be redirected to the Manage Programme Manager User page, where you can select ‘Update Details’. You can update the name, surname and/or the email of the user.

Update Programme Manager User Details

Once you have made the changes, select ‘Save Updates’ and the updates will be applied. You will receive confirmation that the changes were successful.

Applications

Applications are built by different developers and approved by the OPC Administrator. Once an application is approved, it becomes available in the Application Store. From the Programme Manager Portal you can view this Application Store.

View Applications – The Application Store

As a Programme Manager, you can view various applications available in the Application Store which are approved by the OPC Administrator.

By clicking on the ‘Management’ menu item and selecting ‘Applications’, you will be redirected to the Applications list screen.

Applications List

Manage Application

You can view more details on a specific application by clicking on the ‘Manage Application’ action on the right hand side of each application in the table.

Manage Application

This will redirect you to the ‘Manage Application’ screen where you can see the full details of the Application selected.

View Application Details

Create Programme from Application

In order to create a programme, you need to first choose an application from the Application Store. This can be done from two different screens:

  1. The applications list action
  2. The manage application screen

From the application list, you can click on the ‘Create Programme’ action which redirects you to the programme creation wizard.

If you navigate to the Manage Application screen, you can click on the ‘Add Programme’ button on the top right corner which will also redirect you to the programme creation wizard.

In both these cases the wizard will have the application pre-selected for you. For more details on how to configure a new programme, take a look at section ‘Create a Programme’.

Service Providers

Service Providers are external 3rd parties offering payment services which are outside of our platform, to run an application. These Service Providers are banks that ultimately power the underlying payment networks and infrastructure.

The Service Providers currently supported on OPC are the Card Issuing Bank (powering the Manage Card paylet) and the Bank Transfer Service Bank (powering the External Account paylet). Additional service provider types will become available as more paylet types are added to OPC, for example the addition of the External Card paylet will automatically include the introduction of the Card Acquiring Bank service provider type.

View Service Providers

To view the list of existing Service Providers, you can navigate to the ‘Management’ menu item and select ‘Service Providers. This will redirect you to the list of Service Providers.

View Service Providers

Manage Service Providers

You can view more details on a specific Service Provider by clicking on the ‘Manage Service Provider’ action on the right hand side of each Service Provider in the table.

Manage Service Provider

This will redirect you to the ‘Manage Service Provider’ screen where you can see the full details of the provider selected. From the management screen you can also view the list of linked connectors and the list of programmes making use of this specific Service Provider.

View Connectors

A Service Provider can be linked to a number of connectors. To view the list of connectors linked to a specific Service Provider, you can either click on the ‘More Details’ link from the ‘Manager Service Provider’ screen, or else go directly to the list of connectors by clicking on the ‘View Connectors’ action from the Service Provider list.

View Connectors

Manage Connectors

To view further details on a specific connector, you can simply click on the ‘Manage Connector’ action next to each Connector.

This redirects you to the ‘Manage Connector’ screen where you are able to view the connector’s configuration and also the linked Service Providers.

Manage Connector

From the ‘Manage Connector’ screen you can view and update the connector’s configuration by clicking on the ‘Update Details’ action at the top right corner of the screen. This functionality allows you to modify the configuration as required, which is then used for every programme making use of this connector.

Programme Management

An OPC Application is composed of the Application PAML model which identifies the identities, instruments and transaction flows. These will be the basis for the application together with the interfaces and any additional logic that make the application usable by the end-users, be it UX interfaces, APIs or reports.

The application does not include any information that is pertinent to a specific installation of that application such as third-party provider selections and configurations such as fees and limits. A specific installation of the application is known as a Programme and it is the Programme that includes the required configuration within the profiles generated for that application.

View Programmes

To view the list of existing programmes, you can navigate to the ‘Management’ menu item and select ‘Programmes’. You will either see a list of programmes which you have already created, or if no programme has been created yet, you will see a note stating that no entries were found.

View Programmes

Create a Programme

If you wish to add a new programme, simply select the ‘Add Programme’ button, and you will be redirected to the programme creation wizard. Note that the functionality to add a new programme is only available on the staging environment.

The first step of the wizard consists of the following details:

Programme Creation Wizard Step 1

All fields are mandatory and validation will ensure that the Programme Code (which is a searchable version of the Programme Name), is unique and in the correct format. Once you have correctly entered all details, hit ‘Save & Continue’.

The next steps of the programme creation wizard depend solely on the PAML model of the application selected. Depending on the paylet types specified in the PAML model a step in the wizard is dynamically generated. Hence the steps that need to be configured to create a programme depend on the paylets defined in the application model.

Let us consider for example the managed card paylet. If the developer defines a managed card paylet in the model, then there will be a step in the wizard that looks like the figure below:

Managed Card Profile Creation Step

All the fields are mandatory except the ‘Tags’ field which is used for searching and can be left empty.

In this particular example the developer specified the profile cardinality in the PAML model to be ‘*’, which means that zero or more profiles can be created for this particular paylet type. Once a profile is created, you can click ‘Save & Add New Profile’, which saves the current configuration and allows you to create a new profile by providing an empty form. Another option would be that of clicking on ‘Save & Continue’ which saves the current configuration and takes you to the next step of the wizard.

If you create a profile and move to the next step, you can always click on the ‘Back’ button and go back to previous steps to modify pervious configurations.

Modify Configuration

You can select the profile you want to modify by clicking on the friendly name found on the left hand side menu and after doing the required changes, you can click ‘Save & Continue’ to proceed to the next step.

When all paylets defined in the model have been configured and the ‘Finish’ button is clicked, you will be redirected to the success screen of the wizard, providing the programme key which is to be used when performing API calls for that specific programme.

Successful Programme Creation

Manage a Programme

You will now be able to view the Programme from your Programme list. You can make changes to the configuration at any time by accessing it from this list. Note that modifications of an existing programme can only be done on the staging environment. On the production environment a programme is in read only mode.

From the list of programmes, the following actions are available:

  • Manage Programme
  • View Profiles

Programme List

We will now look at the ‘Manage Programme’:

Manage Programme

The Programme details, a summary of the application details and list of profiles related to this specific programme are shown on the page. Only the Programme details are editable and you can amend these by selecting ‘Update Details’. You will have the option to update the Technical Support Email and the Programme Name. These are the only editable fields available. Simply over type the text you wish to amend and select ‘Save Updates’.

Amend Programme Details

If you take a look at the related tabs at the bottom of the page, you can view the details of the application related to the programme. By clicking on the ‘More Details’ link at the bottom left corner of this section, you will be redirected to the ‘Manage Application’ which was explained in section ‘Manage Application’.

Manage Profiles

Profiles are required to create an instance of a paylet, as they hold all the configuration options that determine characteristics and behaviour of that instance.

To view all the profiles that are associated with the Programme, you can select the ‘Profiles’ tab on the Manage Programme screen, or you can access them directly from the actions menu (available on the Programmes screen).

Profile List

Let’s look at the Managed Card Profile. Select ‘Manage Profile’ from the actions column. The profile details will be displayed:

Managed Card Profile

Here you can choose to ‘Deactivate’ a profile. Once a profile has been deactivated, it cannot be used to create an instance of that entity. You can re-activate it at any time if required.

To add a new profile, select the ‘Add Profile’ button available on the bottom left of the Profiles page:

Profile List

Note that profiles can only be added or edited on the staging environment.

On the profile creation screen, you will be prompted to select the paylet name for the profile you want to add. Hit ‘Next’ to continue.

Add a new Profile

In this example ‘Managed Card’ was selected, which means the following configuration options are available:

Add Managed Card Profile

You can see from the figure above that cards created using this profile will be virtual and cannot be renewed when they reach expiry (6 months). The cards will be Visa branded and their classification is Corporate. As the single spend option was selected, it means the cards created using this profile can only be used for one purchase (the card will be automatically blocked after the purchase authorisation has been received).

Once all profile details have been entered, select ‘Submit’ to save the new profile.

Profiles can be edited at any time once they have been created, but please be aware, only instances that are created after the profile change will have the new characteristics.

Available actions on a paylet profile include:

Manage Profile: Select this option if you wish to edit any of the existing details of a profile. For example, for a managed card profile, you could change the default name on card.

Deactivate Profile: By deactivating a profile, it means it cannot be used to create any further instances. You can re-activate it at any time (the menu choice available will be automatically changed once a profile is deactivated).

View Programme: By selecting this option you will be re-routed to the high-level programme detail page that the profile is associated to.

View Instances: Select this option if you wish to see a list of all the instances that have been created using the specified profile.

Profile Actions

Request Programme Approval

After having tested the programme with the required configurations and created mock instruments and performed mock transactions on staging, you can now push your programme on the production environment.

However before being able to do so, the programme needs to be approved by the associated Service Providers. All the Service Providers configured in the different profiles created for this programme, need to approve the programme with its configuration and its payment model. If any Service Provider rejects the programme, then it cannot be moved to production.

You can request a programme’s approval either from the programme list by clicking on the ‘Request Approval’ action, or from the Manage Programme by clicking on the ‘Request Approval’ button on the top right corner.

Request Approval

When requesting approval, the state of the programme changes to ‘Pending Approval’, which means that no further modifications can be made to the programme or profiles of this programme. The reason for this is that the Service Providers are reviewing the programme and it needs to remain unchanged until it is pushed to production.

However if you need to perform changes before pushing to production, you can cancel the request for approval and the programme will go back to an active state. This means that any approvals from the Service Providers will be ignored and you would need to request approval once again after the changes are performed.

Cancel Request Approval

If any Service Provider rejects the programme it goes to a ‘Rejected’ state. You would need to update any configurations which did not meet the Service Provider’s requirements and request approval once again.

Push Programme to Production

When all Service Providers approve the programme, then it goes to an ‘Approved’ state. The programme will remain in read only mode and hence no modifications can be performed on the programme details and profiles.

When the programme is in an ‘Approved’ state, a new action will be available, which is that to push the programme on the production environment. This means that the programme details together with the profiles created, will be available on production as found on the staging environment.

This option can be found in the programmes list as an action ‘Push to Production’ or from the manage programme by clicking on the ‘Push to Production’ button found at the top right corner:

Push to Production

Once a programme is pushed on production, both the programme on staging and the programme on production go to an ‘Active’ state. However the programme on staging can be modified while the programme on production is read only. If a modification is required on production, it first needs to be done on staging, approved by the Service Providers and then the changes pushed to production once again. This guarantees that the production environment does not have configuration errors since every change is first tested on staging.