Adding Open Banking (Self-Hosted mode) as a payment option to your Payment Page requires configuration as outlined below. In Self-Hosted mode you must develop your own user interface.


A detailed overview of the various steps involved in the Self-Hosted flow is provided in the image below:

Self-Hosted Flow
SELF_HOSTED Partner Flow

To add Open Banking to your payment page you will need to carry out the following steps:

  1. 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).
  2. Call GET /banks to retrieve a list of all supported banks (see Retrieve Banks) to populate your Bank Selection screen.
  3. Once the payer has selected a bank, call the /payments endpoint using the OAUth token, representing the required merchant, (see Create Payment). Set the integrationType to SELF_HOSTED, specify the bankId provided 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.
  4. Your payer interacts with the selected ASPSP to authorise the payment.
  5. The Nuapay TPP posts the payment ID to the partner/merchant URL (merchantPostAuthUrl). See details of the posting below.
  6. Use Retrieve Payment to determine the final payment status, if required (an optional step) or, alternatively, use Webhooks.

merchantPostAuthUrl handling

The merchant merchantPostAuthUrl is sent as follows

The payload of this request that you need to process includes:

Headers e.g. ContentType: x-www-form-urlencoded
Body e.g. endToEndIdentification=d8e17bf1f3244e5f96a869f9661a2a6&paymentId=gabxl3knbl

Please note that the ‘paymentId’ allows you to look up the payment associated with this callback.