Open Banking Sandbox

NextGenPSD2 XS2A Framework

Summary

The NextGenPSD2 Framework Version 1.3.11 offers a modern, open, harmonized and interoperable set of

Application Programming Interfaces (APIs) as the safest and most efficient way to provide data securely.

The NextGenPSD2 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 authorized) access to their bank accounts and financial data.

The possible Approaches are:

* OAuth SCA Approach

To use the Sandbox APIs, headers useCaseGroupId and useCaseId must be added to all requests.

For successful responses, refer to the table below. In the case of errors, follow the instructions provided for each specific API.

/v1/consents:

POST:
  summary: Create consent
  description: |
    This method create a consent resource, defining access rights to dedicated accounts of
    a given PSU-ID. These accounts are addressed explicitly in the method as
    parameters as a core function.

To use the Sandbox APIs, headers useCaseGroupId and useCaseId must be added to all requests.

/v1/consents/{consentId}:

GET:
  summary: Get consent request
  description: |
    Returns the content of an account information consent object.
    This is returning the data for the TPP especially in cases,
    where the consent was directly managed between ASPSP and PSU e.g. in a redirect SCA Approach.
  operationId: getConsentInformation
  tags:
    - Account Information Service (AIS)


DELETE:
  summary: Delete consent
  description: The TPP can delete an account information consent object if needed.
  operationId: deleteConsent
  tags:
    - Account Information Service (AIS)

/v1/consents/{consentId}/status:

GET:
  summary: Consent status request
  description: Read the status of an account information consent resource.
  operationId: getConsentStatus
  tags:
    - Account Information Service (AIS)

/v1/loans:

get:
  summary: Read list of loans accounts
  description: |
    Reads a list of loan accounts potentially with additional information, e.g. balance information.
    It is assumed that a consent of the PSU to this access is already given and stored on the ASPSP system.
    The addressed list of savings accounts depends then on the stored consent addressed by consentId,
    respectively the OAuth2 accesstoken.

To use the Sandbox APIs, headers useCaseGroupId and useCaseId must be added to all requests.

/v1/loans/{loan-account-id}:

get:
  summary: Read loan account details
  description: |
    Reads details about a loan account.
    It is assumed that a consent of the PSU to
    this access is already given and stored on the ASPSP system.
    The addressed details of this account depend then on the stored consent addressed by consentId,
    respectively the OAuth2 access token.

To use the Sandbox APIs, headers useCaseGroupId and useCaseId must be added to all requests.

/v1/loans/{loan-account-id}/balances:

get:
  summary: Read Loan Account Balances
  description: |
    Reads balance data from a given loan account addressed by "loan-account-id".

    The loan-account-id is constant at least throughout the lifecycle of a given consent.

To use the Sandbox APIs, headers useCaseGroupId and useCaseId must be added to all requests.

OAUTH2 Errors:

To use the Sandbox APIs, headers useCaseGroupId and useCaseId must be added to all requests.

Certificate Errors:

To use the Sandbox APIs, headers useCaseGroupId and useCaseId must be added to all requests.

Signature Errors:

To use the Sandbox APIs, headers useCaseGroupId and useCaseId must be added to all requests.