Reach description
The APIs listed here will let you access the Reach Directory offered by Worldline where you can retrieve information about reachable ASPSPs. Each TPP will be able to request the list of ASPSPs which the TPP is entitled to access. Worldline will take care of ASPSPs list accuracy and enrich the directory with new ASPSPs upon request from the TPP to ensure the most appropriate and complete reach for our partners.
The main information that can be received is the ASPSP name and ID, which has to be used in the AIS and PIS requests to identify the ASPSP the requests should be addressed to.
Since the TPP solutions offers a global API to reach ASPSPs which have implemented their APIs based on several standards sometimes with proprietary deviations, additional information is provided to inform the Initiating Party about specific details in order to be able to send requests to a given ASPSP successfully.
Beside some general information regarding the ASPSP some important information may be given in the Sections Details and Options of the response for the individual ASPSPs.
The Details section
can store information about:
- Specific API's, which can be SUPPORTED or UNSUPPORTED for a specific ASPSP.
- Fields within a specific API, which can be SUPPORTED, UNSUPPORTED, MANDATORY, FORBIDDEN
The Options section
The Options section is providing information regarding the way of using API endpoints for specific ASPSP similar to the Details section. But the information given here is not that specifically related a single API’s endpoint.
Example response
HTTP/1.1 200 OK
Cache-Control: no-cache,no-store
MessageCreateDateTime: 2020-08-19T10:44:36.258Z
X-Request-Id: 1af27926-08f4-4479-865a-d6dcca5d11
Pragma: no-cache
Date: Wed, 19 Aug 2020 10:44:36 GMT
Connection: keep-alive
Strict-Transport-Security: max-age=31536000 ; includeSubDomains; preload
Transfer-Encoding: chunked
Content-Type: application/json
{
"Application": "AIS",
"ASPSP": [
{
"AspspId": "6002",
"Name": ["Your Bank"],
"CountryCode": "GB",
"CategoryLabel": [],
"Details": [{"ProtocolVersion": "OB_UK_V_1_1_1"}],
"Options": [],
"BIC": "BNPADEFE"
}, {
"AspspId": "50002",
"Name": [Second Bank],
"CountryCode": "DE",
"CategoryLabel": [Retail],
"Details": [ {
"Api": "POST /psus/{psuId}/aspsps/{aspspId}/pre-authentication",
"Type": "SUPPORTED",
"ProtocolVersion": "BG_V_1_3_0"
}, {
"Api": "POST /payments",
"FieldName": "DebtorName",
"Type": "MANDATORY",
"ProtocolVersion": "BG_V_1_3_0"
}, {
"Api": "POST /payments",
"FieldName": "PaymentProduct",
"Type": "MANDATORY",
"Value": "Normal|Instant|Target2|Domestic",
"ProtocolVersion": "BG_V_1_3_0"
}],
"Options": [ {
"Key1": "PREAUTH_MANDATORY",
"Value": "1",
"Level": "INFORMATIONAL"
}],
"BIC": "DE12ZZZ123"
}
]
}