Using the Sandbox
After the Developer develops an Application and publishes it, the Programme Manager can create multiple instances of the Applications, called Programmes, for each of its clients. There can be a client-specific configuration and variations for each of such clients – in fact, within a Programme, for each Paylet, a configuration, called a Profile can be created. One can define multiple Profiles for a single Paylet within a Programme.
In order for a Developer to test the Application they need to do so in the context of a Programme. The OPC Sandbox is the environment that enables the Developer to create, view and manage a Programme, just as the programme manager would do, for testing purposes. A Developer can, for instance, create a Programme with one or more Corporate Identity instances and check that the Application can manage instruments for such Corporate Identities.
Accessing the Portal
- The sandbox is accessed through the Developer portal. It is assumed here that you have already registered, logged in and created an application through the Developer Portal. The URL for the developer portal is https://dev-portal.stg.openpayments.cloud/#/login. The sandbox is accessed by selecting the 'Sandbox' menu item in the menu, as illustrated below.
The default page shown when initially accessing the sandbox is the list of Programmes that may be managed.
Test Programme Management
A Programme is a manifestation of an Application with specific configurations (Profiles) typically as set for a specific client. There can be multiple Programmes for a single Application (because a single Application can be used by multiple clients). In order to test your Application you need to specify the Programme (and hence a specific configuration) against which you will be testing your Application.
Configure a Test Programme
Post login, you can view your Programmes, as a list, and can select any specific Programme. These actions are available for any specific Programme:
- Add Programme
- Manage Staging Programme
- View Profiles
If you wish to add a new Programme for testing purposes, simply select the 'Add Programme' button and fill in the fields shown below:
All fields are manadatory and validation will ensure that the Programme Code is unique and in the correct format. Once all details have been entered correctly, hit save and continue. You will be automatically redirected to the next step in the process.
We will now look at the ‘Manage Staging Programmes’:
This provides details of the Programme as set up on the staging environment (against which you as a Developer are testing). Through this screen the Developer can edit the appropriate Programme details
As described earlier a Profile holds Programme (and client) specific configuration for a Paylet as defined in the Application’s Payment Model.
The list of Profiles of a Programme can be accessed from the Profiles tab in the Programme Management section.
This is a list of Profiles, created in advance by Ixaris for your test Programme. Click on any Profile to view configuration details of a Profile:
Let’s look at the Managed Card Profile. Select ‘Manage Card Profile’ from the actions column. The profile details will be displayed on screen:
A Profile can be deactivated through the Deactivate button – once deactivated, the Profile cannot be used for creation of instances.
To add a new profile, select the add profile button available on the bottom left of the page:
On the new modal, you will be prompted to select the paylet type for the profile you want to add. Hit next to continue.
In this example ‘Managed Card’ was selected, which means the following configuration options are available:
The Profile is such that instances created from that Profile are issued under the Visa scheme, are of Virtual type (vs Plastic) and once expired, cannot be renewed (after 6 months). The single-spend configuration indicates that Virtual Cards created using with this Profile can only be used only for one purchase - the Virtual Card will be automatically blocked after a first Purchase Authorisation is received.
Once all profile details have been entered, select submit to save the new profile.
Profiles can be edited at any stage – note that only Instances created after the Profile update will have the updated configuration..
Available actions on a paylet profile include:
- Manage Profile: Update an existing Profile.
- Deactivate Profile: Deactivate a Profile.
- View Programme: View Programme details and Profiles
- View Instances: View list of all the instances created with the selected Profile