Resources

name path methods description
Account Information Service (AIS)
  • /accounts
  • /accounts/{account-id}
  • /accounts/{account-id}/balances
  • /accounts/{account-id}/transactions
  • /accounts/{account-id}/transactions/{transactionId}
  • /card-accounts
  • /card-accounts/{account-id}
  • /card-accounts/{account-id}/balances
  • /card-accounts/{account-id}/transactions
  • /consents
  • /consents/{consentId}
  • /consents/{consentId}/authorisations
  • /consents/{consentId}/authorisations/{authorisationId}
  • /consents/{consentId}/status
  • /custody-accounts
  • /custody-accounts/{account-id}
  • /custody-accounts/{account-id}/balances
  • /custody-accounts/{account-id}/transactions
  • /instruments
  • /instruments/search
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • POST
  • DELETE GET
  • GET POST
  • GET PUT
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • POST
The Account Information Service (AIS) offers the following services
  • Transaction reports for a given account or card account including balances if applicable.
  • Balances of a given account or card account,
  • A list of available accounts or card account,
  • Account details of a given account or card account or of the list of all accessible accounts or card account relative to a granted consent
Confirmation of Funds Service (PIIS)
  • /funds-confirmations
  • POST
Confirmation of Funds Service (PIIS) returns a confirmation of funds request at the ASPSP.
Market Order Initiation Service (MIS)
  • /market-orders
  • /market-orders/{marketorderId}
  • /market-orders/{marketorderId}/authorisations
  • /market-orders/{marketorderId}/authorisations/{authorisationId}
  • /market-orders/{marketorderId}/cancellation-authorisations
  • /market-orders/{marketorderId}/cancellation-authorisations/{authorisationId}
  • /market-orders/{marketorderId}/status
  • POST
  • DELETE GET
  • GET POST
  • GET PUT
  • GET POST
  • GET PUT
  • GET
The Description for Market Order Initiation Service (MIS) offers the following services:
  • Initiation and update of a market order request
  • Status information of a market order
OAuth2 Authentication Service
  • /oauth2/authorise
  • /oauth2/token
  • GET
  • POST

The OAuth2 protocol as used optionally for this API is defined in https://tools.ietf.org/html/rfc6749. In this section, additional requirements on the protocol are defined.

The requirements on the data exchange between the TPP and the OAuth Server of the ASPSP regarding the transport layer are identical to the data exchange requirements between TPP and the XS2A Interface.

Remark: Specifically, the requirements on using MTLS also apply to the usage of the oAUTH2 Protocoll. However, the general requirements on the application layer such as e.g. signing of Requests do not apply to the oAUTH2 messages.

The response type "code" and the grant types "authorization_code" and "refresh_token" are recommended by this specification. It is further strongly recommended to TPPs and ASPSPs to follow the security best practices.

The ASPSP is required to provide TPPs with configuration data conforming to the "OAuth 2.0 Authorisation Server Metadata" specification.

Payment Initiation Service (PIS)
  • /{payment-service}/{payment-product}
  • /{payment-service}/{payment-product}/{paymentId}
  • /{payment-service}/{payment-product}/{paymentId}/authorisations
  • /{payment-service}/{payment-product}/{paymentId}/authorisations/{authorisationId}
  • /{payment-service}/{payment-product}/{paymentId}/cancellation-authorisations
  • /{payment-service}/{payment-product}/{paymentId}/cancellation-authorisations/{authorisationId}
  • /{payment-service}/{payment-product}/{paymentId}/status
  • POST
  • DELETE GET
  • GET POST
  • GET PUT
  • GET POST
  • GET PUT
  • GET
The Description for Payment Initiation Service (PIS) offers the following services:
  • Initiation and update of a payment request
  • Status information of a payment
Signing Baskets (SBS)
  • /signing-baskets
  • /signing-baskets/{basketId}
  • /signing-baskets/{basketId}/authorisations
  • /signing-baskets/{basketId}/authorisations/{authorisationId}
  • /signing-baskets/{basketId}/status
  • POST
  • DELETE GET
  • GET POST
  • GET PUT
  • GET
Signing basket methods are used for authorising several transactions and resp. or consents with one SCA operation.
Utility
  • /utility/healthcheck
  • /utility/system-messages
  • /utility/version
  • GET
  • GET
  • GET
General services that indicate availability of the psd2 interface and backend services.