A detailed overview of the various steps involved in the Self-Hosted flow is provided in the image below:
To add Open Banking to your payment page you will need to carry out the following steps:
- Use your partner-level API key to retrieve a token representing the required merchant (see list of your merchants and Retrieving a Token for more on this).
- Call GET
/banksto retrieve a list of all supported banks (see Retrieve Banks) to populate your Bank Selection screen. Where banks have specific branches (bank families), you will also need to call the View Bank Families endpoint. (See the section on Bank Families below for more information on this).
- Once the payer has selected a bank, call the
/paymentsendpoint using the OAUth token, representing the required merchant, (see Create Payment). Set the
SELF_HOSTED, specify the
bankIdprovided by the payer and set the
merchantPostAuthUrl(this can be the partner or merchant URL). This will return the
aspspAuthUrl, to which you can redirect your PSU.
- Your payer interacts with the selected ASPSP to authorise the payment.
- The Nuapay TPP posts the payment ID to the partner/merchant URL (
merchantPostAuthUrl). See details of the posting below.
- Use Retrieve Payment to determine the final payment status, if required (an optional step) or, alternatively, use Webhooks.
Merchant Post-Auth URL Handling
The merchant merchantPostAuthUrl is sent as follows
The payload of this request that you need to process includes:
Please note that the ‘paymentId’ allows you to look up the payment associated with this callback.
User Interface Guidelines
- In SELF_HOSTED mode you have control over the User Interface design of your application.
- It is important that your design incorporates links to the Nuapay “Terms of Service” and “About” pages.
- These pages provide useful information to your PSUs in regard to Nuapay and our license details, as issued by the Financial Conduct Authority (in the UK) and by the ACPR (in the EU).
Please use the following links:
|Terms of Service||https://www.nuapay.com/en/openbanking-terms-of-service/|
- Some ASPSPs are individually configured with a URL and token endpoint per regional bank.
- For example Credit Agricole in France (which follows the STET specification) has 44 distinct regional banks.
- Rendering individual regional banks on a user interface is problematic as, in the Credit Agricole example, this would result in 44 individual bank options.
- In practice this would mean 44 identical icons on a Bank Selection screen (with the PSU having to find his/her specific branch by scrolling though a large list).
When designing your user interface, we recommend that you use the Retrieve Banks and the View Bank Families endpoints so that when a PSU selects a bank that has a number of regional banks (branches) linked to it, the user is provided with an option to select the required branch.
In CHECKOUT mode (i.e. where Nuapay manages the User Interface), the bank/branch selection screens are handled as follows:
- The user selects a bank that has a number of branches linked to it (in the call to Retrieve Banks,
bankfamilyIdis populated for Credit Agricole, for example).
- The bank is rendered once, as in the image below and appears like any other bank icon on screen:
- When the PSU selects this bank, a screen allowing the user to select his/her required branch is displayed:
- Once the user selects the required branch (bank family), the payment flow continues as normal.