Skip to main content

​
Scopes

  • Open Data 🌐
  • Account Information 🔒
  • Payment Initiation 🔒

​
Institutions

  • natwest
  • natwest-sandbox
  • natwestbusiness
  • natwest-clearspend
  • natwest-sandbox-vrp

​
Live Environment

If you have completed the steps below for any of the other institutions in Natwest Group (rbs, rbsbusiness, ulsterbank_uk) then you can use their existing registration credentials and manually copy them on the Yapily Console.
Precondition: To connect to live Open Banking entities, whether you are accessing account information or initiating payments, your business must have the right regulatory permissions as per the Open Banking Guide.
  1. Upload the certificates & keys (transport, signing) from Open Banking into Yapily’s certificate vault
  2. Add one of the institutions from the above list into your dashboard app and configure the institution by adding Signing Key ID from Open Banking & selecting the certificates from the drop-down. Then press next
  3. Click to register to auto-register to the bank via Yapily and auto-populate the key & secret; press save

​
Sandbox Environment

To connect to the Natwest Sandbox, select Natwest Sandbox from the pre-configured institutions. Or if you like to register with your own credentials, please follow the steps below: Steps:
  1. Register on the Natwest developer portal.
  2. Select your teams and enter your open banking organisation ID.
  3. Please create the application on the portal using client-secret authentication and assign any redirect URLS that are needed. If you require access to VRP then you need to make sure your natwest portal application has the VRP product assigned.
After creating your application, you can now copy the credentials from the institution portal to the Yapily Console. Test Account Credentials

​
VRP Sweeping Access

In order to access the VRP endpoints we have to grant your Yapily application additional scopes. If you do not have these scopes then please contact your customer success manager to get them added.
The following steps are not intended for Yapily Connect customers.
You don’t need to follow the below steps to access the sweeping feature for natwest-sandbox-vrp - the registration on Yapily Console will grant access.
Precondition: To use VRP on natwest a manual registration via API is required. Pre-requisites for Manual registration:
  • Valid OBWAC / OBSEAL certificates
  • PIS registration credentials for natwest
You can use existing PIS registration details for this institution to gain VRP sweeping access. The registration details can be found on the Yapily Console for the given application. If a new registration is required (e.g. if you are using a new redirectUri for VRP and it is not covered in the existing registration) then you can perform a DCR request using the steps outlined in Live Environment. The existing or new registration credentials from the Yapily Console will be used in the steps below.

​
Steps Required for Manual registration

  1. Upload the signing (OBSEAL) and transport (OBWAC) certificates if not already present.
You can check if the certificate is present already by navigating to the Console -> Certificates. If absent please upload the certificate. Once confirmed, we need the UUID of the certificate which can be found in the Console -> Certificates -> Certificate; the UUID will appear in the browser URL bar as follows: https://console.yapily.com/certificates/<UUID> Save the UUID and remember for which kind of key it corresponds to: e.g. SIGNING_KEY_UUID = d16f87d3-4222-4173-b8b9-44aeccacae7d Once you have done it for the signing key, repeat the process for your transport certificate.
  1. Call the manual registration endpoint
The final step is to call the manual registration endpoint with the certificate UUIDs and credentials from your PIS registration. The apiTypes field in the example has both types but if the registration in question grants PIS access only then only provide PISP. If a custom redirect URI (not Yapily’s) is used for the registration then you can provide it in the redirectUri field. The clientId field corresponds to the key field on the Yapily Console. Request 
curl --location --request POST 'https://api.yapily.com/institutions/natwest/manual/register' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Basic ...' \
     --data-raw '{
            "signingKeyID": "$SIGNING_KEY_UUID",
            "transportKeyID": "$TRANSPORT_KEY_UUID",
            "clientId": "$CLIENT_ID",
            "softwareStatementId": "$SSA_ID",
            "organisationId": "$ORGANISATION_ID",
            "apiTypes" : ["AISP", "PISP"],
            "redirectUri" : "<optional-redirect>"
            }'
Response 
{
"id": "a0460a91-4b4c-422a-bbe6-bebe0b92e308"
}
This is the Yapily registration id which can be used to Get, Modify, Delete the registration.

​
Payments

​
Bulk Payments

  • Domestic and Scheduled payments are supported
  • Maximum 15 payments per request
  • The payments should be of the same type in a request
  • Only accepts bulk payments where all creditors are trusted beneficiaries

​
Support

If you require technical support with certificate management, please contact Support.