Implementation Guide: Yorkshire Building Society

This page has been created and maintained by the relevant ASPSP, and OBIE takes no liability for the completeness nor accuracy of this data.

Note to ASPSP: Please indicate which brands this applies to and/or duplicate this page per brand if relevant.


ASPSPYorkshire Building Society
BrandYorkshire Building Society and Chelsea Building Society
Date26/09/19
Developer portal (s)https://developers.ybs.co.uk/

Announcements

Improvement
Delivery date

Implementation of SCA for web and API interfaces

Implementation of v3.1

 

Change to Production:

Improvement
Delivery date

Implementation of SCA for web and API interfaces

Support for OBWAC and OBSEAL certificates

Version 3.1 upgrade for AISP, PISP, CBPII and Dynamic Client Registration

 




On-boarding

Supports dynamic client registration (Y/N)

Yes (v1.0 & v3.1)

Please note that the required content-type for requests is "application/jwt"

Instructions for manual onboardingNo
OIDC .well-known endpoint

Production endpoints

For Yorkshire Building Society (YBS)

https://api.ybs.co.uk/open-banking/v1.0/.well-known/ybs/openid-configuration

For the Chelsea Building Society brand (CBS)

https://api.ybs.co.uk/open-banking/v1.0/.well-known/che/openid-configuration


Test Facility endpoints

For Yorkshire Building Society

https://sandbox.ybs.co.uk/open-banking/v1.0/.well-known/ybs/openid-configuration

For the Chelsea Building Society brand
https://sandbox.ybs.co.uk/open-banking/v1.0/.well-known/che/openid-configuration


Notes on testing

The Testing Facility is loaded with a set of Sample data which is documented in the following locations.

https://developers.ybs.co.uk/account-api-sample-data

https://developers.ybs.co.uk/payment-and-standing-order-api-sample-data

https://developers.ybs.co.uk/confirmationoffunds-api-sample-data

Other on-boarding notes

YBS implementation endopints, certificate support and Security Profile details are documented in the Yorkshire Building Society Calendar

Documentation URL


Getting Started Guide

https://developers.ybs.co.uk/getting-started

API Documentation

https://developers.ybs.co.uk/apis


AISP Swagger

https://developers.ybs.co.uk/sites/default/files/Account-v3.txt

https://developers.ybs.co.uk/sites/default/files/Account-v3.1.txt

AISP additional information regarding YBS implementation and capability.

https://developers.ybs.co.uk/exceptions-account-api


PISP Swagger

https://developers.ybs.co.uk/sites/default/files/Payment-v3.txt

https://developers.ybs.co.uk/sites/default/files/Payment-v3.1.txt

PISP additional information regarding YBS implementation and capability.

https://developers.ybs.co.uk/exceptions-payment-and-standing-order-api


CBPII Swagger

https://developers.ybs.co.uk/sites/default/files/ConfirmationOfFunds-v3.1.txt

CBPII additional information regarding YBS implementation and capability.

https://developers.ybs.co.uk/confirmationoffunds-api-sample-data

Account Information API

Note to ASPSP: Please add a column per brand if relevant

Swagger versionv3.1
Base URI

YBS https://ob-ybs.api.ybs.co.uk/open-banking/v3.1/aisp

CBS https://ob-che.api.ybs.co.uk/open-banking/v3.1/aisp

General variances to specification 

Our systems log and count the number of AISP requests for each PSU within a 24 hour period measured from midnight to midnight. However, we leave it up to AISPs to declare whether the PSU is present and to count the number of access requests for each PSU in a given 24 hour period and for the AISP to operate within the stated 4 times in a 24 period limit. We believe that our implementation enables the AISP to count the number of unattended access requests in compliance with SCA-RTS Article 36(5). We have not agreed a higher frequency of access requests with any AISPs as allowed by Article 36(5)(b). A TPP can indicate to us that the customer is present by populating the x-fapi-cusotmer-ip-address header if this header is not populated the call is assumed to be unattended and will count against the quota. When the quota has been reached subsequent requests during the period will get a http response code of 429.

In day transactions will have description detail updated on the subsequent day - Transaction ID will remain consistent

Non-functional limitations

YBS do not support eIDAS certificates currently. 

RefAreaFieldAvailable (Y/N)Exception/Notes (inc details on classification codes, field limits, and field formats)





















Payment Initiation API

Swagger versionv3.1
Base URI

PISP

YBS https://ob-ybs.api.ybs.co.uk/open-banking/v3.1/pisp
CBS https://ob-che.api.ybs.co.uk/open-banking/v3.1/pisp


CBPII

YBS https://ob-ybs.api.ybs.co.uk/open-banking/v3.1/cbpii

CBS https://ob-che.api.ybs.co.uk/open-banking/v3.1/cbpii


General variances to specification

We currently require all PISP calls to be attended and check this by confirming that the x-fapi-cusotmer-ip-address header has been populated. As all payments require PSU authentication unattended payments are not possible.



Non-functional limitations

Yorkshire Building Society execute external payments on a Day +1 so payment execution will be on the day after payment initiation.

YBS do not support eIDAS certificates currently. 

RefAreaFieldAvailable (Y/N)Exception/Notes (inc details on classification codes, field limits, and field formats)















Open Data API

Swagger versionv1.0
Base URI

https://openapi-ybs.api.ybs.co.uk/open-banking/v1.0/fca-service-metrics/pca

https://openapi-che.api.ybs.co.uk/open-banking/v1.0/fca-service-metrics/pca

General variances to specification YBS have only implemented the FCA Service Metrics endpoint.
Non-functional limitations
RefAreaFieldAvailable (Y/N)Exception/Notes (inc details on classification codes, field limits, and field formats)