openapi: 3.1.0 info: title: Barclays Bank Ireland Account Information description: Creates a new consent at the ASPSP to indicate that the customer intends to retrieve accounts and their details through the Third Party Provider (TPP) version: v1.3.0 x-method: searched x-source: https://developer.barclays.com/api/apis/versions/696e2ef6-255f-481c-9546-4b5bda44b2e4.bdn/design?specification=oas31 x-harvested: '2026-09-04' x-harvested-note: Verbatim OpenAPI 3.1 design export from the Barclays API Exchange registry (developer.barclays.com), fetched anonymously. The untouched export is in openapi/_original/barclays-bank-ireland-account-information-openapi.json. The UK Open Banking documents carry OBIE (openbanking.org.uk) in info.contact/termsOfService because they are the OBIE standard contract as Barclays implements and publishes it — the API, the registry record and the host are Barclays'. paths: /accounts/{account-id}: get: description: Retrieve basic information of a specific account based on given account id operationId: get_accounts__account-id_ parameters: - name: PSU-IP-Address in: header description: Consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU required: false schema: type: string description: Consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU maxLength: 39 minLength: 2 pattern: ^((?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])))$ - name: X-Request-ID in: header description: ID of the request, unique to the call, as determined by the initiating party. required: true schema: type: string description: ID of the request, unique to the call, as determined by the initiating party. maxLength: 36 minLength: 36 pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - name: PSU-IP-Port in: header description: The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. required: false schema: type: string description: The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. maxLength: 10 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#\/]{1,10})$ - name: PSU-Accept in: header description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available required: false schema: type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available maxLength: 100 minLength: 1 - name: PSU-Accept-Charset in: header description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. required: false schema: type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. maxLength: 100 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#/]{1,100})$ - name: PSU-Accept-Encoding in: header description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available required: false schema: type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available maxLength: 100 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#/]{1,100})$ - name: PSU-User-Agent in: header description: The forwarded Agent header field of the HTTP request between PSU and TPP, if available. required: false schema: type: string description: The forwarded Agent header field of the HTTP request between PSU and TPP, if available. maxLength: 200 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#/]{1,200})$ - name: PSU-Accept-Language in: header description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. required: false schema: type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. maxLength: 100 minLength: 1 - name: PSU-Http-Method in: header description: 'HTTP method used at the interface between PSU and TPP, if available. Valid values are: - GET - POST - PUT - PATCH - DELETE' required: false schema: type: string description: 'HTTP method used at the interface between PSU and TPP, if available. Valid values are: - GET - POST - PUT - PATCH - DELETE ' enum: - GET - POST - PUT - PATCH - DELETE - name: PSU-Device-ID in: header description: UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependent application installation. In case of an installation identification this ID needs to be unaltered until removal from device. required: false schema: type: string description: UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependent application installation. In case of an installation identification this ID needs to be unaltered until removal from device. maxLength: 36 minLength: 36 pattern: ^(?!\s)[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - name: PSU-Geo-Location in: header description: The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available required: false schema: type: string description: The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available maxLength: 27 minLength: 23 pattern: ^(?!\s)(GEO:)[0-9]{1,3}\.[-][0-9]{6}\,[-][0-9]{1,3}\.[0-9]{6} - name: Consent-ID in: header description: Consent Id already stored on the ASPSP system required: true schema: type: string description: Consent Id already stored on the ASPSP system maxLength: 36 minLength: 36 pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - name: withBalance in: query description: Filter to fetch the list of accessible payment accounts including the booking balance, if granted by the PSU in the related consent and available by the ASPSP. required: true schema: type: boolean description: Filter to fetch the list of accessible payment accounts including the booking balance, if granted by the PSU in the related consent and available by the ASPSP. - name: account-id in: path description: This identification is denoting the addressed account. required: true schema: type: string description: This identification is denoting the addressed account. maxLength: 100 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#/]{1,100})$ responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/get_account_details_response' example: null '400': description: '' content: application/json: schema: $ref: '#/components/schemas/GetAccountsAccountIdTransactionsTransactionid400Response' example: null '401': description: '' content: application/json: schema: $ref: '#/components/schemas/GetAccountsAccountIdTransactionsTransactionid401Response' example: null '404': description: '' content: application/json: schema: $ref: '#/components/schemas/GetAccountsAccountIdTransactionsTransactionid404Response' example: null /consents/{consentId}/authorisations/{authorisationId}: get: description: Retrieves the SCA status of a consent initiation's authorisation sub-resource. operationId: get_consents__consentId__authorisations__authorisationId_ parameters: - name: PSU-IP-Address in: header description: Consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU required: false schema: type: string description: Consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU maxLength: 39 minLength: 2 pattern: ^((?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])))$ - name: X-Request-ID in: header description: ID of the request, unique to the call, as determined by the initiating party. required: true schema: type: string description: ID of the request, unique to the call, as determined by the initiating party. maxLength: 36 minLength: 36 pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - name: PSU-IP-Port in: header description: The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. required: false schema: type: string description: The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. maxLength: 10 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#\/]{1,10})$ - name: PSU-Accept in: header description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available required: false schema: type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available maxLength: 100 minLength: 1 - name: PSU-Accept-Charset in: header description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. required: false schema: type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. maxLength: 100 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#/]{1,100})$ - name: PSU-Accept-Encoding in: header description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available required: false schema: type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available maxLength: 100 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#/]{1,100})$ - name: PSU-User-Agent in: header description: The forwarded Agent header field of the HTTP request between PSU and TPP, if available. required: false schema: type: string description: The forwarded Agent header field of the HTTP request between PSU and TPP, if available. maxLength: 200 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#/]{1,200})$ - name: PSU-Accept-Language in: header description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. required: false schema: type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. maxLength: 100 minLength: 1 - name: PSU-Http-Method in: header description: 'HTTP method used at the interface between PSU and TPP, if available. Valid values are: - GET - POST - PUT - PATCH - DELETE' required: false schema: type: string description: 'HTTP method used at the interface between PSU and TPP, if available. Valid values are: - GET - POST - PUT - PATCH - DELETE ' enum: - GET - POST - PUT - PATCH - DELETE - name: PSU-Device-ID in: header description: UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependent application installation. In case of an installation identification this ID needs to be unaltered until removal from device. required: false schema: type: string description: UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependent application installation. In case of an installation identification this ID needs to be unaltered until removal from device. maxLength: 36 minLength: 36 pattern: ^(?!\s)[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - name: PSU-Geo-Location in: header description: The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available required: false schema: type: string description: The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available maxLength: 27 minLength: 23 pattern: ^(?!\s)(GEO:)[0-9]{1,3}\.[-][0-9]{6}\,[-][0-9]{1,3}\.[0-9]{6} - name: authorisationId in: path description: Resource Identification of the related SCA required: true schema: type: string description: Resource Identification of the related SCA maxLength: 2 minLength: 1 pattern: ^\d{1,2}$ - name: consentId in: path description: Consent Id required: true schema: type: string description: Consent Id maxLength: 36 minLength: 36 pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/get_consent_authorisation_details_response' example: null '400': description: '' content: application/json: schema: $ref: '#/components/schemas/GetAccountsAccountIdTransactionsTransactionid400Response' example: null '404': description: '' content: application/json: schema: $ref: '#/components/schemas/GetAccountsAccountIdTransactionsTransactionid404Response' example: null /consents/{consentId}/status: get: description: Retrieves the status of an account information consent resource operationId: get_consents__consentId__status parameters: - name: PSU-IP-Address in: header description: Consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU required: false schema: type: string description: Consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU maxLength: 39 minLength: 2 pattern: ^((?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])))$ - name: X-Request-ID in: header description: ID of the request, unique to the call, as determined by the initiating party. required: true schema: type: string description: ID of the request, unique to the call, as determined by the initiating party. maxLength: 36 minLength: 36 pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - name: PSU-IP-Port in: header description: The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. required: false schema: type: string description: The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. maxLength: 10 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#\/]{1,10})$ - name: PSU-Accept in: header description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available required: false schema: type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available maxLength: 100 minLength: 1 - name: PSU-Accept-Charset in: header description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. required: false schema: type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. maxLength: 100 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#/]{1,100})$ - name: PSU-Accept-Encoding in: header description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available required: false schema: type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available maxLength: 100 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#/]{1,100})$ - name: PSU-User-Agent in: header description: The forwarded Agent header field of the HTTP request between PSU and TPP, if available. required: false schema: type: string description: The forwarded Agent header field of the HTTP request between PSU and TPP, if available. maxLength: 200 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#/]{1,200})$ - name: PSU-Accept-Language in: header description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. required: false schema: type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. maxLength: 100 minLength: 1 - name: PSU-Http-Method in: header description: 'HTTP method used at the interface between PSU and TPP, if available. Valid values are: - GET - POST - PUT - PATCH - DELETE' required: false schema: type: string description: 'HTTP method used at the interface between PSU and TPP, if available. Valid values are: - GET - POST - PUT - PATCH - DELETE ' enum: - GET - POST - PUT - PATCH - DELETE - name: PSU-Device-ID in: header description: UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependent application installation. In case of an installation identification this ID needs to be unaltered until removal from device. required: false schema: type: string description: UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependent application installation. In case of an installation identification this ID needs to be unaltered until removal from device. maxLength: 36 minLength: 36 pattern: ^(?!\s)[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - name: PSU-Geo-Location in: header description: The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available required: false schema: type: string description: The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available maxLength: 27 minLength: 23 pattern: ^(?!\s)(GEO:)[0-9]{1,3}\.[-][0-9]{6}\,[-][0-9]{1,3}\.[0-9]{6} - name: consentId in: path description: Consent Id required: true schema: type: string description: Consent Id maxLength: 36 minLength: 36 pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/get_consent_status_response' example: null '400': description: '' content: application/json: schema: $ref: '#/components/schemas/GetAccountsAccountIdTransactionsTransactionid400Response' example: null '404': description: '' content: application/json: schema: $ref: '#/components/schemas/GetAccountsAccountIdTransactionsTransactionid404Response' example: null /consents/{consentId}/authorisations: get: description: Retrieves a list of all authorisation subresources IDs which have been created. This function returns an array of hyperlinks to all generated authorisation sub-resources. operationId: get_consents__consentId__authorisations parameters: - name: PSU-IP-Address in: header description: Consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU required: false schema: type: string description: Consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU maxLength: 39 minLength: 2 pattern: ^((?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])))$ - name: X-Request-ID in: header description: ID of the request, unique to the call, as determined by the initiating party. required: true schema: type: string description: ID of the request, unique to the call, as determined by the initiating party. maxLength: 36 minLength: 36 pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - name: PSU-IP-Port in: header description: The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. required: false schema: type: string description: The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. maxLength: 10 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#\/]{1,10})$ - name: PSU-Accept in: header description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available required: false schema: type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available maxLength: 100 minLength: 1 - name: PSU-Accept-Charset in: header description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. required: false schema: type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. maxLength: 100 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#/]{1,100})$ - name: PSU-Accept-Encoding in: header description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available required: false schema: type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available maxLength: 100 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#/]{1,100})$ - name: PSU-User-Agent in: header description: The forwarded Agent header field of the HTTP request between PSU and TPP, if available. required: false schema: type: string description: The forwarded Agent header field of the HTTP request between PSU and TPP, if available. maxLength: 200 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#/]{1,200})$ - name: PSU-Accept-Language in: header description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. required: false schema: type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. maxLength: 100 minLength: 1 - name: PSU-Http-Method in: header description: 'HTTP method used at the interface between PSU and TPP, if available. Valid values are: - GET - POST - PUT - PATCH - DELETE' required: false schema: type: string description: 'HTTP method used at the interface between PSU and TPP, if available. Valid values are: - GET - POST - PUT - PATCH - DELETE ' enum: - GET - POST - PUT - PATCH - DELETE - name: PSU-Device-ID in: header description: UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependent application installation. In case of an installation identification this ID needs to be unaltered until removal from device. required: false schema: type: string description: UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependent application installation. In case of an installation identification this ID needs to be unaltered until removal from device. maxLength: 36 minLength: 36 pattern: ^(?!\s)[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - name: PSU-Geo-Location in: header description: The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available required: false schema: type: string description: The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available maxLength: 27 minLength: 23 pattern: ^(?!\s)(GEO:)[0-9]{1,3}\.[-][0-9]{6}\,[-][0-9]{1,3}\.[0-9]{6} - name: consentId in: path description: Consent Id required: true schema: type: string description: Consent Id maxLength: 36 minLength: 36 pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/get_consent_authorisations_response' example: null '400': description: '' content: application/json: schema: $ref: '#/components/schemas/GetAccountsAccountIdTransactionsTransactionid400Response' example: null '404': description: '' content: application/json: schema: $ref: '#/components/schemas/GetAccountsAccountIdTransactionsTransactionid404Response' example: null /accounts/{account-id}/transactions: get: description: Retrieve transaction reports or transaction lists of a given account ddressed by "account-id", depending on the steering parameter "bookingStatus" together with balances operationId: get_accounts__account-id__transactions parameters: - name: PSU-IP-Address in: header description: Consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU required: false schema: type: string description: Consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU maxLength: 39 minLength: 2 pattern: ^((?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])))$ - name: X-Request-ID in: header description: ID of the request, unique to the call, as determined by the initiating party. required: true schema: type: string description: ID of the request, unique to the call, as determined by the initiating party. maxLength: 36 minLength: 36 pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - name: PSU-IP-Port in: header description: The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. required: false schema: type: string description: The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. maxLength: 10 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#\/]{1,10})$ - name: PSU-Accept in: header description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available required: false schema: type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available maxLength: 100 minLength: 1 - name: PSU-Accept-Charset in: header description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. required: false schema: type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. maxLength: 100 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#/]{1,100})$ - name: PSU-Accept-Encoding in: header description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available required: false schema: type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available maxLength: 100 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#/]{1,100})$ - name: PSU-User-Agent in: header description: The forwarded Agent header field of the HTTP request between PSU and TPP, if available. required: false schema: type: string description: The forwarded Agent header field of the HTTP request between PSU and TPP, if available. maxLength: 200 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#/]{1,200})$ - name: PSU-Accept-Language in: header description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. required: false schema: type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. maxLength: 100 minLength: 1 - name: PSU-Http-Method in: header description: 'HTTP method used at the interface between PSU and TPP, if available. Valid values are: - GET - POST - PUT - PATCH - DELETE' required: false schema: type: string description: 'HTTP method used at the interface between PSU and TPP, if available. Valid values are: - GET - POST - PUT - PATCH - DELETE ' enum: - GET - POST - PUT - PATCH - DELETE - name: PSU-Device-ID in: header description: UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependent application installation. In case of an installation identification this ID needs to be unaltered until removal from device. required: false schema: type: string description: UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependent application installation. In case of an installation identification this ID needs to be unaltered until removal from device. maxLength: 36 minLength: 36 pattern: ^(?!\s)[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - name: PSU-Geo-Location in: header description: The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available required: false schema: type: string description: The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available maxLength: 27 minLength: 23 pattern: ^(?!\s)(GEO:)[0-9]{1,3}\.[-][0-9]{6}\,[-][0-9]{1,3}\.[0-9]{6} - name: Consent-ID in: header description: Consent Id already stored on the ASPSP system required: true schema: type: string description: Consent Id already stored on the ASPSP system maxLength: 36 minLength: 36 pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - name: Accept in: header description: Accept header required: false schema: type: string description: Accept header enum: - application/json - name: bookingStatus in: query description: Filters the transactions by booking status required: true schema: type: string description: Filters the transactions by booking status enum: - booked - pending - both - information - name: dateFrom in: query description: Starting date (inclusive the date dateFrom) of the transaction list, mandated if no delta access is required.For booked transactions, the relevant date is the booking date.For pending transactions, the relevant date is the entry date, which may not be transparent neither in this API nor other channels of the ASPSP. required: false schema: type: string format: date description: Starting date (inclusive the date dateFrom) of the transaction list, mandated if no delta access is required.For booked transactions, the relevant date is the booking date.For pending transactions, the relevant date is the entry date, which may not be transparent neither in this API nor other channels of the ASPSP. - name: dateTo in: query description: End date (inclusive the data dateTo) of the transaction list, default is "now" if not given.For booked transactions, the relevant date is the booking date.For pending transactions, the relevant date is the entry date, which may not be transparent neither in this API nor other channels of the ASPSP required: false schema: type: string format: date description: End date (inclusive the data dateTo) of the transaction list, default is "now" if not given.For booked transactions, the relevant date is the booking date.For pending transactions, the relevant date is the entry date, which may not be transparent neither in this API nor other channels of the ASPSP - name: account-id in: path description: This identification is denoting the addressed account. required: true schema: type: string description: This identification is denoting the addressed account. maxLength: 100 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#/]{1,100})$ responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/get_account_transactions_response' example: null '400': description: '' content: application/json: schema: $ref: '#/components/schemas/GetAccountsAccountIdTransactionsTransactionid400Response' example: null '401': description: '' content: application/json: schema: $ref: '#/components/schemas/GetAccountsAccountIdTransactionsTransactionid401Response' example: null '404': description: '' content: application/json: schema: $ref: '#/components/schemas/GetAccountsAccountIdTransactionsTransactionid404Response' example: null /accounts/{account-id}/balances: get: description: Retrieve account balance data from a given account addressed by Account Id. operationId: get_accounts__account-id__balances parameters: - name: PSU-IP-Address in: header description: Consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU required: false schema: type: string description: Consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU maxLength: 39 minLength: 2 pattern: ^((?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])))$ - name: X-Request-ID in: header description: ID of the request, unique to the call, as determined by the initiating party. required: true schema: type: string description: ID of the request, unique to the call, as determined by the initiating party. maxLength: 36 minLength: 36 pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - name: PSU-IP-Port in: header description: The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. required: false schema: type: string description: The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. maxLength: 10 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#\/]{1,10})$ - name: PSU-Accept in: header description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available required: false schema: type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available maxLength: 100 minLength: 1 - name: PSU-Accept-Charset in: header description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. required: false schema: type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. maxLength: 100 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#/]{1,100})$ - name: PSU-Accept-Encoding in: header description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available required: false schema: type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available maxLength: 100 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#/]{1,100})$ - name: PSU-User-Agent in: header description: The forwarded Agent header field of the HTTP request between PSU and TPP, if available. required: false schema: type: string description: The forwarded Agent header field of the HTTP request between PSU and TPP, if available. maxLength: 200 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#/]{1,200})$ - name: PSU-Accept-Language in: header description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. required: false schema: type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. maxLength: 100 minLength: 1 - name: PSU-Http-Method in: header description: 'HTTP method used at the interface between PSU and TPP, if available. Valid values are: - GET - POST - PUT - PATCH - DELETE' required: false schema: type: string description: 'HTTP method used at the interface between PSU and TPP, if available. Valid values are: - GET - POST - PUT - PATCH - DELETE ' enum: - GET - POST - PUT - PATCH - DELETE - name: PSU-Device-ID in: header description: UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependent application installation. In case of an installation identification this ID needs to be unaltered until removal from device. required: false schema: type: string description: UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependent application installation. In case of an installation identification this ID needs to be unaltered until removal from device. maxLength: 36 minLength: 36 pattern: ^(?!\s)[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - name: PSU-Geo-Location in: header description: The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available required: false schema: type: string description: The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available maxLength: 27 minLength: 23 pattern: ^(?!\s)(GEO:)[0-9]{1,3}\.[-][0-9]{6}\,[-][0-9]{1,3}\.[0-9]{6} - name: Consent-ID in: header description: Consent Id already stored on the ASPSP system required: true schema: type: string description: Consent Id already stored on the ASPSP system maxLength: 36 minLength: 36 pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - name: account-id in: path description: This identification is denoting the addressed account. required: true schema: type: string description: This identification is denoting the addressed account. maxLength: 100 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#/]{1,100})$ responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/get_account_balance_details_response' example: null '400': description: '' content: application/json: schema: $ref: '#/components/schemas/GetAccountsAccountIdTransactionsTransactionid400Response' example: null '401': description: '' content: application/json: schema: $ref: '#/components/schemas/GetAccountsAccountIdTransactionsTransactionid401Response' example: null '404': description: '' content: application/json: schema: $ref: '#/components/schemas/GetAccountsAccountIdTransactionsTransactionid404Response' example: null /consents: post: description: Creates an account information consent resource at the ASPSP regarding access to accounts specified in this request. operationId: post_consents parameters: - name: PSU-IP-Address in: header description: Consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU required: false schema: type: string description: Consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU maxLength: 39 minLength: 2 pattern: ^((?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])))$ - name: X-Request-ID in: header description: ID of the request, unique to the call, as determined by the initiating party. required: true schema: type: string description: ID of the request, unique to the call, as determined by the initiating party. maxLength: 36 minLength: 36 pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - name: PSU-IP-Port in: header description: The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. required: false schema: type: string description: The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. maxLength: 10 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#\/]{1,10})$ - name: PSU-Accept in: header description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available required: false schema: type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available maxLength: 100 minLength: 1 - name: PSU-Accept-Charset in: header description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. required: false schema: type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. maxLength: 100 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#/]{1,100})$ - name: PSU-Accept-Encoding in: header description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available required: false schema: type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available maxLength: 100 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#/]{1,100})$ - name: PSU-User-Agent in: header description: The forwarded Agent header field of the HTTP request between PSU and TPP, if available. required: false schema: type: string description: The forwarded Agent header field of the HTTP request between PSU and TPP, if available. maxLength: 200 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#/]{1,200})$ - name: PSU-Accept-Language in: header description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. required: false schema: type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. maxLength: 100 minLength: 1 - name: PSU-Http-Method in: header description: 'HTTP method used at the interface between PSU and TPP, if available. Valid values are: - GET - POST - PUT - PATCH - DELETE' required: false schema: type: string description: 'HTTP method used at the interface between PSU and TPP, if available. Valid values are: - GET - POST - PUT - PATCH - DELETE ' enum: - GET - POST - PUT - PATCH - DELETE - name: PSU-Device-ID in: header description: UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependent application installation. In case of an installation identification this ID needs to be unaltered until removal from device. required: false schema: type: string description: UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependent application installation. In case of an installation identification this ID needs to be unaltered until removal from device. maxLength: 36 minLength: 36 pattern: ^(?!\s)[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - name: PSU-Geo-Location in: header description: The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available required: false schema: type: string description: The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available maxLength: 27 minLength: 23 pattern: ^(?!\s)(GEO:)[0-9]{1,3}\.[-][0-9]{6}\,[-][0-9]{1,3}\.[0-9]{6} - name: PSU-ID in: header description: Client ID of the PSU in the ASPSP client interface required: false schema: type: string description: Client ID of the PSU in the ASPSP client interface maxLength: 100 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#/]{1,100})$ - name: PSU-ID-Type in: header description: Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. required: false schema: type: string description: Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. maxLength: 100 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#/]{1,100})$ - name: PSU-Corporate-ID in: header description: Only used in a corporate context required: false schema: type: string description: Only used in a corporate context maxLength: 100 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#/]{1,100})$ - name: PSU-Corporate-ID-Type in: header description: Only used in a corporate context required: false schema: type: string description: Only used in a corporate context maxLength: 100 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#/]{1,100})$ - name: Digest in: header description: Is contained only if the "Signature" element is contained in the header of the request required: false schema: type: string description: Is contained only if the "Signature" element is contained in the header of the request maxLength: 100 minLength: 1 - name: Signature in: header description: A signature of the request by the TPP on application level. required: false schema: type: string description: A signature of the request by the TPP on application level. maxLength: 1000 minLength: 1 - name: TPP-Redirect-Preferred in: header description: 'If it equals true, the TPP prefers a Redirect over Decoupled SCA approach. If it equals false, Decoupled SCA Approach will be applied IMPORTANT - Currently, Implicit Redirect SCA Approach is supported, so TPP-Redirect-Preferred must equal true.' required: false schema: type: boolean description: 'If it equals true, the TPP prefers a Redirect over Decoupled SCA approach. If it equals false, Decoupled SCA Approach will be applied IMPORTANT - Currently, Implicit Redirect SCA Approach is supported, so TPP-Redirect-Preferred must equal true. ' - name: TPP-Redirect-URI in: header description: URI of the TPP, where the transaction flow shall be redirected to after a Redirect. It is mandatory for the Redirect SCA Approach (including OAuth2 SCA approach). required: true schema: type: string description: URI of the TPP, where the transaction flow shall be redirected to after a Redirect. It is mandatory for the Redirect SCA Approach (including OAuth2 SCA approach). maxLength: 1000 minLength: 3 - name: TPP-Nok-Redirect-URI in: header description: If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method required: false schema: type: string description: If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method maxLength: 1000 minLength: 3 - name: Content-Type in: header description: Content Type header required: true schema: type: string description: Content Type header maxLength: 100 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#/]{1,100})$ requestBody: content: application/json: schema: $ref: '#/components/schemas/create_consent_request' example: null responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/create_consent_response' example: null '400': description: '' content: application/json: schema: $ref: '#/components/schemas/GetAccountsAccountIdTransactionsTransactionid400Response' example: null '404': description: '' content: application/json: schema: $ref: '#/components/schemas/GetAccountsAccountIdTransactionsTransactionid404Response' example: null /consents/{consentId}: get: 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 re-direct SCA Approach operationId: get_consents__consentId_ parameters: - name: PSU-IP-Address in: header description: Consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU required: false schema: type: string description: Consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU maxLength: 39 minLength: 2 pattern: ^((?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])))$ - name: X-Request-ID in: header description: ID of the request, unique to the call, as determined by the initiating party. required: true schema: type: string description: ID of the request, unique to the call, as determined by the initiating party. maxLength: 36 minLength: 36 pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - name: PSU-IP-Port in: header description: The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. required: false schema: type: string description: The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. maxLength: 10 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#\/]{1,10})$ - name: PSU-Accept in: header description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available required: false schema: type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available maxLength: 100 minLength: 1 - name: PSU-Accept-Charset in: header description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. required: false schema: type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. maxLength: 100 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#/]{1,100})$ - name: PSU-Accept-Encoding in: header description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available required: false schema: type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available maxLength: 100 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#/]{1,100})$ - name: PSU-User-Agent in: header description: The forwarded Agent header field of the HTTP request between PSU and TPP, if available. required: false schema: type: string description: The forwarded Agent header field of the HTTP request between PSU and TPP, if available. maxLength: 200 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#/]{1,200})$ - name: PSU-Accept-Language in: header description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. required: false schema: type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. maxLength: 100 minLength: 1 - name: PSU-Http-Method in: header description: 'HTTP method used at the interface between PSU and TPP, if available. Valid values are: - GET - POST - PUT - PATCH - DELETE' required: false schema: type: string description: 'HTTP method used at the interface between PSU and TPP, if available. Valid values are: - GET - POST - PUT - PATCH - DELETE ' enum: - GET - POST - PUT - PATCH - DELETE - name: PSU-Device-ID in: header description: UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependent application installation. In case of an installation identification this ID needs to be unaltered until removal from device. required: false schema: type: string description: UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependent application installation. In case of an installation identification this ID needs to be unaltered until removal from device. maxLength: 36 minLength: 36 pattern: ^(?!\s)[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - name: PSU-Geo-Location in: header description: The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available required: false schema: type: string description: The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available maxLength: 27 minLength: 23 pattern: ^(?!\s)(GEO:)[0-9]{1,3}\.[-][0-9]{6}\,[-][0-9]{1,3}\.[0-9]{6} - name: consentId in: path description: Consent Id required: true schema: type: string description: Consent Id maxLength: 36 minLength: 36 pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/get_consent_details_response' example: null '400': description: '' content: application/json: schema: $ref: '#/components/schemas/GetAccountsAccountIdTransactionsTransactionid400Response' example: null '404': description: '' content: application/json: schema: $ref: '#/components/schemas/GetAccountsAccountIdTransactionsTransactionid404Response' example: null delete: description: Revoke Account Request Consent - revoke an existing consent to retrieve account details for a customer and TPP. operationId: delete_consents__consentId_ parameters: - name: PSU-IP-Address in: header description: Consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU required: false schema: type: string description: Consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU maxLength: 39 minLength: 2 pattern: ^((?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])))$ - name: X-Request-ID in: header description: ID of the request, unique to the call, as determined by the initiating party. required: true schema: type: string description: ID of the request, unique to the call, as determined by the initiating party. maxLength: 36 minLength: 36 pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - name: PSU-IP-Port in: header description: The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. required: false schema: type: string description: The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. maxLength: 10 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#\/]{1,10})$ - name: PSU-Accept in: header description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available required: false schema: type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available maxLength: 100 minLength: 1 - name: PSU-Accept-Charset in: header description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. required: false schema: type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. maxLength: 100 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#/]{1,100})$ - name: PSU-Accept-Encoding in: header description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available required: false schema: type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available maxLength: 100 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#/]{1,100})$ - name: PSU-User-Agent in: header description: The forwarded Agent header field of the HTTP request between PSU and TPP, if available. required: false schema: type: string description: The forwarded Agent header field of the HTTP request between PSU and TPP, if available. maxLength: 200 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#/]{1,200})$ - name: PSU-Accept-Language in: header description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. required: false schema: type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. maxLength: 100 minLength: 1 - name: PSU-Http-Method in: header description: 'HTTP method used at the interface between PSU and TPP, if available. Valid values are: - GET - POST - PUT - PATCH - DELETE' required: false schema: type: string description: 'HTTP method used at the interface between PSU and TPP, if available. Valid values are: - GET - POST - PUT - PATCH - DELETE ' enum: - GET - POST - PUT - PATCH - DELETE - name: PSU-Device-ID in: header description: UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependent application installation. In case of an installation identification this ID needs to be unaltered until removal from device. required: false schema: type: string description: UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependent application installation. In case of an installation identification this ID needs to be unaltered until removal from device. maxLength: 36 minLength: 36 pattern: ^(?!\s)[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - name: PSU-Geo-Location in: header description: The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available required: false schema: type: string description: The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available maxLength: 27 minLength: 23 pattern: ^(?!\s)(GEO:)[0-9]{1,3}\.[-][0-9]{6}\,[-][0-9]{1,3}\.[0-9]{6} - name: consentId in: path description: Consent Id required: true schema: type: string description: Consent Id maxLength: 36 minLength: 36 pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ responses: '400': description: '' content: application/json: schema: $ref: '#/components/schemas/GetAccountsAccountIdTransactionsTransactionid400Response' example: null '204': description: '' content: application/json: example: null '404': description: '' content: application/json: schema: $ref: '#/components/schemas/GetAccountsAccountIdTransactionsTransactionid404Response' example: null '409': description: '' content: application/json: schema: $ref: '#/components/schemas/DeleteConsentsConsentid409Response' example: null /accounts/{account-id}/transactions/{transactionId}: get: description: Retrieves the transaction details for the given transactionId Id operationId: get_accounts__account-id__transactions__transactionId_ parameters: - name: PSU-IP-Address in: header description: Consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU required: false schema: type: string description: Consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU maxLength: 39 minLength: 2 pattern: ^((?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])))$ - name: X-Request-ID in: header description: ID of the request, unique to the call, as determined by the initiating party. required: true schema: type: string description: ID of the request, unique to the call, as determined by the initiating party. maxLength: 36 minLength: 36 pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - name: PSU-IP-Port in: header description: The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. required: false schema: type: string description: The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. maxLength: 10 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#\/]{1,10})$ - name: PSU-Accept in: header description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available required: false schema: type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available maxLength: 100 minLength: 1 - name: PSU-Accept-Charset in: header description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. required: false schema: type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. maxLength: 100 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#/]{1,100})$ - name: PSU-Accept-Encoding in: header description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available required: false schema: type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available maxLength: 100 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#/]{1,100})$ - name: PSU-User-Agent in: header description: The forwarded Agent header field of the HTTP request between PSU and TPP, if available. required: false schema: type: string description: The forwarded Agent header field of the HTTP request between PSU and TPP, if available. maxLength: 200 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#/]{1,200})$ - name: PSU-Accept-Language in: header description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. required: false schema: type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. maxLength: 100 minLength: 1 - name: PSU-Http-Method in: header description: 'HTTP method used at the interface between PSU and TPP, if available. Valid values are: - GET - POST - PUT - PATCH - DELETE' required: false schema: type: string description: 'HTTP method used at the interface between PSU and TPP, if available. Valid values are: - GET - POST - PUT - PATCH - DELETE ' enum: - GET - POST - PUT - PATCH - DELETE - name: PSU-Device-ID in: header description: UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependent application installation. In case of an installation identification this ID needs to be unaltered until removal from device. required: false schema: type: string description: UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependent application installation. In case of an installation identification this ID needs to be unaltered until removal from device. maxLength: 36 minLength: 36 pattern: ^(?!\s)[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - name: PSU-Geo-Location in: header description: The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available required: false schema: type: string description: The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available maxLength: 27 minLength: 23 pattern: ^(?!\s)(GEO:)[0-9]{1,3}\.[-][0-9]{6}\,[-][0-9]{1,3}\.[0-9]{6} - name: Consent-ID in: header description: Consent Id already stored on the ASPSP system required: true schema: type: string description: Consent Id already stored on the ASPSP system maxLength: 36 minLength: 36 pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - name: transactionId in: path description: This identification is given by the attribute transactionId of the corresponding entry of a transaction list required: true schema: type: string description: This identification is given by the attribute transactionId of the corresponding entry of a transaction list maxLength: 36 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#/]{1,36})$ - name: account-id in: path description: This identification is denoting the addressed account. required: true schema: type: string description: This identification is denoting the addressed account. maxLength: 100 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#/]{1,100})$ responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/get_account_transaction_details_response' example: null '400': description: '' content: application/json: schema: $ref: '#/components/schemas/GetAccountsAccountIdTransactionsTransactionid400Response' example: null '401': description: '' content: application/json: schema: $ref: '#/components/schemas/GetAccountsAccountIdTransactionsTransactionid401Response' example: null '404': description: '' content: application/json: schema: $ref: '#/components/schemas/GetAccountsAccountIdTransactionsTransactionid404Response' example: null /accounts: get: description: Retrieves a list of bank accounts, with balances where required. It is assumed that a consent of the PSU to this access is already given and stored on the ASPSP system. operationId: get_accounts parameters: - name: PSU-IP-Address in: header description: Consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU required: false schema: type: string description: Consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU maxLength: 39 minLength: 2 pattern: ^((?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])))$ - name: X-Request-ID in: header description: ID of the request, unique to the call, as determined by the initiating party. required: true schema: type: string description: ID of the request, unique to the call, as determined by the initiating party. maxLength: 36 minLength: 36 pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - name: PSU-IP-Port in: header description: The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. required: false schema: type: string description: The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. maxLength: 10 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#\/]{1,10})$ - name: PSU-Accept in: header description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available required: false schema: type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available maxLength: 100 minLength: 1 - name: PSU-Accept-Charset in: header description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. required: false schema: type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. maxLength: 100 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#/]{1,100})$ - name: PSU-Accept-Encoding in: header description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available required: false schema: type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available maxLength: 100 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#/]{1,100})$ - name: PSU-User-Agent in: header description: The forwarded Agent header field of the HTTP request between PSU and TPP, if available. required: false schema: type: string description: The forwarded Agent header field of the HTTP request between PSU and TPP, if available. maxLength: 200 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-., '()="_@£$#/]{1,200})$ - name: PSU-Accept-Language in: header description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. required: false schema: type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. maxLength: 100 minLength: 1 - name: PSU-Http-Method in: header description: 'HTTP method used at the interface between PSU and TPP, if available. Valid values are: - GET - POST - PUT - PATCH - DELETE' required: false schema: type: string description: 'HTTP method used at the interface between PSU and TPP, if available. Valid values are: - GET - POST - PUT - PATCH - DELETE ' enum: - GET - POST - PUT - PATCH - DELETE - name: PSU-Device-ID in: header description: UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependent application installation. In case of an installation identification this ID needs to be unaltered until removal from device. required: false schema: type: string description: UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependent application installation. In case of an installation identification this ID needs to be unaltered until removal from device. maxLength: 36 minLength: 36 pattern: ^(?!\s)[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - name: PSU-Geo-Location in: header description: The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available required: false schema: type: string description: The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available maxLength: 27 minLength: 23 pattern: ^(?!\s)(GEO:)[0-9]{1,3}\.[-][0-9]{6}\,[-][0-9]{1,3}\.[0-9]{6} - name: Consent-ID in: header description: Consent Id already stored on the ASPSP system required: true schema: type: string description: Consent Id already stored on the ASPSP system maxLength: 36 minLength: 36 pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - name: withBalance in: query description: If contained, this function reads the list of accessible payment accounts including the booking balance, if granted by the PSU in the related consent and available by the ASPSP required: false schema: type: boolean description: If contained, this function reads the list of accessible payment accounts including the booking balance, if granted by the PSU in the related consent and available by the ASPSP responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/get_accounts_response' example: null '400': description: '' content: application/json: schema: $ref: '#/components/schemas/GetAccountsAccountIdTransactionsTransactionid400Response' example: null '401': description: '' content: application/json: schema: $ref: '#/components/schemas/GetAccountsAccountIdTransactionsTransactionid401Response' example: null '404': description: '' content: application/json: schema: $ref: '#/components/schemas/GetAccountsAccountIdTransactionsTransactionid404Response' example: null components: schemas: GetAccountsAccountIdTransactionsTransactionid400Response: type: object properties: code: type: string additionalErrors: type: array items: type: object properties: code: type: string detail: type: string title: type: string required: - code detail: type: string type: type: string title: type: string required: - code - type GetConsentsConsentidAuthorisationsAuthorisationid404Response: type: object properties: code: type: string additionalErrors: type: array items: type: object properties: code: type: string detail: type: string title: type: string required: - code detail: type: string type: type: string title: type: string required: - code - type get_account_details_response: type: object properties: cashAccountType: type: string resourceId: type: string balances: type: array items: type: object properties: balanceType: type: string balanceAmount: type: object properties: amount: type: string currency: type: string required: - amount - currency required: - balanceAmount - balanceType ownerName: type: string iban: type: string name: type: string currency: type: string GetAccountsAccountIdBalances400Response: type: object properties: code: type: string additionalErrors: type: array items: type: object properties: code: type: string detail: type: string title: type: string required: - code detail: type: string type: type: string title: type: string required: - code - type DeleteConsentsConsentid409Response: type: object properties: code: type: string additionalErrors: type: array items: type: object properties: code: type: string detail: type: string title: type: string required: - code detail: type: string type: type: string title: type: string required: - code - type GetAccounts404Response: type: object properties: code: type: string additionalErrors: type: array items: type: object properties: code: type: string detail: type: string title: type: string required: - code detail: type: string type: type: string title: type: string required: - code - type GetAccountsAccountId400Response: type: object properties: code: type: string additionalErrors: type: array items: type: object properties: code: type: string detail: type: string title: type: string required: - code detail: type: string type: type: string title: type: string required: - code - type create_consent_response: type: object properties: consentId: type: string _links: type: object properties: scaStatus: type: object properties: href: type: string scaRedirect: type: object properties: href: type: string self: type: object properties: href: type: string startAuthorisation: type: object properties: href: type: string status: type: object properties: href: type: string consentStatus: type: string required: - _links - consentId - consentStatus get_consent_authorisation_details_response: type: object properties: scaStatus: type: string required: - scaStatus GetAccountsAccountIdBalances401Response: type: object properties: code: type: string additionalErrors: type: array items: type: object properties: code: type: string detail: type: string title: type: string required: - code detail: type: string type: type: string title: type: string required: - code - type GetAccountsAccountIdTransactionsTransactionid404Response: type: object properties: code: type: string additionalErrors: type: array items: type: object properties: code: type: string detail: type: string title: type: string required: - code detail: type: string type: type: string title: type: string required: - code - type GetAccountsAccountId401Response: type: object properties: code: type: string additionalErrors: type: array items: type: object properties: code: type: string detail: type: string title: type: string required: - code detail: type: string type: type: string title: type: string required: - code - type GetAccountsAccountIdTransactions404Response: type: object properties: code: type: string additionalErrors: type: array items: type: object properties: code: type: string detail: type: string title: type: string required: - code detail: type: string type: type: string title: type: string required: - code - type GetConsentsConsentid400Response: type: object properties: code: type: string additionalErrors: type: array items: type: object properties: code: type: string detail: type: string title: type: string required: - code detail: type: string type: type: string title: type: string required: - code - type GetAccountsAccountIdTransactions400Response: type: object properties: code: type: string additionalErrors: type: array items: type: object properties: code: type: string detail: type: string title: type: string required: - code detail: type: string type: type: string title: type: string required: - code - type GetConsentsConsentidAuthorisationsAuthorisationid400Response: type: object properties: code: type: string additionalErrors: type: array items: type: object properties: code: type: string detail: type: string title: type: string required: - code detail: type: string type: type: string title: type: string required: - code - type GetConsentsConsentidStatus404Response: type: object properties: code: type: string additionalErrors: type: array items: type: object properties: code: type: string detail: type: string title: type: string required: - code detail: type: string type: type: string title: type: string required: - code - type DeleteConsentsConsentid400Response: type: object properties: code: type: string additionalErrors: type: array items: type: object properties: code: type: string detail: type: string title: type: string required: - code detail: type: string type: type: string title: type: string required: - code - type GetAccounts400Response: type: object properties: code: type: string additionalErrors: type: array items: type: object properties: code: type: string detail: type: string title: type: string required: - code detail: type: string type: type: string title: type: string required: - code - type GetAccounts401Response: type: object properties: code: type: string additionalErrors: type: array items: type: object properties: code: type: string detail: type: string title: type: string required: - code detail: type: string type: type: string title: type: string required: - code - type PostConsents404Response: type: object properties: code: type: string additionalErrors: type: array items: type: object properties: code: type: string detail: type: string title: type: string required: - code detail: type: string type: type: string title: type: string required: - code - type get_consent_status_response: type: object properties: consentStatus: type: string required: - consentStatus GetAccountsAccountId404Response: type: object properties: code: type: string additionalErrors: type: array items: type: object properties: code: type: string detail: type: string title: type: string required: - code detail: type: string type: type: string title: type: string required: - code - type GetAccountsAccountIdTransactions401Response: type: object properties: code: type: string additionalErrors: type: array items: type: object properties: code: type: string detail: type: string title: type: string required: - code detail: type: string type: type: string title: type: string required: - code - type GetConsentsConsentidAuthorisations400Response: type: object properties: code: type: string additionalErrors: type: array items: type: object properties: code: type: string detail: type: string title: type: string required: - code detail: type: string type: type: string title: type: string required: - code - type create_consent_request: type: object properties: access: type: object properties: balances: type: array items: type: object properties: bban: type: string maxLength: 30 minLength: 1 pattern: ^[a-zA-Z0-9]{1,30}$ iban: type: string maxLength: 34 minLength: 5 pattern: ^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$ currency: type: string maxLength: 3 minLength: 3 pattern: ^[A-Z]{3}$ maxItems: 100 minItems: 0 availableAccounts: type: string enum: - allAccounts accounts: type: array items: type: object properties: bban: type: string maxLength: 30 minLength: 1 pattern: ^[a-zA-Z0-9]{1,30}$ iban: type: string maxLength: 34 minLength: 5 pattern: ^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$ currency: type: string maxLength: 3 minLength: 3 pattern: ^[A-Z]{3}$ maxItems: 100 minItems: 0 transactions: type: array items: type: object properties: bban: type: string maxLength: 30 minLength: 1 pattern: ^[a-zA-Z0-9]{1,30}$ iban: type: string maxLength: 34 minLength: 5 pattern: ^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$ currency: type: string maxLength: 3 minLength: 3 pattern: ^[A-Z]{3}$ maxItems: 100 minItems: 0 combinedServiceIndicator: type: boolean validUntil: type: string format: date recurringIndicator: type: boolean frequencyPerDay: type: integer maximum: 9999 minimum: 1 required: - access - combinedServiceIndicator - frequencyPerDay - recurringIndicator - validUntil DeleteConsentsConsentid404Response: type: object properties: code: type: string additionalErrors: type: array items: type: object properties: code: type: string detail: type: string title: type: string required: - code detail: type: string type: type: string title: type: string required: - code - type get_accounts_response: type: object properties: accounts: type: array items: type: object properties: cashAccountType: type: string resourceId: type: string balances: type: array items: type: object properties: balanceType: type: string balanceAmount: type: object properties: amount: type: string currency: type: string required: - amount - currency required: - balanceAmount - balanceType ownerName: type: string iban: type: string name: type: string currency: type: string required: - accounts get_account_transactions_response: type: object properties: transactions: type: object properties: booked: type: array items: type: object properties: transactionAmount: type: object properties: amount: type: string currency: type: string required: - amount - currency creditorAccount: type: object properties: bban: type: string iban: type: string currency: type: string bookingDate: type: string format: date-time transactionId: type: string required: - transactionAmount pending: type: array items: type: object properties: transactionAmount: type: object properties: amount: type: string currency: type: string required: - amount - currency creditorAccount: type: object properties: bban: type: string iban: type: string currency: type: string bookingDate: type: string format: date-time transactionId: type: string required: - transactionAmount account: type: object properties: bban: type: string iban: type: string currency: type: string GetConsentsConsentidAuthorisations404Response: type: object properties: code: type: string additionalErrors: type: array items: type: object properties: code: type: string detail: type: string title: type: string required: - code detail: type: string type: type: string title: type: string required: - code - type PostConsents400Response: type: object properties: code: type: string additionalErrors: type: array items: type: object properties: code: type: string detail: type: string title: type: string required: - code detail: type: string type: type: string title: type: string required: - code - type get_account_balance_details_response: type: object properties: balances: type: array items: type: object properties: balanceType: type: string balanceAmount: type: object properties: amount: type: string currency: type: string required: - amount - currency required: - balanceAmount - balanceType account: type: object properties: bban: type: string iban: type: string currency: type: string required: - balances get_consent_details_response: type: object properties: access: type: object properties: balances: type: array items: type: object properties: bban: type: string iban: type: string currency: type: string availableAccounts: type: string accounts: type: array items: type: object properties: bban: type: string iban: type: string currency: type: string transactions: type: array items: type: object properties: bban: type: string iban: type: string currency: type: string consentStatus: type: string validUntil: type: string format: date-time recurringIndicator: type: boolean lastActionDate: type: string format: date-time frequencyPerDay: type: integer required: - access - consentStatus - frequencyPerDay - lastActionDate - recurringIndicator - validUntil GetConsentsConsentidStatus400Response: type: object properties: code: type: string additionalErrors: type: array items: type: object properties: code: type: string detail: type: string title: type: string required: - code detail: type: string type: type: string title: type: string required: - code - type GetAccountsAccountIdBalances404Response: type: object properties: code: type: string additionalErrors: type: array items: type: object properties: code: type: string detail: type: string title: type: string required: - code detail: type: string type: type: string title: type: string required: - code - type get_account_transaction_details_response: type: object properties: transactionAmount: type: object properties: amount: type: string currency: type: string required: - amount - currency creditorAccount: type: object properties: bban: type: string iban: type: string currency: type: string bookingDate: type: string format: date-time transactionId: type: string required: - transactionAmount GetConsentsConsentid404Response: type: object properties: code: type: string additionalErrors: type: array items: type: object properties: code: type: string detail: type: string title: type: string required: - code detail: type: string type: type: string title: type: string required: - code - type GetAccountsAccountIdTransactionsTransactionid401Response: type: object properties: code: type: string additionalErrors: type: array items: type: object properties: code: type: string detail: type: string title: type: string required: - code detail: type: string type: type: string title: type: string required: - code - type get_consent_authorisations_response: type: object properties: authorisationIds: type: array items: type: string required: - authorisationIds