{ "openapi": "3.0.1", "info": { "title": "API First OBF Middleware", "description": "OBF API documentation", "contact": { "name": "OBF" }, "license": { "name": "OBF" }, "version": "0.0.1" }, "servers": [ { "url": "//localhost:8080/" } ], "tags": [ { "name": "acct-aggregator-resource", "description": "Acct Aggregator Resource" }, { "name": "cdr-banking-resource", "description": "Cdr Banking Resource" }, { "name": "consent-resource", "description": "Consent Resource" }, { "name": "gdpr-psuser-resource", "description": "Gdpr Psuser Resource" }, { "name": "gdpr-user-bank-account-resource", "description": "Gdpr User Bank Account Resource" }, { "name": "keycloakutil", "description": "keycloakutil" }, { "name": "link-account-to-user-resource", "description": "Link Account To User Resource" }, { "name": "psd-2-controller", "description": "Psd 2 Controller" }, { "name": "psuser-resource", "description": "Psuser Resource" }, { "name": "purposes-resource", "description": "Purposes Resource" }, { "name": "transaction-resource", "description": "Transaction Resource" }, { "name": "user-bank-account-resource", "description": "User Bank Account Resource" } ], "paths": { "/api/acct-aggregators": { "get": { "tags": [ "acct-aggregator-resource" ], "summary": "getAllAcctAggregators", "operationId": "getAllAcctAggregatorsUsingGET_1", "parameters": [ { "name": "Consent-ID", "in": "header", "description": "This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. ", "schema": { "type": "string" } }, { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "name": "X-Request-ID", "in": "header", "description": "ID of the request, unique to the call, as determined by the initiating party.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AcctAggregator" } } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false }, "put": { "tags": [ "acct-aggregator-resource" ], "summary": "updateAcctAggregator", "operationId": "updateAcctAggregatorUsingPUT_1", "parameters": [ { "name": "Consent-ID", "in": "header", "description": "This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. ", "schema": { "type": "string" } }, { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "name": "X-Request-ID", "in": "header", "description": "ID of the request, unique to the call, as determined by the initiating party.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "acctAggregator", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcctAggregator" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AcctAggregator" } } } }, "201": { "description": "Created", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false, "x-codegen-request-body-name": "acctAggregator" }, "post": { "tags": [ "acct-aggregator-resource" ], "summary": "createAcctAggregator", "operationId": "createAcctAggregatorUsingPOST_1", "parameters": [ { "name": "Consent-ID", "in": "header", "description": "This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. ", "schema": { "type": "string" } }, { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "name": "X-Request-ID", "in": "header", "description": "ID of the request, unique to the call, as determined by the initiating party.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "acctAggregator", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcctAggregator" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AcctAggregator" } } } }, "201": { "description": "Created", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false, "x-codegen-request-body-name": "acctAggregator" } }, "/api/acct-aggregators/calculate/{uid}": { "get": { "tags": [ "acct-aggregator-resource" ], "summary": "calAcctAggregator", "operationId": "calAcctAggregatorUsingGET_1", "parameters": [ { "name": "Consent-ID", "in": "header", "description": "This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. ", "schema": { "type": "string" } }, { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "name": "X-Request-ID", "in": "header", "description": "ID of the request, unique to the call, as determined by the initiating party.", "schema": { "type": "string", "format": "uuid" } }, { "name": "uid", "in": "path", "description": "uid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AcctAggregator" } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false } }, "/api/acct-aggregators/{id}": { "get": { "tags": [ "acct-aggregator-resource" ], "summary": "getAcctAggregator", "operationId": "getAcctAggregatorUsingGET_1", "parameters": [ { "name": "Consent-ID", "in": "header", "description": "This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. ", "schema": { "type": "string" } }, { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "name": "X-Request-ID", "in": "header", "description": "ID of the request, unique to the call, as determined by the initiating party.", "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AcctAggregator" } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false }, "delete": { "tags": [ "acct-aggregator-resource" ], "summary": "deleteAcctAggregator", "operationId": "deleteAcctAggregatorUsingDELETE_1", "parameters": [ { "name": "Consent-ID", "in": "header", "description": "This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. ", "schema": { "type": "string" } }, { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "name": "X-Request-ID", "in": "header", "description": "ID of the request, unique to the call, as determined by the initiating party.", "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": {} }, "204": { "description": "No Content", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} } }, "deprecated": false } }, "/api/berlin-group/v1.3/accounts": { "get": { "tags": [ "psd-2-controller" ], "summary": "getAccountList", "operationId": "getAccountListUsingGET_1", "parameters": [ { "name": "Consent-ID", "in": "header", "description": "This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. ", "required": true, "schema": { "type": "string" } }, { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "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", "format": "uuid" } }, { "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. This parameter might be ignored by the ASPSP. ", "allowEmptyValue": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/bgAccounts" } } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false } }, "/api/berlin-group/v1.3/accounts/{account-id}": { "get": { "tags": [ "psd-2-controller" ], "summary": "readAccountDetails", "operationId": "readAccountDetailsUsingGET_1", "parameters": [ { "name": "Consent-ID", "in": "header", "description": "This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. ", "required": true, "schema": { "type": "string" } }, { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "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", "format": "uuid" } }, { "name": "account-id", "in": "path", "description": "This identification is denoting the addressed (card) account. The account-id is retrieved by using a \"Read Account List\" or \"Read Card Account list\" call. The account-id is the \"resourceId\" attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent. ", "required": true, "schema": { "type": "string" } }, { "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. This parameter might be ignored by the ASPSP. ", "allowEmptyValue": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/bgAccounts" } } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false } }, "/api/berlin-group/v1.3/accounts/{account-id}/balances": { "get": { "tags": [ "psd-2-controller" ], "summary": "getBalances", "operationId": "getBalancesUsingGET_1", "parameters": [ { "name": "Consent-ID", "in": "header", "description": "This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. ", "required": true, "schema": { "type": "string" } }, { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "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", "format": "uuid" } }, { "name": "account-id", "in": "path", "description": "This identification is denoting the addressed (card) account. The account-id is retrieved by using a \"Read Account List\" or \"Read Card Account list\" call. The account-id is the \"resourceId\" attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent. ", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/bgBalance" } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false } }, "/api/berlin-group/v1.3/accounts/{account-id}/transactions": { "get": { "tags": [ "psd-2-controller" ], "summary": "getTransactionList", "operationId": "getTransactionListUsingGET_1", "parameters": [ { "name": "Consent-ID", "in": "header", "description": "This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. ", "required": true, "schema": { "type": "string" } }, { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "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", "format": "uuid" } }, { "name": "account-id", "in": "path", "description": "This identification is denoting the addressed (card) account. The account-id is retrieved by using a \"Read Account List\" or \"Read Card Account list\" call. The account-id is the \"resourceId\" attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent. ", "required": true, "schema": { "type": "string" } }, { "name": "bookingStatus", "in": "query", "description": "Permitted codes are * \"information\", * \"booked\", * \"pending\", and * \"both\" \"booked\" shall be supported by the ASPSP. To support the \"pending\" and \"both\" feature is optional for the ASPSP, Error code if not supported in the online banking frontend ", "required": true, "allowEmptyValue": false, "schema": { "type": "string", "enum": [ "information", "booked", "pending", "both" ] } }, { "name": "dateFrom", "in": "query", "description": "Conditional: Starting date (inclusive the date dateFrom) of the transaction list, mandated if no delta access is required and if bookingStatus does not equal \"information. 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. ", "allowEmptyValue": false, "schema": { "type": "string", "format": "date" } }, { "name": "dateTo", "in": "query", "description": "End date (inclusive the data dateTo) of the transaction list, default is \"now\" if not given. Might be ignored if a delta function is used. 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. ", "allowEmptyValue": false, "schema": { "type": "string", "format": "date" } }, { "name": "deltaList", "in": "query", "description": "This data attribute is indicating that the AISP is in favour to get all transactions after the last report access for this PSU on the addressed account. This is another implementation of a delta access-report. This delta indicator might be rejected by the ASPSP if this function is not supported. Optional if supported by API provider", "allowEmptyValue": false, "schema": { "type": "boolean" } }, { "name": "entryReferenceFrom", "in": "query", "description": "This data attribute is indicating that the AISP is in favour to get all transactions after the transaction with identification entryReferenceFrom alternatively to the above defined period. This is a implementation of a delta access. If this data element is contained, the entries \"dateFrom\" and \"dateTo\" might be ignored by the ASPSP if a delta report is supported. Optional if supported by API provider. ", "allowEmptyValue": false, "schema": { "type": "string" } }, { "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. This parameter might be ignored by the ASPSP. ", "allowEmptyValue": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BgTransactions" } } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false } }, "/api/berlin-group/v1.3/accounts/{account-id}/transactions/{transactionId}": { "get": { "tags": [ "psd-2-controller" ], "summary": "getTransactionDetails", "operationId": "getTransactionDetailsUsingGET_1", "parameters": [ { "name": "Consent-ID", "in": "header", "description": "This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. ", "required": true, "schema": { "type": "string" } }, { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "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", "format": "uuid" } }, { "name": "account-id", "in": "path", "description": "This identification is denoting the addressed (card) account. The account-id is retrieved by using a \"Read Account List\" or \"Read Card Account list\" call. The account-id is the \"resourceId\" attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent. ", "required": true, "schema": { "type": "string" } }, { "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" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BgTransactions" } } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false } }, "/api/berlin-group/v1.3/card-accounts": { "get": { "tags": [ "psd-2-controller" ], "summary": "getCardAccount", "operationId": "getCardAccountUsingGET_1", "parameters": [ { "name": "Consent-ID", "in": "header", "description": "This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. ", "required": true, "schema": { "type": "string" } }, { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "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", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BgCardAccounts" } } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false } }, "/api/berlin-group/v1.3/card-accounts/{account-id}": { "get": { "tags": [ "psd-2-controller" ], "summary": "readCardAccount", "operationId": "readCardAccountUsingGET_1", "parameters": [ { "name": "Consent-ID", "in": "header", "description": "This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. ", "required": true, "schema": { "type": "string" } }, { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "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", "format": "uuid" } }, { "name": "account-id", "in": "path", "description": "This identification is denoting the addressed (card) account. The account-id is retrieved by using a \"Read Account List\" or \"Read Card Account list\" call. The account-id is the \"resourceId\" attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent. ", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BgCardAccounts" } } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false } }, "/api/berlin-group/v1.3/card-accounts/{account-id}/balances": { "get": { "tags": [ "psd-2-controller" ], "summary": "getCardAccountBalances", "operationId": "getCardAccountBalancesUsingGET_1", "parameters": [ { "name": "Consent-ID", "in": "header", "description": "This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. ", "required": true, "schema": { "type": "string" } }, { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "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", "format": "uuid" } }, { "name": "account-id", "in": "path", "description": "This identification is denoting the addressed (card) account. The account-id is retrieved by using a \"Read Account List\" or \"Read Card Account list\" call. The account-id is the \"resourceId\" attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent. ", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/bgBalance" } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false } }, "/api/berlin-group/v1.3/card-accounts/{account-id}/transactions": { "get": { "tags": [ "psd-2-controller" ], "summary": "getCardAccountTransactionList", "operationId": "getCardAccountTransactionListUsingGET_1", "parameters": [ { "name": "Consent-ID", "in": "header", "description": "This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. ", "required": true, "schema": { "type": "string" } }, { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "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", "format": "uuid" } }, { "name": "account-id", "in": "path", "description": "This identification is denoting the addressed (card) account. The account-id is retrieved by using a \"Read Account List\" or \"Read Card Account list\" call. The account-id is the \"resourceId\" attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent. ", "required": true, "schema": { "type": "string" } }, { "name": "bookingStatus", "in": "query", "description": "Permitted codes are * \"information\", * \"booked\", * \"pending\", and * \"both\" \"booked\" shall be supported by the ASPSP. To support the \"pending\" and \"both\" feature is optional for the ASPSP, Error code if not supported in the online banking frontend ", "required": true, "allowEmptyValue": false, "schema": { "type": "string", "enum": [ "information", "booked", "pending", "both" ] } }, { "name": "dateFrom", "in": "query", "description": "Conditional: Starting date (inclusive the date dateFrom) of the transaction list, mandated if no delta access is required and if bookingStatus does not equal \"information. 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. ", "allowEmptyValue": false, "schema": { "type": "string", "format": "date" } }, { "name": "dateTo", "in": "query", "description": "End date (inclusive the data dateTo) of the transaction list, default is \"now\" if not given. Might be ignored if a delta function is used. 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. ", "allowEmptyValue": false, "schema": { "type": "string", "format": "date" } }, { "name": "deltaList", "in": "query", "description": "This data attribute is indicating that the AISP is in favour to get all transactions after the last report access for this PSU on the addressed account. This is another implementation of a delta access-report. This delta indicator might be rejected by the ASPSP if this function is not supported. Optional if supported by API provider", "allowEmptyValue": false, "schema": { "type": "boolean" } }, { "name": "entryReferenceFrom", "in": "query", "description": "This data attribute is indicating that the AISP is in favour to get all transactions after the transaction with identification entryReferenceFrom alternatively to the above defined period. This is a implementation of a delta access. If this data element is contained, the entries \"dateFrom\" and \"dateTo\" might be ignored by the ASPSP if a delta report is supported. Optional if supported by API provider. ", "allowEmptyValue": false, "schema": { "type": "string" } }, { "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. This parameter might be ignored by the ASPSP. ", "allowEmptyValue": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BgTransactions" } } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false } }, "/api/berlin-group/v1.3/consents": { "post": { "tags": [ "psd-2-controller" ], "summary": "createConsent", "operationId": "createConsentUsingPOST_3", "parameters": [ { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-Corporate-ID", "in": "header", "description": "Might be mandated in the ASPSP's documentation. Only used in a corporate context. ", "schema": { "type": "string" } }, { "name": "PSU-Corporate-ID-Type", "in": "header", "description": "Might be mandated in the ASPSP's documentation. Only used in a corporate context. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-ID", "in": "header", "description": "Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. It might be contained even if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session. In this case the ASPSP might check whether PSU-ID and token match, according to ASPSP documentation. ", "schema": { "type": "string" } }, { "name": "PSU-ID-Type", "in": "header", "description": "Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. In this case, the mean and use are then defined in the ASPSP’s documentation. ", "schema": { "type": "string" } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. If not available, the TPP shall use the IP Address used by the TPP when submitting this request. ", "required": true, "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Brand-Logging-Information", "in": "header", "description": "This header might be used by TPPs to inform the ASPSP about the brand used by the TPP towards the PSU. This information is meant for logging entries to enhance communication between ASPSP and PSU or ASPSP and TPP. This header might be ignored by the ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Explicit-Authorisation-Preferred", "in": "header", "description": "If it equals \"true\", the TPP prefers to start the authorisation process separately, e.g. because of the usage of a signing basket. This preference might be ignored by the ASPSP, if a signing basket is not supported as functionality. If it equals \"false\" or if the parameter is not used, there is no preference of the TPP. This especially indicates that the TPP assumes a direct authorisation of the transaction in the next step, without using a signing basket. ", "schema": { "type": "boolean" } }, { "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. This might be ignored by the ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Notification-Content-Preferred", "in": "header", "description": "The string has the form status=X1, ..., Xn where Xi is one of the constants SCA, PROCESS, LAST and where constants are not repeated. The usage of the constants supports the of following semantics: SCA: A notification on every change of the scaStatus attribute for all related authorisation processes is preferred by the TPP. PROCESS: A notification on all changes of consentStatus or transactionStatus attributes is preferred by the TPP. LAST: Only a notification on the last consentStatus or transactionStatus as available in the XS2A interface is preferred by the TPP. This header field may be ignored, if the ASPSP does not support resource notification services for the related TPP. ", "schema": { "type": "string" } }, { "name": "TPP-Notification-URI", "in": "header", "description": "URI for the Endpoint of the TPP-API to which the status of the payment initiation should be sent. This header field may by ignored by the ASPSP. For security reasons, it shall be ensured that the TPP-Notification-URI as introduced above is secured by the TPP eIDAS QWAC used for identification of the TPP. The following applies: URIs which are provided by TPPs in TPP-Notification-URI shall comply with the domain secured by the eIDAS QWAC certificate of the TPP in the field CN or SubjectAltName of the certificate. Please note that in case of example-TPP.com as certificate entry TPP- Notification-URI like www.example-TPP.com/xs2a-client/v1/ASPSPidentifcation/mytransaction- id/notifications or notifications.example-TPP.com/xs2a-client/v1/ASPSPidentifcation/mytransaction- id/notifications would be compliant. Wildcard definitions shall be taken into account for compliance checks by the ASPSP. ASPSPs may respond with ASPSP-Notification-Support set to false, if the provided URIs do not comply. ", "schema": { "type": "string" } }, { "name": "TPP-Redirect-Preferred", "in": "header", "description": "If it equals \"true\", the TPP prefers a redirect over an embedded SCA approach. If it equals \"false\", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled SCA approach, depending on the choice of the SCA procedure by the TPP/PSU. If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the SCA method chosen by the TPP/PSU. ", "schema": { "type": "boolean" } }, { "name": "TPP-Redirect-URI", "in": "header", "description": "URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach, specifically when TPP-Redirect-Preferred equals \"true\". It is recommended to always use this header field. **Remark for Future:** This field might be changed to mandatory in the next version of the specification. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "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", "format": "uuid" } } ], "requestBody": { "description": "Request body for a consents request. ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BgConsents" } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/BgConsentResponse" } } } }, "201": { "description": "Created", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false, "x-codegen-request-body-name": "body" } }, "/api/berlin-group/v1.3/consents/{consentId}": { "get": { "tags": [ "psd-2-controller" ], "summary": "getConsentInformation", "operationId": "getConsentInformationUsingGET_1", "parameters": [ { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "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", "format": "uuid" } }, { "name": "consentId", "in": "path", "description": "ID of the corresponding consent object as returned by an account information consent request. ", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/OptionalOfBgConsents" } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false }, "delete": { "tags": [ "psd-2-controller" ], "summary": "deleteConsent", "operationId": "deleteConsentUsingDELETE_3", "parameters": [ { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "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", "format": "uuid" } }, { "name": "consentId", "in": "path", "description": "ID of the corresponding consent object as returned by an account information consent request. ", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "No Content", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} } }, "deprecated": false } }, "/api/berlin-group/v1.3/consents/{consentId}/authorisations": { "get": { "tags": [ "psd-2-controller" ], "summary": "getConsentAuthorisation", "operationId": "getConsentAuthorisationUsingGET_1", "parameters": [ { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "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", "format": "uuid" } }, { "name": "consentId", "in": "path", "description": "ID of the corresponding consent object as returned by an account information consent request. ", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BgConsentAuthorisation" } } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false }, "post": { "tags": [ "psd-2-controller" ], "summary": "startConsentAuthorisation", "operationId": "startConsentAuthorisationUsingPOST_1", "parameters": [ { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-Corporate-ID", "in": "header", "description": "Might be mandated in the ASPSP's documentation. Only used in a corporate context. ", "schema": { "type": "string" } }, { "name": "PSU-Corporate-ID-Type", "in": "header", "description": "Might be mandated in the ASPSP's documentation. Only used in a corporate context. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-ID", "in": "header", "description": "Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. It might be contained even if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session. In this case the ASPSP might check whether PSU-ID and token match, according to ASPSP documentation. ", "schema": { "type": "string" } }, { "name": "PSU-ID-Type", "in": "header", "description": "Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. In this case, the mean and use are then defined in the ASPSP’s documentation. ", "schema": { "type": "string" } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "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. This might be ignored by the ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Notification-Content-Preferred", "in": "header", "description": "The string has the form status=X1, ..., Xn where Xi is one of the constants SCA, PROCESS, LAST and where constants are not repeated. The usage of the constants supports the of following semantics: SCA: A notification on every change of the scaStatus attribute for all related authorisation processes is preferred by the TPP. PROCESS: A notification on all changes of consentStatus or transactionStatus attributes is preferred by the TPP. LAST: Only a notification on the last consentStatus or transactionStatus as available in the XS2A interface is preferred by the TPP. This header field may be ignored, if the ASPSP does not support resource notification services for the related TPP. ", "schema": { "type": "string" } }, { "name": "TPP-Notification-URI", "in": "header", "description": "URI for the Endpoint of the TPP-API to which the status of the payment initiation should be sent. This header field may by ignored by the ASPSP. For security reasons, it shall be ensured that the TPP-Notification-URI as introduced above is secured by the TPP eIDAS QWAC used for identification of the TPP. The following applies: URIs which are provided by TPPs in TPP-Notification-URI shall comply with the domain secured by the eIDAS QWAC certificate of the TPP in the field CN or SubjectAltName of the certificate. Please note that in case of example-TPP.com as certificate entry TPP- Notification-URI like www.example-TPP.com/xs2a-client/v1/ASPSPidentifcation/mytransaction- id/notifications or notifications.example-TPP.com/xs2a-client/v1/ASPSPidentifcation/mytransaction- id/notifications would be compliant. Wildcard definitions shall be taken into account for compliance checks by the ASPSP. ASPSPs may respond with ASPSP-Notification-Support set to false, if the provided URIs do not comply. ", "schema": { "type": "string" } }, { "name": "TPP-Redirect-Preferred", "in": "header", "description": "If it equals \"true\", the TPP prefers a redirect over an embedded SCA approach. If it equals \"false\", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled SCA approach, depending on the choice of the SCA procedure by the TPP/PSU. If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the SCA method chosen by the TPP/PSU. ", "schema": { "type": "boolean" } }, { "name": "TPP-Redirect-URI", "in": "header", "description": "URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach, specifically when TPP-Redirect-Preferred equals \"true\". It is recommended to always use this header field. **Remark for Future:** This field might be changed to mandatory in the next version of the specification. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "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", "format": "uuid" } }, { "name": "consentId", "in": "path", "description": "ID of the corresponding consent object as returned by an account information consent request. ", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "body", "content": { "application/json": { "schema": { "type": "string" } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/BgConsentAuthorisation" } } } }, "201": { "description": "Created", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false, "x-codegen-request-body-name": "body" } }, "/api/berlin-group/v1.3/consents/{consentId}/authorisations/{authorisationId}": { "get": { "tags": [ "psd-2-controller" ], "summary": "getConsentScaStatus", "operationId": "getConsentScaStatusUsingGET_1", "parameters": [ { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "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", "format": "uuid" } }, { "name": "authorisationId", "in": "path", "description": "Resource identification of the related SCA.", "required": true, "schema": { "type": "string" } }, { "name": "consentId", "in": "path", "description": "ID of the corresponding consent object as returned by an account information consent request. ", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/BgConsentAuthorisation" } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false } }, "/api/berlin-group/v1.3/consents/{consentId}/status": { "get": { "tags": [ "psd-2-controller" ], "summary": "getConsentStatus", "operationId": "getConsentStatusUsingGET_1", "parameters": [ { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "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", "format": "uuid" } }, { "name": "consentId", "in": "path", "description": "ID of the corresponding consent object as returned by an account information consent request. ", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false } }, "/api/cds-au/v1/banking/accounts": { "get": { "tags": [ "cdr-banking-resource" ], "summary": "listAccounts", "operationId": "listAccountsUsingGET_1", "parameters": [ { "name": "is-owned", "in": "query", "description": "Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and absent for all accounts", "allowEmptyValue": false, "schema": { "type": "boolean" } }, { "name": "open-status", "in": "query", "description": "Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed", "allowEmptyValue": false, "schema": { "type": "string", "default": "ALL", "enum": [ "OPEN", "CLOSED", "ALL" ] } }, { "name": "page", "in": "query", "description": "Page of results to request (standard pagination)", "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "page-size", "in": "query", "description": "Page size to request. Default is 25 (standard pagination)", "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32", "default": 25 } }, { "name": "product-category", "in": "query", "description": "Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned.", "allowEmptyValue": false, "schema": { "type": "string", "enum": [ "BUSINESS_LOANS", "CRED_AND_CHRG_CARDS", "LEASES", "MARGIN_LOANS", "OVERDRAFTS", "PERS_LOANS", "REGULATED_TRUST_ACCOUNTS", "RESIDENTIAL_MORTGAGES", "TERM_DEPOSITS", "TRADE_FINANCE", "TRAVEL_CARDS", "TRANS_AND_SAVINGS_ACCOUNTS" ] } }, { "name": "x-cds-client-headers", "in": "header", "description": "The customer's original standard http headers [Base64](#common-field-types) encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.", "schema": { "type": "string" } }, { "name": "x-fapi-auth-date", "in": "header", "description": "The time when the customer last logged in to the data recipient. Required for all resource calls (customer present and unattended). Not to be included for unauthenticated calls.", "schema": { "type": "string" } }, { "name": "x-fapi-customer-ip-address", "in": "header", "description": "The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.", "schema": { "type": "string" } }, { "name": "x-fapi-interaction-id", "in": "header", "description": "An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.", "schema": { "type": "string" } }, { "name": "x-min-v", "in": "header", "description": "Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.", "schema": { "type": "string" } }, { "name": "x-v", "in": "header", "description": "Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Accounts" } } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false } }, "/api/cds-au/v1/banking/accounts/{accountId}": { "get": { "tags": [ "cdr-banking-resource" ], "summary": "getAccountDetail", "operationId": "getAccountDetailUsingGET_1", "parameters": [ { "name": "accountId", "in": "path", "description": "A tokenised identifier for the account which is unique but not shareable", "required": true, "schema": { "type": "string" } }, { "name": "x-cds-client-headers", "in": "header", "description": "The customer's original standard http headers [Base64](#common-field-types) encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.", "schema": { "type": "string" } }, { "name": "x-fapi-auth-date", "in": "header", "description": "The time when the customer last logged in to the data recipient. Required for all resource calls (customer present and unattended). Not to be included for unauthenticated calls.", "schema": { "type": "string" } }, { "name": "x-fapi-customer-ip-address", "in": "header", "description": "The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.", "schema": { "type": "string" } }, { "name": "x-fapi-interaction-id", "in": "header", "description": "An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.", "schema": { "type": "string" } }, { "name": "x-min-v", "in": "header", "description": "Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.", "schema": { "type": "string" } }, { "name": "x-v", "in": "header", "description": "Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Accounts" } } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false } }, "/api/cds-au/v1/banking/products": { "get": { "tags": [ "cdr-banking-resource" ], "summary": "listProducts", "operationId": "listProductsUsingGET_1", "parameters": [ { "name": "brand", "in": "query", "description": "Filter results based on a specific brand", "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "effective", "in": "query", "description": "Allows for the filtering of products based on whether the current time is within the period of time defined as effective by the effectiveFrom and effectiveTo fields. Valid values are ‘CURRENT’, ‘FUTURE’ and ‘ALL’. If absent defaults to 'CURRENT'", "allowEmptyValue": false, "schema": { "type": "string", "default": "CURRENT", "enum": [ "CURRENT", "FUTURE", "ALL" ] } }, { "name": "page", "in": "query", "description": "Page of results to request (standard pagination)", "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "page-size", "in": "query", "description": "Page size to request. Default is 25 (standard pagination)", "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32", "default": 25 } }, { "name": "product-category", "in": "query", "description": "Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned.", "allowEmptyValue": false, "schema": { "type": "string", "enum": [ "BUSINESS_LOANS", "CRED_AND_CHRG_CARDS", "LEASES", "MARGIN_LOANS", "OVERDRAFTS", "PERS_LOANS", "REGULATED_TRUST_ACCOUNTS", "RESIDENTIAL_MORTGAGES", "TERM_DEPOSITS", "TRADE_FINANCE", "TRAVEL_CARDS", "TRANS_AND_SAVINGS_ACCOUNTS" ] } }, { "name": "updated-since", "in": "query", "description": "Only include products that have been updated after the specified date and time. If absent defaults to include all products", "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "x-min-v", "in": "header", "description": "Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.", "schema": { "type": "string" } }, { "name": "x-v", "in": "header", "description": "Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Products" } } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false } }, "/api/cds-au/v1/banking/products/{productId}": { "get": { "tags": [ "cdr-banking-resource" ], "summary": "getProductDetail", "operationId": "getProductDetailUsingGET_1", "parameters": [ { "name": "productId", "in": "path", "description": "ID of the specific product requested", "required": true, "schema": { "type": "string" } }, { "name": "x-min-v", "in": "header", "description": "Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.", "schema": { "type": "string" } }, { "name": "x-v", "in": "header", "description": "Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Products" } } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false } }, "/api/consents": { "get": { "tags": [ "consent-resource" ], "summary": "getAllConsents", "operationId": "getAllConsentsUsingGET_1", "parameters": [ { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "name": "X-Request-ID", "in": "header", "description": "ID of the request, unique to the call, as determined by the initiating party.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Consent" } } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false }, "put": { "tags": [ "consent-resource" ], "summary": "updateConsent", "operationId": "updateConsentUsingPUT_1", "parameters": [ { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "name": "X-Request-ID", "in": "header", "description": "ID of the request, unique to the call, as determined by the initiating party.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "consent", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Consent" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Consent" } } } }, "201": { "description": "Created", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false, "x-codegen-request-body-name": "consent" }, "post": { "tags": [ "consent-resource" ], "summary": "createConsent", "operationId": "createConsentUsingPOST_2", "parameters": [ { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "name": "X-Request-ID", "in": "header", "description": "ID of the request, unique to the call, as determined by the initiating party.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "consent", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Consent" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Consent" } } } }, "201": { "description": "Created", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false, "x-codegen-request-body-name": "consent" } }, "/api/consents/{id}": { "get": { "tags": [ "consent-resource" ], "summary": "getConsent", "operationId": "getConsentUsingGET_1", "parameters": [ { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "name": "X-Request-ID", "in": "header", "description": "ID of the request, unique to the call, as determined by the initiating party.", "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Consent" } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false }, "delete": { "tags": [ "consent-resource" ], "summary": "deleteConsent", "operationId": "deleteConsentUsingDELETE_2", "parameters": [ { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "name": "X-Request-ID", "in": "header", "description": "ID of the request, unique to the call, as determined by the initiating party.", "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": {} }, "204": { "description": "No Content", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} } }, "deprecated": false } }, "/api/gdpr-psusers": { "get": { "tags": [ "gdpr-psuser-resource" ], "summary": "getAllGdprPsusers", "operationId": "getAllGdprPsusersUsingGET_1", "parameters": [ { "name": "Consent-ID", "in": "header", "description": "This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. ", "schema": { "type": "string" } }, { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "name": "X-Request-ID", "in": "header", "description": "ID of the request, unique to the call, as determined by the initiating party.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GdprPsuser" } } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false }, "put": { "tags": [ "gdpr-psuser-resource" ], "summary": "updateGdprPsuser", "operationId": "updateGdprPsuserUsingPUT_1", "parameters": [ { "name": "Consent-ID", "in": "header", "description": "This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. ", "schema": { "type": "string" } }, { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "name": "X-Request-ID", "in": "header", "description": "ID of the request, unique to the call, as determined by the initiating party.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "gdprPsuser", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GdprPsuser" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GdprPsuser" } } } }, "201": { "description": "Created", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false, "x-codegen-request-body-name": "gdprPsuser" }, "post": { "tags": [ "gdpr-psuser-resource" ], "summary": "createGdprPsuser", "operationId": "createGdprPsuserUsingPOST_1", "parameters": [ { "name": "Consent-ID", "in": "header", "description": "This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. ", "schema": { "type": "string" } }, { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "name": "X-Request-ID", "in": "header", "description": "ID of the request, unique to the call, as determined by the initiating party.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "gdprPsuser", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GdprPsuser" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GdprPsuser" } } } }, "201": { "description": "Created", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false, "x-codegen-request-body-name": "gdprPsuser" } }, "/api/gdpr-psusers/{id}": { "get": { "tags": [ "gdpr-psuser-resource" ], "summary": "getGdprPsuser", "operationId": "getGdprPsuserUsingGET_1", "parameters": [ { "name": "Consent-ID", "in": "header", "description": "This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. ", "schema": { "type": "string" } }, { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "name": "X-Request-ID", "in": "header", "description": "ID of the request, unique to the call, as determined by the initiating party.", "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GdprPsuser" } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false }, "delete": { "tags": [ "gdpr-psuser-resource" ], "summary": "deleteGdprPsuser", "operationId": "deleteGdprPsuserUsingDELETE_1", "parameters": [ { "name": "Consent-ID", "in": "header", "description": "This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. ", "schema": { "type": "string" } }, { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "name": "X-Request-ID", "in": "header", "description": "ID of the request, unique to the call, as determined by the initiating party.", "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": {} }, "204": { "description": "No Content", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} } }, "deprecated": false } }, "/api/gdpr-user-bank-accounts": { "get": { "tags": [ "gdpr-user-bank-account-resource" ], "summary": "getAllGdprUserBankAccounts", "operationId": "getAllGdprUserBankAccountsUsingGET_1", "parameters": [ { "name": "Consent-ID", "in": "header", "description": "This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. ", "schema": { "type": "string" } }, { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "name": "X-Request-ID", "in": "header", "description": "ID of the request, unique to the call, as determined by the initiating party.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GdprUserBankAccount" } } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false }, "put": { "tags": [ "gdpr-user-bank-account-resource" ], "summary": "updateGdprUserBankAccount", "operationId": "updateGdprUserBankAccountUsingPUT_1", "parameters": [ { "name": "Consent-ID", "in": "header", "description": "This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. ", "schema": { "type": "string" } }, { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "name": "X-Request-ID", "in": "header", "description": "ID of the request, unique to the call, as determined by the initiating party.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "gdprUserBankAccount", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GdprUserBankAccount" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GdprUserBankAccount" } } } }, "201": { "description": "Created", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false, "x-codegen-request-body-name": "gdprUserBankAccount" }, "post": { "tags": [ "gdpr-user-bank-account-resource" ], "summary": "createGdprUserBankAccount", "operationId": "createGdprUserBankAccountUsingPOST_1", "parameters": [ { "name": "Consent-ID", "in": "header", "description": "This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. ", "schema": { "type": "string" } }, { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "name": "X-Request-ID", "in": "header", "description": "ID of the request, unique to the call, as determined by the initiating party.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "gdprUserBankAccount", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GdprUserBankAccount" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GdprUserBankAccount" } } } }, "201": { "description": "Created", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false, "x-codegen-request-body-name": "gdprUserBankAccount" } }, "/api/gdpr-user-bank-accounts/{id}": { "get": { "tags": [ "gdpr-user-bank-account-resource" ], "summary": "getGdprUserBankAccount", "operationId": "getGdprUserBankAccountUsingGET_1", "parameters": [ { "name": "Consent-ID", "in": "header", "description": "This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. ", "schema": { "type": "string" } }, { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "name": "X-Request-ID", "in": "header", "description": "ID of the request, unique to the call, as determined by the initiating party.", "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GdprUserBankAccount" } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false }, "delete": { "tags": [ "gdpr-user-bank-account-resource" ], "summary": "deleteGdprUserBankAccount", "operationId": "deleteGdprUserBankAccountUsingDELETE_1", "parameters": [ { "name": "Consent-ID", "in": "header", "description": "This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. ", "schema": { "type": "string" } }, { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "name": "X-Request-ID", "in": "header", "description": "ID of the request, unique to the call, as determined by the initiating party.", "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": {} }, "204": { "description": "No Content", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} } }, "deprecated": false } }, "/api/generateApiKey": { "post": { "tags": [ "keycloakutil" ], "summary": "generateApiKey", "operationId": "generateApiKeyUsingPOST_1", "requestBody": { "description": "body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyReqBody" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ApiKeyResponse" } } } }, "201": { "description": "Created", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false, "x-codegen-request-body-name": "body" } }, "/api/keycloak/loggedInUser": { "get": { "tags": [ "keycloakutil" ], "summary": "getEndpoint", "operationId": "getEndpointUsingGET_1", "parameters": [ { "name": "page", "in": "query", "description": "Page number of the requested page", "schema": { "type": "integer", "format": "int32" } }, { "name": "size", "in": "query", "description": "Size of a page", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort", "in": "query", "description": "Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/OptionalOfstring" } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false } }, "/api/link-account-to-users": { "get": { "tags": [ "link-account-to-user-resource" ], "summary": "getAllLinkAccountToUsers", "operationId": "getAllLinkAccountToUsersUsingGET_1", "parameters": [ { "name": "Consent-ID", "in": "header", "description": "This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. ", "schema": { "type": "string" } }, { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "name": "X-Request-ID", "in": "header", "description": "ID of the request, unique to the call, as determined by the initiating party.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LinkAccountToUser" } } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false }, "put": { "tags": [ "link-account-to-user-resource" ], "summary": "updateLinkAccountToUser", "operationId": "updateLinkAccountToUserUsingPUT_1", "parameters": [ { "name": "Consent-ID", "in": "header", "description": "This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. ", "schema": { "type": "string" } }, { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "name": "X-Request-ID", "in": "header", "description": "ID of the request, unique to the call, as determined by the initiating party.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "linkAccountToUser", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkAccountToUser" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/LinkAccountToUser" } } } }, "201": { "description": "Created", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false, "x-codegen-request-body-name": "linkAccountToUser" }, "post": { "tags": [ "link-account-to-user-resource" ], "summary": "createLinkAccountToUser", "operationId": "createLinkAccountToUserUsingPOST_1", "parameters": [ { "name": "Consent-ID", "in": "header", "description": "This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. ", "schema": { "type": "string" } }, { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "name": "X-Request-ID", "in": "header", "description": "ID of the request, unique to the call, as determined by the initiating party.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "linkAccountToUser", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkAccountToUser" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Created", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false, "x-codegen-request-body-name": "linkAccountToUser" } }, "/api/link-account-to-users/user/{userid}": { "get": { "tags": [ "link-account-to-user-resource" ], "summary": "getAccountForUser", "operationId": "getAccountForUserUsingGET_1", "parameters": [ { "name": "Consent-ID", "in": "header", "description": "This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. ", "schema": { "type": "string" } }, { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "name": "X-Request-ID", "in": "header", "description": "ID of the request, unique to the call, as determined by the initiating party.", "schema": { "type": "string", "format": "uuid" } }, { "name": "userid", "in": "path", "description": "userid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LinkAccountToUser" } } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false } }, "/api/link-account-to-users/{id}": { "get": { "tags": [ "link-account-to-user-resource" ], "summary": "getLinkAccountToUser", "operationId": "getLinkAccountToUserUsingGET_1", "parameters": [ { "name": "Consent-ID", "in": "header", "description": "This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. ", "schema": { "type": "string" } }, { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "name": "X-Request-ID", "in": "header", "description": "ID of the request, unique to the call, as determined by the initiating party.", "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/LinkAccountToUser" } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false }, "delete": { "tags": [ "link-account-to-user-resource" ], "summary": "deleteLinkAccountToUser", "operationId": "deleteLinkAccountToUserUsingDELETE_1", "parameters": [ { "name": "Consent-ID", "in": "header", "description": "This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. ", "schema": { "type": "string" } }, { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "name": "X-Request-ID", "in": "header", "description": "ID of the request, unique to the call, as determined by the initiating party.", "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": {} }, "204": { "description": "No Content", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} } }, "deprecated": false } }, "/api/psusers": { "get": { "tags": [ "psuser-resource" ], "summary": "getAllPsusers", "operationId": "getAllPsusersUsingGET_1", "parameters": [ { "name": "Consent-ID", "in": "header", "description": "This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. ", "schema": { "type": "string" } }, { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "name": "X-Request-ID", "in": "header", "description": "ID of the request, unique to the call, as determined by the initiating party.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Psuser" } } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false }, "put": { "tags": [ "psuser-resource" ], "summary": "updatePsuser", "operationId": "updatePsuserUsingPUT_1", "parameters": [ { "name": "Consent-ID", "in": "header", "description": "This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. ", "schema": { "type": "string" } }, { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "name": "X-Request-ID", "in": "header", "description": "ID of the request, unique to the call, as determined by the initiating party.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "psuser", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Psuser" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Psuser" } } } }, "201": { "description": "Created", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false, "x-codegen-request-body-name": "psuser" }, "post": { "tags": [ "psuser-resource" ], "summary": "createPsuser", "operationId": "createPsuserUsingPOST_1", "parameters": [ { "name": "Consent-ID", "in": "header", "description": "This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. ", "schema": { "type": "string" } }, { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "name": "X-Request-ID", "in": "header", "description": "ID of the request, unique to the call, as determined by the initiating party.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "psuser", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Psuser" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Psuser" } } } }, "201": { "description": "Created", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false, "x-codegen-request-body-name": "psuser" } }, "/api/psusers/{id}": { "get": { "tags": [ "psuser-resource" ], "summary": "getPsuser", "operationId": "getPsuserUsingGET_1", "parameters": [ { "name": "Consent-ID", "in": "header", "description": "This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. ", "required": true, "schema": { "type": "string" } }, { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "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", "format": "uuid" } }, { "name": "id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Psuser" } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false }, "delete": { "tags": [ "psuser-resource" ], "summary": "deletePsuser", "operationId": "deletePsuserUsingDELETE_1", "parameters": [ { "name": "Consent-ID", "in": "header", "description": "This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. ", "schema": { "type": "string" } }, { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "name": "X-Request-ID", "in": "header", "description": "ID of the request, unique to the call, as determined by the initiating party.", "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": {} }, "204": { "description": "No Content", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} } }, "deprecated": false } }, "/api/purposes": { "get": { "tags": [ "purposes-resource" ], "summary": "getAllPurposes", "operationId": "getAllPurposesUsingGET_1", "parameters": [ { "name": "Consent-ID", "in": "header", "description": "This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. ", "schema": { "type": "string" } }, { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "name": "X-Request-ID", "in": "header", "description": "ID of the request, unique to the call, as determined by the initiating party.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Purposes" } } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false }, "put": { "tags": [ "purposes-resource" ], "summary": "updatePurposes", "operationId": "updatePurposesUsingPUT_1", "parameters": [ { "name": "Consent-ID", "in": "header", "description": "This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. ", "schema": { "type": "string" } }, { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "name": "X-Request-ID", "in": "header", "description": "ID of the request, unique to the call, as determined by the initiating party.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "purposes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Purposes" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Purposes" } } } }, "201": { "description": "Created", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false, "x-codegen-request-body-name": "purposes" }, "post": { "tags": [ "purposes-resource" ], "summary": "createPurposes", "operationId": "createPurposesUsingPOST_1", "parameters": [ { "name": "Consent-ID", "in": "header", "description": "This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. ", "schema": { "type": "string" } }, { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "name": "X-Request-ID", "in": "header", "description": "ID of the request, unique to the call, as determined by the initiating party.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "purposes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Purposes" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Purposes" } } } }, "201": { "description": "Created", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false, "x-codegen-request-body-name": "purposes" } }, "/api/purposes/{id}": { "get": { "tags": [ "purposes-resource" ], "summary": "getPurposes", "operationId": "getPurposesUsingGET_1", "parameters": [ { "name": "Consent-ID", "in": "header", "description": "This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. ", "schema": { "type": "string" } }, { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "name": "X-Request-ID", "in": "header", "description": "ID of the request, unique to the call, as determined by the initiating party.", "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Purposes" } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false }, "delete": { "tags": [ "purposes-resource" ], "summary": "deletePurposes", "operationId": "deletePurposesUsingDELETE_1", "parameters": [ { "name": "Consent-ID", "in": "header", "description": "This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. ", "schema": { "type": "string" } }, { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "name": "X-Request-ID", "in": "header", "description": "ID of the request, unique to the call, as determined by the initiating party.", "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": {} }, "204": { "description": "No Content", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} } }, "deprecated": false } }, "/api/transactions": { "get": { "tags": [ "transaction-resource" ], "summary": "getAllTransactions", "operationId": "getAllTransactionsUsingGET_1", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Transaction" } } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false }, "put": { "tags": [ "transaction-resource" ], "summary": "updateTransaction", "operationId": "updateTransactionUsingPUT_1", "requestBody": { "description": "transaction", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Transaction" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Transaction" } } } }, "201": { "description": "Created", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false, "x-codegen-request-body-name": "transaction" }, "post": { "tags": [ "transaction-resource" ], "summary": "createTransaction", "operationId": "createTransactionUsingPOST_1", "requestBody": { "description": "transaction", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Transaction" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Transaction" } } } }, "201": { "description": "Created", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false, "x-codegen-request-body-name": "transaction" } }, "/api/transactions/{id}": { "get": { "tags": [ "transaction-resource" ], "summary": "getTransaction", "operationId": "getTransactionUsingGET_1", "parameters": [ { "name": "id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Transaction" } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false }, "delete": { "tags": [ "transaction-resource" ], "summary": "deleteTransaction", "operationId": "deleteTransactionUsingDELETE_1", "parameters": [ { "name": "id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": {} }, "204": { "description": "No Content", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} } }, "deprecated": false } }, "/api/user-bank-accounts": { "get": { "tags": [ "user-bank-account-resource" ], "summary": "getAllUserBankAccounts", "operationId": "getAllUserBankAccountsUsingGET_1", "parameters": [ { "name": "Consent-ID", "in": "header", "description": "This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. ", "schema": { "type": "string" } }, { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "name": "X-Request-ID", "in": "header", "description": "ID of the request, unique to the call, as determined by the initiating party.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserBankAccount" } } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false }, "put": { "tags": [ "user-bank-account-resource" ], "summary": "updateUserBankAccount", "operationId": "updateUserBankAccountUsingPUT_1", "parameters": [ { "name": "Consent-ID", "in": "header", "description": "This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. ", "schema": { "type": "string" } }, { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "name": "X-Request-ID", "in": "header", "description": "ID of the request, unique to the call, as determined by the initiating party.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "userBankAccount", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserBankAccount" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/UserBankAccount" } } } }, "201": { "description": "Created", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false, "x-codegen-request-body-name": "userBankAccount" }, "post": { "tags": [ "user-bank-account-resource" ], "summary": "createUserBankAccount", "operationId": "createUserBankAccountUsingPOST_1", "parameters": [ { "name": "Consent-ID", "in": "header", "description": "This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. ", "schema": { "type": "string" } }, { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "name": "X-Request-ID", "in": "header", "description": "ID of the request, unique to the call, as determined by the initiating party.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "userBankAccount", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserBankAccount" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/UserBankAccount" } } } }, "201": { "description": "Created", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false, "x-codegen-request-body-name": "userBankAccount" } }, "/api/user-bank-accounts/{id}": { "get": { "tags": [ "user-bank-account-resource" ], "summary": "getUserBankAccount", "operationId": "getUserBankAccountUsingGET_1", "parameters": [ { "name": "Consent-ID", "in": "header", "description": "This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. ", "schema": { "type": "string" } }, { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "name": "X-Request-ID", "in": "header", "description": "ID of the request, unique to the call, as determined by the initiating party.", "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/UserBankAccount" } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "deprecated": false }, "delete": { "tags": [ "user-bank-account-resource" ], "summary": "deleteUserBankAccount", "operationId": "deleteUserBankAccountUsingDELETE_1", "parameters": [ { "name": "Consent-ID", "in": "header", "description": "This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. ", "schema": { "type": "string" } }, { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "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 dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. ", "schema": { "type": "string", "format": "uuid" } }, { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available. ", "schema": { "type": "string" } }, { "name": "PSU-Http-Method", "in": "header", "description": "HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE ", "schema": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field 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. ", "schema": { "type": "string" } }, { "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. ", "schema": { "type": "string" } }, { "name": "PSU-User-Agent", "in": "header", "description": "The forwarded Agent header field of the HTTP request between PSU and TPP, if available. ", "schema": { "type": "string" } }, { "name": "Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP. ", "schema": { "type": "string" } }, { "name": "TPP-Signature-Certificate", "in": "header", "description": "The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. ", "schema": { "type": "string", "format": "byte" } }, { "name": "X-Request-ID", "in": "header", "description": "ID of the request, unique to the call, as determined by the initiating party.", "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": {} }, "204": { "description": "No Content", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} } }, "deprecated": false } } }, "components": { "schemas": { "Accounts": { "title": "Accounts", "required": [ "accountid" ], "type": "object", "properties": { "accountid": { "type": "string" }, "creationdate": { "type": "string" }, "displayname": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "isowned": { "type": "boolean" }, "maskednumber": { "type": "string" }, "nickname": { "type": "string" }, "openstatus": { "type": "string" }, "productcategory": { "type": "string" }, "productname": { "type": "string" } } }, "AcctAggregator": { "title": "AcctAggregator", "required": [ "userid" ], "type": "object", "properties": { "balance": { "type": "number" }, "consent": { "$ref": "#/components/schemas/Consent" }, "financialStatus": { "type": "string", "enum": [ "Poor", "Moderate", "Good", "Excessive" ] }, "gdprPsuser": { "$ref": "#/components/schemas/GdprPsuser" }, "id": { "type": "integer", "format": "int64" }, "psuser": { "$ref": "#/components/schemas/Psuser" }, "tppMaster": { "$ref": "#/components/schemas/TppMaster" }, "userid": { "type": "string" } } }, "ApiKeyReqBody": { "title": "ApiKeyReqBody", "type": "object", "properties": { "applicationDescription": { "type": "string" }, "applicationName": { "type": "string" }, "applicationType": { "type": "string" }, "consumerEmail": { "type": "string" }, "consumerName": { "type": "string" }, "consumerOrgname": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "redirectUrl": { "type": "string" } } }, "ApiKeyResponse": { "title": "ApiKeyResponse", "type": "object", "properties": { "applicationDescription": { "type": "string" }, "applicationName": { "type": "string" }, "applicationType": { "type": "string" }, "authenticationEndpoint": { "type": "string" }, "consumerCLientId": { "type": "string" }, "consumerEmail": { "type": "string" }, "consumerId": { "type": "string" }, "consumerSecret": { "type": "string" }, "directLoginEndpoint": { "type": "string" }, "documentationEndpoint": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "redirectUrl": { "type": "string" } } }, "BgCardAccounts": { "title": "BgCardAccounts", "type": "object", "properties": { "balance": { "$ref": "#/components/schemas/bgBalance" }, "creditLimit": { "type": "number" }, "currency": { "type": "string" }, "details": { "type": "string" }, "displayName": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "maskedPan": { "type": "string" }, "name": { "type": "string" }, "ownername": { "type": "string" }, "product": { "type": "string" }, "resourceid": { "type": "string" }, "status": { "type": "string" }, "usage": { "type": "string" } } }, "BgChallengeData": { "title": "BgChallengeData", "type": "object", "properties": { "additionalInformation": { "type": "string" }, "data": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "image": { "type": "string" }, "imageLink": { "type": "string" }, "otpFormat": { "type": "string" }, "otpMaxLength": { "type": "string" } } }, "BgConsentAuthorisation": { "title": "BgConsentAuthorisation", "type": "object", "properties": { "authorisationid": { "type": "string" }, "challengeData": { "$ref": "#/components/schemas/BgChallengeData" }, "chosenScaMethod": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "psuMessage": { "type": "string" }, "scaMethods": { "$ref": "#/components/schemas/BgScaMethods" } } }, "BgConsentInfoTemplate": { "title": "BgConsentInfoTemplate", "type": "object", "properties": { "bban": { "type": "string" }, "currency": { "type": "string" }, "iban": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "maskedpan": { "type": "string" }, "msisdin": { "type": "string" }, "pan": { "type": "string" } } }, "BgConsentResponse": { "title": "BgConsentResponse", "type": "object", "properties": { "challengeData": { "$ref": "#/components/schemas/BgChallengeData" }, "chosenScaMethod": { "type": "string" }, "consentStatus": { "type": "string" }, "consentid": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "psuMessage": { "type": "string" }, "scaMethods": { "$ref": "#/components/schemas/BgScaMethods" } } }, "BgConsents": { "title": "BgConsents", "type": "object", "properties": { "access": { "$ref": "#/components/schemas/BgConsentsAccess" }, "combinedServiceIndicator": { "type": "boolean" }, "frequencyPerDay": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int64" }, "recurringIndicator": { "type": "boolean" }, "validUntil": { "type": "string" } } }, "BgConsentsAccess": { "title": "BgConsentsAccess", "type": "object", "properties": { "accounts": { "$ref": "#/components/schemas/BgConsentInfoTemplate" }, "allPsd2": { "type": "string" }, "availableAccounts": { "type": "string" }, "availableAccountsWithBalance": { "type": "string" }, "balances": { "$ref": "#/components/schemas/BgConsentInfoTemplate" }, "id": { "type": "integer", "format": "int64" }, "ownername": { "$ref": "#/components/schemas/BgConsentInfoTemplate" }, "transactions": { "$ref": "#/components/schemas/BgConsentInfoTemplate" }, "trustedbenificiaries": { "$ref": "#/components/schemas/BgConsentInfoTemplate" } } }, "BgCurrencyExchange": { "title": "BgCurrencyExchange", "type": "object", "properties": { "contractIdentification": { "type": "string" }, "exchangeRate": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "quotationDate": { "type": "string" }, "sourceCurrency": { "type": "string" }, "targetCurrency": { "type": "string" }, "unitCurrency": { "type": "string" } } }, "BgScaMethods": { "title": "BgScaMethods", "type": "object", "properties": { "authenticationMethodId": { "type": "string" }, "authenticationType": { "type": "string" }, "authenticationVersion": { "type": "string" }, "explanation": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "BgTransactionAddInfo": { "title": "BgTransactionAddInfo", "type": "object", "properties": { "currency": { "type": "string" }, "dayOfExecution": { "type": "string" }, "endDate": { "type": "string" }, "executionRule": { "type": "string" }, "frequency": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "limitAmount": { "type": "number" }, "monthsofExecution": { "type": "string" }, "multiplicator": { "type": "integer", "format": "int32" }, "startDate": { "type": "string" }, "withinAMonthFlag": { "type": "boolean" } } }, "BgTransactions": { "title": "BgTransactions", "type": "object", "properties": { "balanceAfterTransaction": { "$ref": "#/components/schemas/bgBalance" }, "bankTransactionCode": { "type": "string" }, "bgAccounts": { "$ref": "#/components/schemas/bgAccounts" }, "bgCurrencyExchange": { "$ref": "#/components/schemas/BgCurrencyExchange" }, "bgTransactionAddInfo": { "$ref": "#/components/schemas/BgTransactionAddInfo" }, "bookingDate": { "type": "string" }, "cardAccounts": { "$ref": "#/components/schemas/BgCardAccounts" }, "checkId": { "type": "string" }, "creditorAccount": { "$ref": "#/components/schemas/bgAccounts" }, "creditorAgent": { "type": "string" }, "creditorId": { "type": "string" }, "creditorName": { "type": "string" }, "debtorAccount": { "$ref": "#/components/schemas/bgAccounts" }, "id": { "type": "integer", "format": "int64" }, "mandateId": { "type": "string" }, "proprietaryBankTransactionCode": { "type": "string" }, "purposeCode": { "type": "string" }, "transactionAmount": { "type": "number" }, "transactionAmountCurrency": { "type": "string" }, "transactionid": { "type": "string" }, "ultimateCreditor": { "type": "string" }, "ultimateDebtor": { "type": "string" }, "valueDate": { "type": "string" } } }, "Consent": { "title": "Consent", "required": [ "consentid", "userid" ], "type": "object", "properties": { "consentAisps": { "type": "array", "items": { "$ref": "#/components/schemas/AcctAggregator" } }, "consentStatus": { "type": "string", "enum": [ "Active", "Inactive" ] }, "consentid": { "type": "string" }, "consents": { "type": "array", "items": { "$ref": "#/components/schemas/Transaction" } }, "datafilter": { "type": "string" }, "datalife": { "type": "integer", "format": "int32" }, "datarange": { "type": "string" }, "endDate": { "type": "string", "format": "date" }, "fetchType": { "type": "string", "enum": [ "ONETIME", "PERIODIC" ] }, "frequency": { "type": "integer", "format": "int32" }, "gdprPsuser": { "$ref": "#/components/schemas/GdprPsuser" }, "gdprStatus": { "type": "string", "enum": [ "Active", "Inactive" ] }, "id": { "type": "integer", "format": "int64" }, "mode": { "type": "string", "enum": [ "VIEW", "STORE", "QUERY", "STREAM" ] }, "psuser": { "$ref": "#/components/schemas/Psuser" }, "purpose": { "$ref": "#/components/schemas/Purposes" }, "startDate": { "type": "string", "format": "date" }, "userid": { "type": "string" } } }, "GdprPsuser": { "title": "GdprPsuser", "required": [ "emailId", "password", "userid", "username" ], "type": "object", "properties": { "contactNumber": { "type": "string" }, "country": { "type": "string", "enum": [ "India", "UK", "EU", "USA", "China", "Russia", "Australia", "Singapore", "Germany" ] }, "emailId": { "pattern": "^[^@\\s]+@[^@\\s]+\\.[^@\\s]+$", "type": "string" }, "gdprPsuserConsents": { "type": "array", "items": { "$ref": "#/components/schemas/Consent" } }, "gdprPsuserTransactions": { "type": "array", "items": { "$ref": "#/components/schemas/Transaction" } }, "gdprpsUserAisps": { "type": "array", "items": { "$ref": "#/components/schemas/AcctAggregator" } }, "gdprpsuserLinkAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/LinkAccountToUser" } }, "id": { "type": "integer", "format": "int64" }, "ipaddress": { "type": "string" }, "password": { "type": "string" }, "portNumber": { "type": "integer", "format": "int32" }, "userid": { "type": "string" }, "username": { "type": "string" } } }, "GdprUserBankAccount": { "title": "GdprUserBankAccount", "required": [ "accountNo", "bankname", "iban", "userid" ], "type": "object", "properties": { "accountNo": { "type": "string" }, "accountType": { "type": "string", "enum": [ "SAVING", "CURRENT", "RECURRYINGDEPOSIT", "FIXEDDEPOSIT", "DEMAT", "NRI" ] }, "balance": { "type": "number" }, "bankname": { "type": "string" }, "cardExpiry": { "type": "string", "format": "date" }, "cardName": { "type": "string" }, "cardNmber": { "type": "string" }, "cardType": { "type": "string", "enum": [ "VISA", "MASTER", "CARD", "RUPAY", "MAESTRO", "EMV", "PLATINUM", "DEBIT" ] }, "currency": { "type": "string", "enum": [ "INR", "USD" ] }, "gdprAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/Transaction" } }, "gdprbankaccountLinks": { "type": "array", "items": { "$ref": "#/components/schemas/LinkAccountToUser" } }, "iban": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "identityCode": { "type": "string" }, "userid": { "type": "string" } } }, "LinkAccountToUser": { "title": "LinkAccountToUser", "required": [ "iban", "userid" ], "type": "object", "properties": { "gdprPsuser": { "$ref": "#/components/schemas/GdprPsuser" }, "gdprUserBankAccount": { "$ref": "#/components/schemas/GdprUserBankAccount" }, "iban": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "linkStatus": { "type": "string", "enum": [ "Active", "Inactive" ] }, "psuser": { "$ref": "#/components/schemas/Psuser" }, "userBankAccount": { "$ref": "#/components/schemas/UserBankAccount" }, "userid": { "type": "string" } } }, "OptionalOfBgConsents": { "title": "OptionalOfBgConsents", "type": "object", "properties": { "present": { "type": "boolean" } } }, "OptionalOfstring": { "title": "OptionalOfstring", "type": "object", "properties": { "present": { "type": "boolean" } } }, "Products": { "title": "Products", "required": [ "productid" ], "type": "object", "properties": { "applicationuri": { "type": "string" }, "brand": { "type": "string" }, "brandname": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "istailored": { "type": "boolean" }, "lastupdated": { "type": "string" }, "name": { "type": "string" }, "productcategory": { "type": "string" }, "productid": { "type": "string" } } }, "Psuser": { "title": "Psuser", "required": [ "emailId", "password", "userid", "username" ], "type": "object", "properties": { "contactNumber": { "type": "string" }, "country": { "type": "string", "enum": [ "India", "UK", "EU", "USA", "China", "Russia", "Australia", "Singapore", "Germany" ] }, "emailId": { "pattern": "^[^@\\s]+@[^@\\s]+\\.[^@\\s]+$", "type": "string" }, "id": { "type": "integer", "format": "int64" }, "ipaddress": { "type": "string" }, "password": { "type": "string" }, "portNumber": { "type": "integer", "format": "int32" }, "userid": { "type": "string" }, "username": { "type": "string" } } }, "Purposes": { "title": "Purposes", "required": [ "purposeid" ], "type": "object", "properties": { "category": { "type": "string", "enum": [ "TESTING", "CONVERSION_TRACKING", "MARKETING_AUTOMATION", "REMARKETING", "USER_FEEDBACK", "ANALYTICS" ] }, "description": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "purposeid": { "type": "string" }, "purposes": { "type": "array", "items": { "$ref": "#/components/schemas/Consent" } }, "refURI": { "type": "string" }, "regarding": { "type": "string", "enum": [ "Balance", "Transaction", "Both" ] } } }, "TppMaster": { "title": "TppMaster", "required": [ "name", "regnumber" ], "type": "object", "properties": { "certificate": { "type": "string" }, "country": { "type": "string", "enum": [ "India", "UK", "EU", "USA", "China", "Russia", "Australia", "Singapore", "Germany" ] }, "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "ncaId": { "type": "string" }, "regnumber": { "type": "string" }, "role": { "type": "string", "enum": [ "AISP", "PISP", "ASPSP", "PSP" ] }, "signature": { "type": "string" }, "tpps": { "type": "array", "items": { "$ref": "#/components/schemas/AcctAggregator" } } } }, "Transaction": { "title": "Transaction", "required": [ "consent", "userid" ], "type": "object", "properties": { "consent": { "$ref": "#/components/schemas/Consent" }, "currency": { "type": "string", "enum": [ "INR", "USD" ] }, "date": { "type": "string", "format": "date" }, "gdprPsuser": { "$ref": "#/components/schemas/GdprPsuser" }, "gdprUserBankAccount": { "$ref": "#/components/schemas/GdprUserBankAccount" }, "id": { "type": "integer", "format": "int64" }, "psuser": { "$ref": "#/components/schemas/Psuser" }, "transactionAmount": { "type": "number" }, "transactionType": { "type": "string", "enum": [ "Debit", "Credit" ] }, "userBankAccount": { "$ref": "#/components/schemas/UserBankAccount" }, "userid": { "type": "string" } } }, "UserBankAccount": { "title": "UserBankAccount", "required": [ "accountNo", "bankname", "iban", "userid" ], "type": "object", "properties": { "accountNo": { "type": "string" }, "accountType": { "type": "string", "enum": [ "SAVING", "CURRENT", "RECURRYINGDEPOSIT", "FIXEDDEPOSIT", "DEMAT", "NRI" ] }, "accounts": { "type": "array", "items": { "$ref": "#/components/schemas/Transaction" } }, "balance": { "type": "number" }, "bankaccountLinks": { "type": "array", "items": { "$ref": "#/components/schemas/LinkAccountToUser" } }, "bankname": { "type": "string" }, "cardExpiry": { "type": "string", "format": "date" }, "cardName": { "type": "string" }, "cardNmber": { "type": "string" }, "cardType": { "type": "string", "enum": [ "VISA", "MASTER", "CARD", "RUPAY", "MAESTRO", "EMV", "PLATINUM", "DEBIT" ] }, "currency": { "type": "string", "enum": [ "INR", "USD" ] }, "iban": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "identityCode": { "type": "string" }, "userid": { "type": "string" } } }, "bgAccounts": { "title": "bgAccounts", "type": "object", "properties": { "bban": { "type": "string" }, "bgBalance": { "$ref": "#/components/schemas/bgBalance" }, "bic": { "type": "string" }, "cashaccounttype": { "type": "string" }, "currency": { "type": "string" }, "details": { "type": "string" }, "displayname": { "type": "string" }, "iban": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "linkedaccounts": { "type": "string" }, "msisdn": { "type": "string" }, "name": { "type": "string" }, "ownername": { "type": "string" }, "product": { "type": "string" }, "resourceid": { "type": "string" }, "status": { "type": "string" }, "usage": { "type": "string" } } }, "bgBalance": { "title": "bgBalance", "type": "object", "properties": { "balanceamount": { "type": "number" }, "balancetype": { "type": "string" }, "creditlimitincluded": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "lastchangedatetime": { "type": "string" }, "lastcommittedtransaction": { "type": "string" }, "referencedate": { "type": "string" } } } } } }