Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
ltibanking.onlinebanking-bankinggateway.5.5.12.source-code.banking-gateway-b2c-0.1.json Maven / Gradle / Ivy
{
"openapi": "3.0.1",
"info": {
"title": "Bankinggateway B2C Rest API",
"license": {},
"version": "0.2-SNAPSHOT"
},
"externalDocs": {
"url": "https://git.adorsys.de/banking-gateway/banking-gateway"
},
"servers": [
{
"url": "http://localhost:8084",
"description": "Generated server url"
}
],
"tags": [
{
"name": "PIS",
"description": "Banking-Gateway B2C PIS"
},
{
"name": "OAuth",
"description": "Banking-Gateway B2C OAuth"
},
{
"name": "AIS",
"description": "Banking-Gateway B2C AIS"
},
{
"name": "AIS",
"description": "Banking-Gateway consent authorisation"
}
],
"paths": {
"/v1/ais/consents": {
"post": {
"tags": [
"AIS"
],
"description": "Create AIS consent",
"operationId": "createConsent",
"parameters": [
{
"name": "PSU-ID",
"in": "header",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "PSU-Corporate-ID",
"in": "header",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "TPP-Redirect-Preferred",
"in": "header",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"name": "TPP-Redirect-URI",
"in": "header",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "X-GTW-Bank-Code",
"in": "header",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsentTO"
}
}
}
},
"responses": {
"200": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateConsentResponseTO"
}
}
}
},
"400": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
},
"404": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
},
"405": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
},
"500": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
}
},
"security": [
{
"bg_auth": [
"openid"
]
}
]
}
},
"/v1/ais/consents/{consentId}": {
"get": {
"tags": [
"AIS"
],
"description": "Get AIS consent by consent id",
"operationId": "getConsent",
"parameters": [
{
"name": "consentId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsentTO"
}
}
}
},
"400": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
},
"404": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
},
"405": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
},
"500": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
}
},
"security": [
{
"bg_auth": [
"openid"
]
}
]
},
"delete": {
"tags": [
"AIS"
],
"description": "Revoke consent by consent id",
"operationId": "revokeConsent",
"parameters": [
{
"name": "consentId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "default response"
},
"400": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
},
"404": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
},
"405": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
},
"500": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
}
},
"security": [
{
"bg_auth": [
"openid"
]
}
]
}
},
"/v1/ais/consents/{consentId}/status": {
"get": {
"tags": [
"AIS"
],
"description": "Get AIS consent status by consent id",
"operationId": "getConsentStatus",
"parameters": [
{
"name": "consentId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"type": "string",
"enum": [
"RECEIVED",
"REJECTED",
"VALID",
"REVOKEDBYPSU",
"EXPIRED",
"TERMINATEDBYTPP",
"TERMINATED_BY_ASPSP",
"PARTIALLY_AUTHORISED"
]
}
}
}
},
"400": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
},
"404": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
},
"405": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
},
"500": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
}
},
"security": [
{
"bg_auth": [
"openid"
]
}
]
}
},
"/v1/consents/{consentId}/authorisations/{authorisationId}": {
"get": {
"tags": [
"AIS"
],
"description": "Get consent authorisation status",
"operationId": "getConsentAuthorisationStatus",
"parameters": [
{
"name": "consentId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "authorisationId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ResourceUpdateAuthResponseTO"
}
}
}
},
"400": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
},
"404": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
},
"405": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
},
"500": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
}
},
"security": [
{
"bg_auth": [
"openid"
]
}
]
}
},
"/v1/consents/{consentId}/authorisations/{authorisationId}/selectPsuAuthenticationMethod": {
"put": {
"tags": [
"AIS"
],
"description": "Update authorisation (select SCA method)",
"operationId": "selectPsuAuthenticationMethod",
"parameters": [
{
"name": "consentId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "authorisationId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelectPsuAuthenticationMethodRequestTO"
}
}
}
},
"responses": {
"200": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ResourceUpdateAuthResponseTO"
}
}
}
},
"400": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
},
"404": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
},
"405": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
},
"500": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
}
},
"security": [
{
"bg_auth": [
"openid"
]
}
]
}
},
"/v1/consents/{consentId}/authorisations/{authorisationId}/transactionAuthorisation": {
"put": {
"tags": [
"AIS"
],
"description": "Update authorisation (authorize transaction)",
"operationId": "transactionAuthorisation",
"parameters": [
{
"name": "consentId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "authorisationId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TransactionAuthorisationRequestTO"
}
}
}
},
"responses": {
"200": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ResourceUpdateAuthResponseTO"
}
}
}
},
"400": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
},
"404": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
},
"405": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
},
"500": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
}
},
"security": [
{
"bg_auth": [
"openid"
]
}
]
}
},
"/v1/consents/{consentId}/authorisations/{authorisationId}/updatePsuAuthentication": {
"put": {
"tags": [
"AIS"
],
"description": "Update authorisation (authenticate user)",
"operationId": "updatePsuAuthentication",
"parameters": [
{
"name": "consentId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "authorisationId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdatePsuAuthenticationRequestTO"
}
}
}
},
"responses": {
"200": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ResourceUpdateAuthResponseTO"
}
}
}
},
"400": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
},
"404": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
},
"405": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
},
"500": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
}
},
"security": [
{
"bg_auth": [
"openid"
]
}
]
}
},
"/v1/oauth/token": {
"post": {
"tags": [
"OAuth"
],
"description": "Resolve token for oauth authentication code",
"operationId": "resolveAuthCode",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuthorizationCodeTO"
}
}
}
},
"responses": {
"200": {
"description": "default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OAuthToken"
}
}
}
},
"400": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
},
"404": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
},
"405": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
},
"500": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
}
}
}
},
"/v1/payments/{paymentId}": {
"get": {
"tags": [
"PIS"
],
"description": "Get payment information",
"operationId": "getPayment",
"parameters": [
{
"name": "paymentId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ResourcePaymentDataTO"
}
}
}
},
"400": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
},
"404": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
},
"405": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
},
"500": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
}
},
"security": [
{
"bg_auth": [
"openid"
]
}
]
}
},
"/v1/payments/{paymentId}/authorisations/{authorisationId}": {
"get": {
"tags": [
"PIS"
],
"description": "Get payment authorisation status",
"operationId": "getPaymentAuthorisationStatus",
"parameters": [
{
"name": "paymentId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "authorisationId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ResourceUpdateAuthResponseTO"
}
}
}
},
"400": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
},
"404": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
},
"405": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
},
"500": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
}
},
"security": [
{
"bg_auth": [
"openid"
]
}
]
}
},
"/v1/payments/{paymentId}/authorisations/{authorisationId}/selectPsuAuthenticationMethod": {
"put": {
"tags": [
"PIS"
],
"description": "Update authorisation (select SCA method)",
"operationId": "selectPsuAuthenticationMethod_1",
"parameters": [
{
"name": "paymentId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "authorisationId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelectPsuAuthenticationMethodRequestTO"
}
}
}
},
"responses": {
"200": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ResourceUpdateAuthResponseTO"
}
}
}
},
"400": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
},
"404": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
},
"405": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
},
"500": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
}
},
"security": [
{
"bg_auth": [
"openid"
]
}
]
}
},
"/v1/payments/{paymentId}/authorisations/{authorisationId}/transactionAuthorisation": {
"put": {
"tags": [
"PIS"
],
"description": "Update authorisation (authorize transaction)",
"operationId": "transactionAuthorisation_1",
"parameters": [
{
"name": "paymentId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "authorisationId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TransactionAuthorisationRequestTO"
}
}
}
},
"responses": {
"200": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ResourceUpdateAuthResponseTO"
}
}
}
},
"400": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
},
"404": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
},
"405": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
},
"500": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
}
},
"security": [
{
"bg_auth": [
"openid"
]
}
]
}
},
"/v1/payments/{paymentId}/authorisations/{authorisationId}/updatePsuAuthentication": {
"put": {
"tags": [
"PIS"
],
"description": "Update authorisation (authenticate user)",
"operationId": "updatePsuAuthentication_1",
"parameters": [
{
"name": "paymentId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "authorisationId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdatePsuAuthenticationRequestTO"
}
}
}
},
"responses": {
"200": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ResourceUpdateAuthResponseTO"
}
}
}
},
"400": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
},
"404": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
},
"405": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
},
"500": {
"description": "default response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MessagesTO"
}
}
}
}
},
"security": [
{
"bg_auth": [
"openid"
]
}
]
}
}
},
"components": {
"schemas": {
"MessageTO": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"severity": {
"type": "string",
"enum": [
"ERROR",
"WARNING",
"INFO"
]
},
"field": {
"type": "string"
},
"renderedMessage": {
"type": "string"
},
"paramsMap": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"MessagesTO": {
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"messageList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MessageTO"
}
}
}
},
"UpdatePsuAuthenticationRequestTO": {
"required": [
"password"
],
"type": "object",
"properties": {
"psuId": {
"type": "string"
},
"psuCorporateId": {
"type": "string"
},
"password": {
"type": "string",
"description": "Password"
}
}
},
"ChallengeDataTO": {
"type": "object",
"properties": {
"image": {
"type": "string",
"description": "PNG data (max. 512 kilobyte) to be displayed to the PSU, Base64 encoding, cp. [RFC4648].\nThis attribute is used only, when PHOTO_OTP or CHIP_OTP is the selected SCA method.",
"format": "byte"
},
"data": {
"type": "array",
"description": "String challenge data",
"items": {
"type": "string",
"description": "String challenge data"
}
},
"imageLink": {
"type": "string",
"description": "A link where the ASPSP will provides the challenge image"
},
"otpMaxLength": {
"type": "integer",
"description": "The maximal length for the OTP to be typed in by the PSU",
"format": "int32"
},
"otpFormat": {
"type": "string",
"description": "The format type of the OTP to be typed in. The admitted values are \"characters\" or \"integer\""
},
"additionalInformation": {
"type": "string",
"description": "Additional explanation for the PSU to explain e.g. fallback mechanism for the chosen SCA method"
}
},
"description": "It is contained in addition to the data element 'chosenScaMethod' if challenge data is needed for SCA"
},
"Link": {
"type": "object",
"properties": {
"rel": {
"type": "string",
"xml": {
"attribute": true
}
},
"href": {
"type": "string",
"xml": {
"attribute": true
}
},
"hreflang": {
"type": "string",
"xml": {
"attribute": true
}
},
"media": {
"type": "string",
"xml": {
"attribute": true
}
},
"title": {
"type": "string",
"xml": {
"attribute": true
}
},
"type": {
"type": "string",
"xml": {
"attribute": true
}
},
"deprecation": {
"type": "string",
"xml": {
"attribute": true
}
}
}
},
"ResourceUpdateAuthResponseTO": {
"type": "object",
"properties": {
"scaStatus": {
"type": "string",
"enum": [
"RECEIVED",
"STARTED",
"PSUIDENTIFIED",
"PSUAUTHENTICATED",
"SCAMETHODSELECTED",
"FINALISED",
"FAILED",
"EXEMPTED"
]
},
"scaApproach": {
"type": "string",
"enum": [
"EMBEDDED",
"REDIRECT",
"DECOUPLED",
"OAUTH",
"OAUTH_PRESTEP"
]
},
"scaMethods": {
"type": "array",
"description": "This data element might be contained, if SCA is required and if the PSU has a choice between different authentication methods. These methods shall be presented towards the PSU for selection by the TPP.",
"items": {
"$ref": "#/components/schemas/ScaMethodTO"
}
},
"challenge": {
"$ref": "#/components/schemas/ChallengeDataTO"
},
"psuMessage": {
"type": "string",
"description": "Text to be displayed to the PSU"
},
"links": {
"type": "array",
"xml": {
"name": "link",
"namespace": "http://www.w3.org/2005/Atom"
},
"items": {
"$ref": "#/components/schemas/Link"
}
}
}
},
"ScaMethodTO": {
"required": [
"authenticationMethodId",
"authenticationType"
],
"type": "object",
"properties": {
"authenticationType": {
"type": "string",
"description": "Type of the authentication method. More authentication types might be added during implementation projects and documented in the ASPSP documentation. - 'SMS_OTP': An SCA method, where an OTP linked to the transaction to be authorised is sent to the PSU through a SMS channel. - 'CHIP_OTP': An SCA method, where an OTP is generated by a chip card, e.g. an TOP derived from an EMV cryptogram. To contact the card, the PSU normally needs a (handheld) device. With this device, the PSU either reads the challenging data through a visual interface like flickering or the PSU types in the challenge through the device key pad. The device then derives an OTP from the challenge data and displays the OTP to the PSU. - 'PHOTO_OTP': An SCA method, where the challenge is a QR code or similar encoded visual data which can be read in by a consumer device or specific mobile app. The device resp. the specific app than derives an OTP from the visual challenge data and displays the OTP to the PSU. - 'PUSH_OTP': An OTP is pushed to a dedicated authentication APP and displayed to the PSU.",
"enum": [
"SMS_OTP",
"CHIP_OTP",
"PHOTO_OTP",
"PUSH_OTP",
"EMAIL",
"APP_OTP"
]
},
"authenticationMethodId": {
"type": "string",
"description": "An identification provided by the ASPSP for the later identification of the authentication method selection"
},
"authenticationVersion": {
"type": "string",
"description": "This version can be used by differentiating authentication tools used within performing OTP generation in the same authentication type"
},
"name": {
"type": "string",
"description": "This is the name of the authentication method defined by the PSU in the Online Banking frontend of the ASPSP.\nAlternatively this could be a description provided by the ASPSP like \"SMS OTP on phone +49160 xxxxx 28\"."
},
"explanation": {
"type": "string",
"description": "Detailed information about the SCA method for the PSU"
}
},
"description": "This data element might be contained, if SCA is required and if the PSU has a choice between different authentication methods. These methods shall be presented towards the PSU for selection by the TPP."
},
"UpdateAuthResponseTO": {
"type": "object",
"properties": {
"scaStatus": {
"type": "string",
"enum": [
"RECEIVED",
"STARTED",
"PSUIDENTIFIED",
"PSUAUTHENTICATED",
"SCAMETHODSELECTED",
"FINALISED",
"FAILED",
"EXEMPTED"
]
},
"scaApproach": {
"type": "string",
"enum": [
"EMBEDDED",
"REDIRECT",
"DECOUPLED",
"OAUTH",
"OAUTH_PRESTEP"
]
},
"scaMethods": {
"type": "array",
"description": "This data element might be contained, if SCA is required and if the PSU has a choice between different authentication methods. These methods shall be presented towards the PSU for selection by the TPP.",
"items": {
"$ref": "#/components/schemas/ScaMethodTO"
}
},
"challenge": {
"$ref": "#/components/schemas/ChallengeDataTO"
},
"psuMessage": {
"type": "string",
"description": "Text to be displayed to the PSU"
}
}
},
"SelectPsuAuthenticationMethodRequestTO": {
"required": [
"authenticationMethodId"
],
"type": "object",
"properties": {
"authenticationMethodId": {
"type": "string",
"description": "An identification provided by the ASPSP for the later identification of the authentication method selection.",
"example": "myAuthenticationID"
}
}
},
"TransactionAuthorisationRequestTO": {
"required": [
"scaAuthenticationData"
],
"type": "object",
"properties": {
"scaAuthenticationData": {
"type": "string",
"description": "SCA authentication data, depending on the chosen authentication method. If the data is binary, then it is base64 encoded."
}
}
},
"AccountAccessTO": {
"type": "object",
"properties": {
"accounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountReferenceTO"
}
},
"balances": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountReferenceTO"
}
},
"transactions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountReferenceTO"
}
}
}
},
"AccountReferenceTO": {
"type": "object",
"properties": {
"iban": {
"type": "string"
},
"currency": {
"type": "string"
}
}
},
"ConsentTO": {
"type": "object",
"properties": {
"consentId": {
"type": "string",
"readOnly": true
},
"access": {
"$ref": "#/components/schemas/AccountAccessTO"
},
"recurringIndicator": {
"type": "boolean"
},
"validUntil": {
"type": "string",
"format": "date"
},
"frequencyPerDay": {
"type": "integer",
"format": "int32"
},
"consentStatus": {
"type": "string",
"readOnly": true,
"enum": [
"RECEIVED",
"REJECTED",
"VALID",
"REVOKEDBYPSU",
"EXPIRED",
"TERMINATEDBYTPP",
"TERMINATED_BY_ASPSP",
"PARTIALLY_AUTHORISED"
]
},
"psuAccount": {
"type": "string"
}
}
},
"CreateConsentResponseTO": {
"type": "object",
"properties": {
"consentId": {
"type": "string"
},
"authorisationId": {
"type": "string"
},
"redirectUrl": {
"type": "string"
},
"oauthRedirectUrl": {
"type": "string"
},
"scaApproach": {
"type": "string",
"enum": [
"EMBEDDED",
"REDIRECT",
"DECOUPLED",
"OAUTH",
"OAUTH_PRESTEP"
]
}
}
},
"AuthorizationCodeTO": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"bankCode": {
"type": "string"
}
}
},
"OAuthToken": {
"type": "object",
"properties": {
"access_token": {
"type": "string"
},
"refresh_token": {
"type": "string"
}
}
},
"PaymentDataTO": {
"type": "object",
"properties": {
"payments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentTO"
}
},
"paymentProduct": {
"type": "string"
},
"paymentType": {
"type": "string",
"enum": [
"SINGLE",
"BULK",
"PERIODIC"
]
},
"rawPayment": {
"type": "string"
},
"psuAccount": {
"type": "string"
}
}
},
"PaymentTO": {
"type": "object",
"properties": {
"paymentId": {
"type": "string"
},
"executionId": {
"type": "string"
},
"endToEndIdentification": {
"type": "string"
},
"debtorAccount": {
"$ref": "#/components/schemas/AccountReferenceTO"
},
"ultimateDebtor": {
"type": "string"
},
"currency": {
"type": "object",
"properties": {
"currencyCode": {
"type": "string"
},
"defaultFractionDigits": {
"type": "integer",
"format": "int32"
},
"numericCode": {
"type": "integer",
"format": "int32"
},
"displayName": {
"type": "string"
},
"symbol": {
"type": "string"
}
}
},
"amount": {
"type": "number"
},
"creditorAccount": {
"$ref": "#/components/schemas/AccountReferenceTO"
},
"creditorAgent": {
"type": "string"
},
"creditorName": {
"type": "string"
},
"remittanceInformationUnstructured": {
"type": "string"
},
"requestedExecutionDate": {
"type": "string",
"format": "date"
},
"requestedExecutionTime": {
"type": "string",
"format": "date-time"
},
"ultimateCreditor": {
"type": "string"
},
"purposeCode": {
"type": "string"
},
"startDate": {
"type": "string",
"format": "date"
},
"endDate": {
"type": "string",
"format": "date"
},
"executionRule": {
"type": "string",
"enum": [
"FOLLOWING",
"PRECEDING"
]
},
"frequency": {
"type": "string"
},
"dayOfExecution": {
"type": "string"
}
}
},
"ResourcePaymentDataTO": {
"type": "object",
"properties": {
"payments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentTO"
}
},
"paymentProduct": {
"type": "string"
},
"paymentType": {
"type": "string",
"enum": [
"SINGLE",
"BULK",
"PERIODIC"
]
},
"rawPayment": {
"type": "string"
},
"psuAccount": {
"type": "string"
},
"links": {
"type": "array",
"xml": {
"name": "link",
"namespace": "http://www.w3.org/2005/Atom"
},
"items": {
"$ref": "#/components/schemas/Link"
}
}
}
}
},
"securitySchemes": {
"bg_auth": {
"type": "oauth2",
"in": "header",
"bearerFormat": "jwt",
"flows": {
"authorizationCode": {
"authorizationUrl": "http://keycloak:8080/auth/realms/multibanking/protocol/openid-connect/auth",
"tokenUrl": "http://keycloak:8080/auth/realms/multibanking/protocol/openid-connect/token"
}
}
}
}
}
}
