Swiss NextGen Banking API-Framework
Summary The Swiss NextGen API is based on the NextGenPSD2 *Framework Version 1.3.4* of the Berlin Group which offers a modern, open, harmonised and…
Finance & banking#openapi#financial
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Summary
The Swiss NextGen API is based on the NextGenPSD2 Framework Version 1.3.4 of the Berlin Group which offers a modern, open, harmonised and interoperable set of
Application Programming Interfaces (APIs) as the safest and most efficient way to provide data securely.
The NextGen Framework reduces XS2A complexity and costs, addresses the problem of multiple competing standards
in Europe and, aligned with the goals of the Euro Retail Payments Board,
enables European banking customers to benefit from innovative products and services ('Banking as a Service')
by granting TPPs safe and secure (authenticated and authorised) access to their bank accounts and financial data.
The Swiss edtion refines the message formats specific to Switzerland and defines some matching examples.
The possible Approaches are:
- Redirect SCA Approach
- (Not recommended by obp.ch community) OAuth SCA Approach
- (Not recommended by obp.ch community) Decoupled SCA Approach
- (Not recommended by obp.ch community) Embedded SCA Approach without SCA method
- (Not recommended by obp.ch community) Embedded SCA Approach with only one SCA method available
- (Not recommended by obp.ch community) Embedded SCA Approach with Selection of a SCA method
Not every message defined in this API definition is necessary for all approaches.
Furthermore this API definition does not differ between methods which are mandatory, conditional, or optional
Therefore for a particular implementation of a compliant API it is only necessary to support
a certain subset of the methods defined in this API definition.
**Please have a look at the implementation guidelines if you are not sure
which message has to be used for the approach you are going to use.**
Some General Remarks Related to this version of the OpenAPI Specification:
- This API definition is based on the Implementation Guidelines of the Berlin Group API.
It is not a replacement in any sense.
The main specification is (at the moment) always the Implementation Guidelines of the Berlin Group API.
- This API definition contains the REST-API for requests from the PISP to the ASPSP.
- This API definition contains the messages for all different approaches defined in the Implementation Guidelines.
- According to the OpenAPI-Specification [https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md]
"If in is "header" and the name field is "Accept", "Content-Type" or "Authorization", the parameter definition SHALL be ignored."
The element "Accept" will not be defined in this file at any place.
The elements "Content-Type" and "Authorization" are implicitly defined by the OpenApi tags "content" and "security".
- There are several predefined types which might occur in payment initiation messages,
but are not used in the standard JSON messages in the Implementation Guidelines.
Therefore they are not used in the corresponding messages in this file either.
We added them for the convenience of the user.
If there is a payment product, which needs these fields, one can easily use the predefined types.
But the ASPSP need not to accept them in general.
- **We omit the definition of all standard HTTP header elements (mandatory/optional/conditional)
except they are mentioned in the Implementation Guidelines.**
Therefore the implementer might add these in his own realisation of a comlient API in addition to the elements defined in this file.
General Remarks on Data Types
The Berlin Group definition of UTF-8 strings in context of the API have to support at least the following characters
a b c d e f g h i j k l m n o p q r s t u v w x y z
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
0 1 2 3 4 5 6 7 8 9
/ - ? : ( ) . , ' +
Space
Endpoints 34
Payment Initiation Service (PIS)
- POSTPayment initiation request
/v1/:payment-service/:payment-productThis method is used to initiate a payment at the ASPSP. Variants of payment initiation requests This method to initiate a payment initiation at the ASPSP can… - GETGet payment information
/v1/:payment-service/:payment-product/:paymentIdReturns the content of a payment object - DELETEPayment cancellation request
/v1/:payment-service/:payment-product/:paymentIdThis method initiates the cancellation of a payment. Depending on the payment-service, the payment-product and the ASPSP's implementation, this TPP call might… - GETGet payment initiation authorisation sub-resources request
/v1/:payment-service/:payment-product/:paymentId/authorisationsRead a list of all authorisation subresources IDs which have been created. This function returns an array of hyperlinks to all generated authorisation… - POSTStart the authorisation process for a payment initiation
/v1/:payment-service/:payment-product/:paymentId/authorisationsCreate an authorisation sub-resource and start the authorisation process. The message might in addition transmit authentication and authorisation related… - GETRead the SCA status of the payment authorisation
/v1/:payment-service/:payment-product/:paymentId/authorisations/:authorisationIdThis method returns the SCA status of a payment initiation's authorisation sub-resource. - PUTUpdate PSU data for payment initiation
/v1/:payment-service/:payment-product/:paymentId/authorisations/:authorisationIdThis methods updates PSU data on the authorisation resource if needed. It may authorise a payment within the Embedded SCA Approach where needed. Independently… - GETWill deliver an array of resource identifications to all generated cancellation authorisation sub-resources
/v1/:payment-service/:payment-product/:paymentId/cancellation-authorisationsRetrieve a list of all created cancellation authorisation sub-resources. - POSTStart the authorisation process for the cancellation of the addressed payment
/v1/:payment-service/:payment-product/:paymentId/cancellation-authorisationsCreates an authorisation sub-resource and start the authorisation process of the cancellation of the addressed payment. The message might in addition transmit… - GETRead the SCA status of the payment cancellation's authorisation
/v1/:payment-service/:payment-product/:paymentId/cancellation-authorisations/:authorisationIdThis method returns the SCA status of a payment initiation's authorisation sub-resource. - PUTUpdate PSU data for payment initiation cancellation
/v1/:payment-service/:payment-product/:paymentId/cancellation-authorisations/:authorisationIdThis method updates PSU data on the cancellation authorisation resource if needed. It may authorise a cancellation of the payment within the Embedded SCA… - GETPayment initiation status request
/v1/:payment-service/:payment-product/:paymentId/statusCheck the transaction status of a payment initiation.
Confirmation of Funds Service (PIIS)
- POSTConfirmation of funds request
/v1/funds-confirmationsCreates a confirmation of funds request at the ASPSP. Checks whether a specific amount is available at point of time of the request on an account linked to a…
Account Information Service (AIS)
- GETRead account list
/v1/accounts?withBalance=trueRead the identifiers of the available payment account together with booking balance information, depending on the consent granted. It is assumed that a… - GETRead account details
/v1/accounts/:account-id?withBalance=trueReads details about an account, with balances where required. It is assumed that a consent of the PSU to this access is already given and stored on the ASPSP… - GETRead balance
/v1/accounts/:account-id/balancesReads account data from a given account addressed by "account-id". Remark: This account-id can be a tokenised identification due to data protection reason… - GETRead transaction list of an account
/v1/accounts/:account-id/transactions?dateFrom=2024-01-01&dateTo=2024-01-01&entryReferenceFrom=string&bookingStatus=information&deltaList=true&withBalance=trueRead transaction reports or transaction lists of a given account ddressed by "account-id", depending on the steering parameter "bookingStatus" together with… - GETRead transaction details
/v1/accounts/:account-id/transactions/:transactionIdReads transaction details from a given transaction addressed by "transactionId" on a given account addressed by "account-id". This call is only available on… - POSTCreate consent
/v1/consentsThis method create a consent resource, defining access rights to dedicated accounts of a given PSU-ID. These accounts are addressed explicitly in the method… - GETGet consent request
/v1/consents/:consentIdReturns the content of an account information consent object. This is returning the data for the TPP especially in cases, where the consent was directly… - DELETEDelete Consent
/v1/consents/:consentIdThe TPP can delete an account information consent object if needed. - GETGet consent authorisation sub-resources request
/v1/consents/:consentId/authorisationsReturn a list of all authorisation subresources IDs which have been created. This function returns an array of hyperlinks to all generated authorisation… - POSTStart the authorisation process for a consent
/v1/consents/:consentId/authorisationsCreate an authorisation sub-resource and start the authorisation process of a consent. The message might in addition transmit authentication and authorisation… - GETRead the SCA status of the consent authorisation
/v1/consents/:consentId/authorisations/:authorisationIdThis method returns the SCA status of a consent initiation's authorisation sub-resource. - PUTUpdate PSU Data for consents
/v1/consents/:consentId/authorisations/:authorisationIdThis method update PSU data on the consents resource if needed. It may authorise a consent within the Embedded SCA Approach where needed. Independently from… - GETConsent status request
/v1/consents/:consentId/statusRead the status of an account information consent resource.
Signing Baskets Service (SBS)
- POSTCreate a signing basket resource
/v1/signing-basketsCreate a signing basket resource for authorising several transactions with one SCA method. The resource identifications of these transactions are contained in… - GETReturns the content of an signing basket object
/v1/signing-baskets/:basketIdReturns the content of a signing basket object. - DELETEDelete the signing basket
/v1/signing-baskets/:basketIdDelete the signing basket structure as long as no (partial) authorisation has yet been applied. The undlerying transactions are not affected by this deletion.… - GETGet signing basket authorisation sub-resources request
/v1/signing-baskets/:basketId/authorisationsRead a list of all authorisation subresources IDs which have been created. This function returns an array of hyperlinks to all generated authorisation… - POSTStart the authorisation process for a signing basket
/v1/signing-baskets/:basketId/authorisationsCreate an authorisation sub-resource and start the authorisation process of a signing basket. The message might in addition transmit authentication and… - GETRead the SCA status of the signing basket authorisation
/v1/signing-baskets/:basketId/authorisations/:authorisationIdThis method returns the SCA status of a signing basket's authorisation sub-resource. - PUTUpdate PSU data for signing basket
/v1/signing-baskets/:basketId/authorisations/:authorisationIdThis method update PSU data on the signing basket resource if needed. It may authorise a igning basket within the embedded SCA approach where needed.… - GETRead the status of the signing basket
/v1/signing-baskets/:basketId/statusReturns the status of a signing basket object.
API details
- Base URL
https://api.dev.openbankingproject.ch- Authentication
- A bearer token in the Authorization header
- Operations
- 34 operations on 23 pathsGET 19POST 8PUT 4DELETE 3
- Main resources
- Common Services 16Account Information Service (AIS) 13Payment Initiation Service (PIS) 12Signing Baskets Service (SBS) 8Confirmation of Funds Service (PIIS) 1
- Description format
- OpenAPI 3.0.1, API version
1.3.8_2020-12-14 - Swiss edition 1.3.8.… - Links
- Documentation · OpenAPI document · Support
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Swiss NextGen Banking API-Framework in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Swiss NextGen Banking API-Framework collection, without the publisher's secrets.
- Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Payment initiation request” (POST /v1/:payment-service/:payment-product), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Swiss NextGen Banking API-Framework?
Summary The Swiss NextGen API is based on the NextGenPSD2 *Framework Version 1.3.4* of the Berlin Group which offers a modern, open, harmonised and… It is listed under Finance & banking and has 34 endpoints.
Who publishes the Swiss NextGen Banking API-Framework?
It is listed from Openbankingproject's public API description (an OpenAPI document), not published by Openbankingproject on Swastik Codes. Anyone who controls openbankingproject.ch can claim the profile by adding a DNS TXT record.
What is the base URL of the Swiss NextGen Banking API-Framework?
Requests go to https://api.dev.openbankingproject.ch. Endpoint paths are added to this base URL.
How do I authenticate with the Swiss NextGen Banking API-Framework?
With A bearer token in the Authorization header.
How many endpoints does the Swiss NextGen Banking API-Framework have?
34 operations on 23 paths (19 GET, 8 POST, 4 PUT, 3 DELETE). The largest groups are Common Services, Account Information Service (AIS), Payment Initiation Service (PIS), Signing Baskets Service (SBS).
Is forking the Swiss NextGen Banking API-Framework free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.