Service Provider Portal
The Service Provider portal enables the Service Provider to register and outline the service offered, and link to implemented connectors offering the same service. This will make the Service Provider available to the Programme Manager when creating and configuring a programme.
This portal gives also the ability to the Service Provider to review the associated programmes (the programmes which have this specific Service Provider configured in the profiles), and approve or reject a programme depending on its configurations.
This portal is available to the Service Provider on two different environments; staging and production. This is to help the Service Provider review the staging programmes and configurations on the staging environment and when the programme is approved, the Service Provider can monitor the live transactions on the production environment. Each portal on the available environments will offer different functionalities according to the particular environment. These differences will be outlined at a later stage when going through each functionality.
If you are a new Service Provider, you first need to register a new account by clicking on the ‘Register’ link found in the login page.
This will redirect you to the registration wizard consisting of the following:
- Step 1 - Service Provider details
- Step 2 - Service Provider compliance form
The Service Provider details are all mandatory except for the description, and will be validated upon completion of the registration wizard.
After submitting the first step, you need to provide the compliance details. These compliance fields are required for the matching of Service Provider with programme configuration and also for the static compliance checks.
When you finish inputting all the compliance details, you can click ‘Finish’ and it will automatically log you in and redirect you to the Service Provider Portal landing page.
Accessing the Portal
To log in, use one of our supported browsers to go to:
https://spportal.openpayments.cloud/# or https://spportal.stg.openpayments.cloud/#
which redirects you to the production or staging environment respectively.
(The Service Provider 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.)
You should provide the credentials specified during the registration process.
After entering your username and password, click the Login button.
To exit, click on the Logout link from the top right corner on any page.
A connector is the integration between the external 3rd party Service Provider and the OPC platform. The platform requires it to interface with the Service Provider.
To be able to view a connector, it needs to be listed in the Connector Store. Connectors in the Connector Store would have been developed separately, and then submitted and approved by the OPC Administrator.
To view the available connectors simply navigate to the ‘Connectors’ menu item and you will be redirected to the list of connectors which offer the same service as you specified during the registration.
Link and Unlink Connectors
To offer your services to the programme manager, you need to be linked to a connector. In this way, there will be an interface between OPC platform and your services.
The linking can be done from the list of connectors screen by clicking on the action ‘Link to Connector’.
Once linked, the state of the connector will change to ‘Linked’. You can then unlink it again whenever you want by clicking on the ‘Unlink from Connector’ action (the menu choice available will be automatically changed once a connector is linked).
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.
To view the list of existing programmes which are using your services, you can navigate to the ‘Programmes’ menu item. You will either see a list of programmes, or if no programme is using your services yet, you will see a note stating that no entries were found.
Review a Programme
As a Service Provider, offering services to several programmes, you are responsible to review the configurations and any compliance violations. This can be done from the programme management screen by clicking on the ‘Manage Programme’ action.
From the programme management screen, apart from the programme details, you can view a number of related components which give more insight on the programme itself. You can view the following details:
Static or Runtime Compliance Violations: If the programme’s configuration or the application model violate any compliance rules, these are shown as static violations. On the other hand, runtime violations can occur if a running transaction violates a runtime check like for example by exceeding a deposit limit. Static checks will be available on the staging environment to help you approve or reject a programme, while runtime checks are more relevant on the production environment to monitor live transactions.
Application Details: This section shows the basic details of an application.
Payment Model: This section shows all the paylet types defined in the payment model.
Profiles: The list of profiles configured for that programme.
Programme Manager Compliance Details: The compliance details filled in upon the Programme Manager registration process consisting of licenses and other information.
When a programme is in ‘Pending Approval’ state, you are responsible to approve or reject the programme depending on the available information. These actions are available either from the Programmes List screen or from the Manage Programme screen as buttons at the top right corner, as shown below.
Rejecting and approving a programme can only be done from the staging environment since a programme can only be in state ‘Pending Approval’ if it is on staging. All programmes found on the production environment are always approved before being pushed to production.
When you approve or reject a programme, its state will not be updated immediately. It remains ‘Pending Approval’ until all Service Providers have reviewed the programme. If all Service Providers approve the programme, then its state will change to ‘Approved’. Otherwise it will change to ‘Rejected’.
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. This is where the Service Provider is configured to provide a specific service depending on the paylet profile type.
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).
Let’s look at the Managed Card Profile. Select ‘Manage Profile’ from the actions column. The profile details will be displayed:
Available actions on a paylet profile include:
Manage Profile: Select this option if you wish to view the full details of a profile.
View Programmes: 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.