The Retrieve Bank service allows you to:
- Retrieve a list of the banks participating in Open Banking.
- Filter based on
supportedcurrenciesof the bank.
The participating ASPSPs are returned in order of popularity (dynamically determined based on Nuapay PSUs’ preferences).
|Where you specify two or more value for the
In some cases a single bank may have a number of regional banks linked to it.
- Use the
bankfamilyidto filter for a specific bank family.
- Or use the
excludebankfamilyfilter to only return those banks that do not have any linked regional banks.
For more on this see View Bank Families.
This service also returns details on what the bank expects when interacting with it for PISP payments.
When working with Berlin Group banks, for example, the
PSU-ID may be required to be passed; for some banks the creditor and debtor address information must be provided; others may have a limit on the minimum and maximum allowable payments, etc.
The service returns these details in the
bankMetaData object, indicating if they are:
The following details are provided in a successful
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 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).