- 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 icons on the Bank Selection screen (with the user having to find his/her specific branch by scrolling though a large list).
To address this issue for
SELF-HOSTED-CALLBACK users (who design their own UIs), Nuapay uses the concept of a “Bank Family”.
Rendering Banks and Bank Families on the UI
SELF-HOSTEDintegrations, is only required for EUR-based payments where banks are operating under the STET or Berlin Group specifications; GBP payments, processed under the OBIE standard, do not use bank families.
For users, who have integrated in
SELF-HOSTED-CALLBACK mode, that want to render both standalone banks and bank families (banks that have a number of linked branches) on the Bank selection screen, we recommend that you:
- Call GET
/banks(see Retrieve Banks) to load all banks and cache the result. (This call returns all standalone banks and all bank branches).
- Call GET
/bankfamilies(see below) and cache the results. Where 10 banks branches are returned from the same bank (for example), these should be filtered out so that only one bank is shown on the Bank Selection page, rather than rendering the 10 individual branches on this screen.
- The user can then select either a standalone Bank or a Bank that has associated branches.
- If the user selects a bank with associated branches then render those branches (there is no extra REST call). In this case, use the cached GET
/banksresponse and apply the
bankfamillyIdfilter to render a bank branches drop-down list.
- If the user selects a standalone bank, then no branch selection is required and the PSU is redirected to his selected bank.
When working with our APIs, please use the Sandbox URI when testing and the Live URI when you move to Production.
LIVE https://api.nuapay.com/tpp SANDBOX https://sandbox.nuapay.com/tpp
If you haven't done so already and would like to do some testing, please Request Sandbox Access
Important: Endpoints and Webhooks may be extended from time to time and any changes we make will follow our Versioning and Backward Compatibility rules. This means that the code that you write today must be designed to be robust enough to handle any future changes (where a new object is added to (or removed from) a specific API response, for example).