{"swagger":"2.0","info":{"title":"BG Berlin Group","description":"Creative Commons Attribution-NoDerivatives 4.0 International (CC BY-ND)","contact":{"name":"TESOBE GmbH. / Open Bank Project","url":"https://openbankproject.com","email":"contact@tesobe.com"},"version":"v1.3"},"host":"api.ttk.com.mk","basePath":"/","schemes":["http","https"],"securityDefinitions":{"directLogin":{"type":"apiKey","description":"https://github.com/OpenBankProject/OBP-API/wiki/Direct-Login","in":"header","name":"Authorization"},"gatewayLogin":{"type":"apiKey","description":"https://github.com/OpenBankProject/OBP-API/wiki/Gateway-Login","in":"header","name":"Authorization"}},"security":[{"directLogin":[],"gatewayLogin":[]}],"paths":{"/berlin-group/v1.3/PAYMENT_SERVICE/PAYMENT_PRODUCT":{"post":{"tags":["Payment Initiation Service (PIS)","Berlin-Group-M"],"summary":"Payment initiation request","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"
This method is used to initiate a payment at the ASPSP.
This method to initiate a payment initiation at the ASPSP can be sent with either a JSON body or an pain.001 body depending on the payment product in the path.
There are the following payment products:
Furthermore the request body depends on the payment-service
This is the first step in the API to initiate the related recurring/periodic payment.
The Payment Initiation Requests are independent from the need of one ore multilevel
SCA processing, i.e. independent from the number of authorisations needed for the execution of payments.
But the response messages are specific to either one SCA processing or multilevel SCA processing.
For payment initiation with multilevel SCA, this specification requires an explicit start of the authorisation,
i.e. links directly associated with SCA processing like 'scaRedirect' or 'scaOAuth' cannot be contained in the
response message of a Payment Initation Request for a payment, where multiple authorisations are needed.
Also if any data is needed for the next action, like selecting an SCA method is not supported in the response,
since all starts of the multiple authorisations are fully equal.
In these cases, first an authorisation sub-resource has to be generated following the 'startAuthorisation' link.
Additional Instructions:
for PAYMENT_SERVICE use payments
for PAYMENT_PRODUCT use sepa-credit-transfers
Authentication is Mandatory
","operationId":"BGv1.3-initiatePayment","parameters":[{"in":"body","name":"body","description":"SepaCreditTransfersBerlinGroupV13 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/SepaCreditTransfersBerlinGroupV13"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/berlin-group/v1.3/PAYMENT_SERVICE/PAYMENT_PRODUCT/PAYMENTID":{"get":{"tags":["Payment Initiation Service (PIS)","Berlin-Group-M"],"summary":"Get Payment Information","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Returns the content of a payment object
Authentication is Mandatory
","operationId":"BGv1.3-getPaymentInformation","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/berlin-group/v1.3/PAYMENT_SERVICE/PAYMENT_PRODUCT/PAYMENTID/authorisations":{"get":{"tags":["Payment Initiation Service (PIS)","Berlin-Group-M"],"summary":"Get Payment Initiation Authorisation Sub-Resources Request","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Read a list of all authorisation subresources IDs which have been created.
This function returns an array of hyperlinks to all generated authorisation sub-resources.
Authentication is Mandatory
","operationId":"BGv1.3-getPaymentInitiationAuthorisation","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/berlin-group/v1.3/PAYMENT_SERVICE/PAYMENT_PRODUCT/PAYMENTID/cancellation-authorisations":{"get":{"tags":["Payment Initiation Service (PIS)","Berlin-Group-M"],"summary":"Get Cancellation Authorisation Sub-Resources Request","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Retrieve a list of all created cancellation authorisation sub-resources.
Authentication is Mandatory
","operationId":"BGv1.3-getPaymentInitiationCancellationAuthorisationInformation","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/berlin-group/v1.3/PAYMENT_SERVICE/PAYMENT_PRODUCT/PAYMENTID/cancellation-authorisations/CANCELLATIONID":{"get":{"tags":["Payment Initiation Service (PIS)","Berlin-Group-M"],"summary":"Read the SCA status of the payment cancellation's authorisation.","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"This method returns the SCA status of a payment initiation's authorisation sub-resource.
Authentication is Mandatory
","operationId":"BGv1.3-getPaymentCancellationScaStatus","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/berlin-group/v1.3/PAYMENT_SERVICE/PAYMENT_PRODUCT/PAYMENT_ID/authorisations":{"post":{"tags":["Payment Initiation Service (PIS)","Berlin-Group-M"],"summary":"Start the authorisation process for a payment initiation","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Create an authorisation sub-resource and start the authorisation process.
The message might in addition transmit authentication and authorisation related data.
This method is iterated n times for a n times SCA authorisation in a
corporate context, each creating an own authorisation sub-endpoint for
the corresponding PSU authorising the transaction.
The ASPSP might make the usage of this access method unnecessary in case
of only one SCA process needed, since the related authorisation resource
might be automatically created by the ASPSP after the submission of the
payment data with the first POST payments/{payment-product} call.
The start authorisation process is a process which is needed for creating a new authorisation
or cancellation sub-resource.
This applies in the following scenarios:
Authentication is Mandatory
","operationId":"BGv1.3-startPaymentAuthorisation","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/berlin-group/v1.3/PAYMENT_SERVICE/PAYMENT_PRODUCT/PAYMENT_ID/authorisations/AUTHORISATION_ID":{"get":{"tags":["Payment Initiation Service (PIS)","Berlin-Group-M"],"summary":"Read the SCA Status of the payment authorisation","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"This method returns the SCA status of a payment initiation's authorisation sub-resource.
Authentication is Mandatory
","operationId":"BGv1.3-getPaymentInitiationScaStatus","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"put":{"tags":["Payment Initiation Service (PIS)","Berlin-Group-M"],"summary":"Update PSU data for payment initiation","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"This methods updates PSU data on the authorisation resource if needed.
It may authorise a payment within the Embedded SCA Approach where needed.
Independently from the SCA Approach it supports e.g. the selection of
the authentication method and a non-SCA PSU authentication.
There are several possible Update PSU Data requests in the context of payment initiation services needed,
which depends on the SCA approach:
The SCA Approach might depend on the chosen SCA method.
For that reason, the following possible Update PSU Data request can apply to all SCA approaches:
There are the following request types on this access path:
* Update PSU Identification
* Update PSU Authentication
* Select PSU Autorization Method
WARNING: This method need a reduced header,
therefore many optional elements are not present.
Maybe in a later version the access path will change.
* Transaction Authorisation
WARNING: This method need a reduced header,
therefore many optional elements are not present.
Maybe in a later version the access path will change.
NOTE: For this endpoint, for sandbox mode, the `scaAuthenticationData` is fixed value: 123. To make the process work. Normally the app use will get SMS/EMAIL to get the value for this process.
Authentication is Mandatory
","operationId":"BGv1.3-updatePaymentPsuData","parameters":[{"in":"body","name":"body","description":"JvalueCaseClass object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/JvalueCaseClass"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/berlin-group/v1.3/PAYMENT_SERVICE/PAYMENT_PRODUCT/PAYMENT_ID/cancellation-authorisations":{"post":{"tags":["Payment Initiation Service (PIS)","Berlin-Group-M"],"summary":"Start the authorisation process for the cancellation of the addressed payment","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Creates an authorisation sub-resource and start the authorisation process of the cancellation of the addressed payment.
The message might in addition transmit authentication and authorisation related data.
This method is iterated n times for a n times SCA authorisation in a
corporate context, each creating an own authorisation sub-endpoint for
the corresponding PSU authorising the cancellation-authorisation.
The ASPSP might make the usage of this access method unnecessary in case
of only one SCA process needed, since the related authorisation resource
might be automatically created by the ASPSP after the submission of the
payment data with the first POST payments/{payment-product} call.
The start authorisation process is a process which is needed for creating a new authorisation
or cancellation sub-resource.
This applies in the following scenarios:
Authentication is Mandatory
","operationId":"BGv1.3-startPaymentInitiationCancellationAuthorisation","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/berlin-group/v1.3/PAYMENT_SERVICE/PAYMENT_PRODUCT/PAYMENT_ID/cancellation-authorisations/CANCELLATIONID":{"put":{"tags":["Payment Initiation Service (PIS)","Berlin-Group-M"],"summary":"Update PSU Data for payment initiation cancellation","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"This method updates PSU data on the cancellation authorisation resource if needed.
It may authorise a cancellation of the payment within the Embedded SCA Approach where needed.
Independently from the SCA Approach it supports e.g. the selection of
the authentication method and a non-SCA PSU authentication.
This methods updates PSU data on the cancellation authorisation resource if needed.
There are several possible Update PSU Data requests in the context of a cancellation authorisation within the payment initiation services needed,
which depends on the SCA approach:
The SCA Approach might depend on the chosen SCA method.
For that reason, the following possible Update PSU Data request can apply to all SCA approaches:
There are the following request types on this access path:
* Update PSU Identification
* Update PSU Authentication
* Select PSU Autorization Method
WARNING: This method need a reduced header,
therefore many optional elements are not present.
Maybe in a later version the access path will change.
* Transaction Authorisation
WARNING: This method need a reduced header,
therefore many optional elements are not present.
Maybe in a later version the access path will change.
Authentication is Mandatory
","operationId":"BGv1.3-updatePaymentCancellationPsuData","parameters":[{"in":"body","name":"body","description":"JvalueCaseClass object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/JvalueCaseClass"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/berlin-group/v1.3/PAYMENT_SERVICE/PAYMENT_PRODUCT/PAYMENT_ID/status":{"get":{"tags":["Payment Initiation Service (PIS)","Berlin-Group-M"],"summary":"Payment initiation status request","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Check the transaction status of a payment initiation.
Authentication is Mandatory
","operationId":"BGv1.3-getPaymentInitiationStatus","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/berlin-group/v1.3/accounts":{"get":{"tags":["Account Information Service (AIS)","Berlin-Group-M"],"summary":"Read Account List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Read the identifiers of the available payment account together with
booking balance information, depending on the consent granted.
It is assumed that a consent of the PSU to this access is already given and stored on the ASPSP system.
The addressed list of accounts depends then on the PSU ID and the stored consent addressed by consentId,
respectively the OAuth2 access token.
Returns all identifiers of the accounts, to which an account access has been granted to through
the /consents endpoint by the PSU.
In addition, relevant information about the accounts and hyperlinks to corresponding account
information resources are provided if a related consent has been already granted.
Remark: Note that the /consents endpoint optionally offers to grant an access on all available
payment accounts of a PSU.
In this case, this endpoint will deliver the information about all available payment accounts
of the PSU at this ASPSP.
Authentication is Mandatory
","operationId":"BGv1.3-getAccountList","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/berlin-group/v1.3/accounts/{ACCOUNT_ID}":{"get":{"tags":["Account Information Service (AIS)","Berlin-Group-M"],"summary":"Read Account Details","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Reads details about an account, with balances where required.
It is assumed that a consent of the PSU to this access is already given and stored on the ASPSP system.
The addressed details of this account depends then on the stored consent addressed by consentId,
respectively the OAuth2 access token. NOTE: The account-id can represent a multicurrency account.
In this case the currency code is set to "XXX". Give detailed information about the addressed account.
Give detailed information about the addressed account together with balance information
Authentication is Mandatory
","operationId":"BGv1.3-readAccountDetails","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/berlin-group/v1.3/accounts/{ACCOUNT_ID}/balances":{"get":{"tags":["Account Information Service (AIS)","Berlin-Group-M"],"summary":"Read Balance","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Reads account data from a given account addressed by "account-id".
Remark: This account-id can be a tokenised identification due to data protection reason since the path
information might be logged on intermediary servers within the ASPSP sphere.
This account-id then can be retrieved by the "GET Account List" call.
The account-id is constant at least throughout the lifecycle of a given consent.
Authentication is Mandatory
","operationId":"BGv1.3-getBalances","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/berlin-group/v1.3/accounts/{ACCOUNT_ID}/transactions":{"get":{"tags":["Account Information Service (AIS)","Berlin-Group-M"],"summary":"Read transaction list of an account","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Read transaction reports or transaction lists of a given account ddressed by "account-id",
depending on the steering parameter "bookingStatus" together with balances.
For a given account, additional parameters are e.g. the attributes "dateFrom" and "dateTo".
The ASPSP might add balance information, if transaction lists without balances are not supported.
Authentication is Mandatory
","operationId":"BGv1.3-getTransactionList","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/berlin-group/v1.3/card-accounts/{ACCOUNT_ID}/transactions":{"get":{"tags":["Account Information Service (AIS)","Berlin-Group-M"],"summary":"Read transaction list of a card account","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Reads account data from a given card account addressed by "account-id".
Authentication is Mandatory
","operationId":"BGv1.3-getCardAccountTransactionList","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/berlin-group/v1.3/consents":{"post":{"tags":["Account Information Service (AIS)","Berlin-Group-M"],"summary":"Create consent","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"This method create a consent resource, defining access rights to dedicated accounts of
a given PSU-ID. These accounts are addressed explicitly in the method as
parameters as a core function.
Side Effects
When this Consent Request is a request where the "recurringIndicator" equals "true",
and if it exists already a former consent for recurring access on account information
for the addressed PSU, then the former consent automatically expires as soon as the new
consent request is authorised by the PSU.
Optional Extension:
As an option, an ASPSP might optionally accept a specific access right on the access on all psd2 related services for all available accounts.
As another option an ASPSP might optionally also accept a command, where only access rights are inserted without mentioning the addressed account.
The relation to accounts is then handled afterwards between PSU and ASPSP.
This option is not supported for the Embedded SCA Approach.
As a last option, an ASPSP might in addition accept a command with access rights
* to see the list of available payment accounts or
* to see the list of available payment accounts with balances.
Authentication is Mandatory
","operationId":"BGv1.3-createConsent","parameters":[{"in":"body","name":"body","description":"PostConsentJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostConsentJson"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/PostConsentResponseJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/berlin-group/v1.3/consents/CONSENTID":{"delete":{"tags":["Account Information Service (AIS)","Berlin-Group-M"],"summary":"Delete Consent","security":[{"directLogin":[],"gatewayLogin":[]}],"description":" The TPP can delete an account information consent object if needed.
Authentication is Mandatory
","operationId":"BGv1.3-deleteConsent","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}}],"responses":{"204":{"description":"Success","schema":{"$ref":"#/definitions/EmptyClassJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"get":{"tags":["Account Information Service (AIS)","Berlin-Group-M"],"summary":"Get Consent Request","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Returns the content of an account information consent object.
This is returning the data for the TPP especially in cases,
where the consent was directly managed between ASPSP and PSU e.g. in a re-direct SCA Approach.
Authentication is Mandatory
","operationId":"BGv1.3-getConsentInformation","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/berlin-group/v1.3/consents/CONSENTID/authorisations":{"get":{"tags":["Account Information Service (AIS)","Berlin-Group-M"],"summary":"Get Consent Authorisation Sub-Resources Request","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Return a list of all authorisation subresources IDs which have been created.
This function returns an array of hyperlinks to all generated authorisation sub-resources.
Authentication is Mandatory
","operationId":"BGv1.3-getConsentAuthorisation","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"post":{"tags":["Account Information Service (AIS)","Berlin-Group-M"],"summary":"Start the authorisation process for a consent","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Create an authorisation sub-resource and start the authorisation process of a consent.
The message might in addition transmit authentication and authorisation related data.
his method is iterated n times for a n times SCA authorisation in a corporate context,
each creating an own authorisation sub-endpoint for the corresponding PSU authorising the consent.
The ASPSP might make the usage of this access method unnecessary, since the related authorisation
resource will be automatically created by the ASPSP after the submission of the consent data with the
first POST consents call. The start authorisation process is a process which is needed for creating
a new authorisation or cancellation sub-resource.
This applies in the following scenarios: * The ASPSP has indicated with an 'startAuthorisation' hyperlink
in the preceding Payment Initiation Response that an explicit start of the authorisation process is needed by the TPP.
The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using
the extended forms.
* 'startAuthorisationWithPsuIdentfication',
* 'startAuthorisationWithPsuAuthentication'
* 'startAuthorisationWithEncryptedPsuAuthentication'
* 'startAuthorisationWithAuthentciationMethodSelection'
* The related payment initiation cannot yet be executed since a multilevel SCA is mandated.
* The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment Cancellation
Response that an explicit start of the authorisation process is needed by the TPP.
The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by
using the extended forms as indicated above.
* The related payment cancellation request cannot be applied yet since a multilevel SCA is mandate for executing the cancellation.
* The signing basket needs to be authorised yet.
Authentication is Mandatory
","operationId":"BGv1.3-startConsentAuthorisation","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/berlin-group/v1.3/consents/CONSENTID/authorisations/AUTHORISATIONID":{"get":{"tags":["Account Information Service (AIS)","Berlin-Group-M"],"summary":"Read the SCA status of the consent authorisation","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"This method returns the SCA status of a consent initiation's authorisation sub-resource.
Authentication is Mandatory
","operationId":"BGv1.3-getConsentScaStatus","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"put":{"tags":["Account Information Service (AIS)","Berlin-Group-M"],"summary":"Update PSU Data for consents","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"This method update PSU data on the consents resource if needed. It may authorise a consent within the Embedded
SCA Approach where needed. Independently from the SCA Approach it supports
e.g. the selection of the authentication method and a non-SCA PSU authentication.
This methods updates PSU data on the cancellation authorisation resource if needed.
There are several possible Update PSU Data requests in the context of a consent request if needed,
which depends on the SCA approach: * Redirect SCA Approach: A specific Update PSU Data Request is applicable
for
* the selection of authentication methods, before choosing the actual SCA approach.
* Decoupled SCA Approach: A specific Update PSU Data Request is only applicable for
* adding the PSU Identification, if not provided yet in the Payment Initiation Request or the Account Information Consent Request,
or if no OAuth2 access token is used, or
* the selection of authentication methods.
* Embedded SCA Approach: The Update PSU Data Request might be used
* to add credentials as a first factor authentication data of the PSU and
* to select the authentication method and
* transaction authorisation.
The SCA Approach might depend on the chosen SCA method. For that reason,
the following possible Update PSU Data request can apply to all SCA approaches:
* Select an SCA method in case of several SCA methods are available for the customer. There are the following request types on this access path:
* Update PSU Identification * Update PSU Authentication
* Select PSU Autorization Method WARNING: This method need a reduced header, therefore many optional elements are not present.
Maybe in a later version the access path will change.
* Transaction Authorisation WARNING: This method need a reduced header, therefore many optional elements are not present.
Maybe in a later version the access path will change.
Authentication is Mandatory
","operationId":"BGv1.3-updateConsentsPsuData","parameters":[{"in":"body","name":"body","description":"JvalueCaseClass object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/JvalueCaseClass"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/EmptyClassJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/berlin-group/v1.3/consents/CONSENTID/status":{"get":{"tags":["Account Information Service (AIS)","Berlin-Group-M"],"summary":"Consent status request","security":[{"directLogin":[],"gatewayLogin":[]}],"description":" Read the status of an account information consent resource.
Authentication is Mandatory
","operationId":"BGv1.3-getConsentStatus","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/berlin-group/v1.3/funds-confirmations":{"post":{"tags":["Confirmation of Funds Service (PIIS)","Berlin-Group-M"],"summary":"Confirmation of Funds Request","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Creates a confirmation of funds request at the ASPSP. Checks whether a specific amount is available at point
of time of the request on an account linked to a given tuple card issuer(TPP)/card number, or addressed by
IBAN and TPP respectively. If the related extended services are used a conditional Consent-ID is contained
in the header. This field is contained but commented out in this specification.
Authentication is Mandatory
","operationId":"BGv1.3-checkAvailabilityOfFunds","parameters":[{"in":"body","name":"body","description":"JvalueCaseClass object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/JvalueCaseClass"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}}},"definitions":{"ErrorUserNotLoggedIn":{"properties":{"message":{"type":"string","example":"OBP-20001: User not logged in. Authentication is required!"}}},"AmountOfMoneyJsonV121":{"required":["currency","amount"],"properties":{"currency":{"type":"string","example":"EUR"},"amount":{"type":"string","example":"0"}}},"SepaCreditTransfersBerlinGroupV13":{"required":["debtorAccount","instructedAmount","creditorAccount","creditorName"],"properties":{"remittanceInformationStructured":{"type":"string","example":""},"requestedExecutionDate":{"type":"string","example":""},"remittanceInformationUnstructured":{"type":"string","example":""},"ultimateDebtor":{"type":"string","example":""},"exchangeRateInformation":{"type":"string","example":""},"debtorAccount":{"$ref":"#/definitions/PaymentAccount"},"creditorAgentName":{"type":"string","example":""},"remittanceInformationUnstructuredArray":{"type":"string","example":""},"purposeCode":{"type":"string","example":""},"endToEndIdentification":{"type":"string","example":""},"instructedAmount":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"creditorAgent":{"type":"string","example":""},"instructionIdentification":{"type":"string","example":""},"creditorAccount":{"$ref":"#/definitions/PaymentAccount"},"creditorAddress":{"type":"string","example":""},"debtorName":{"type":"string","example":""},"creditorId":{"type":"string","example":""},"remittanceInformationStructuredArray":{"type":"string","example":""},"ultimateCreditor":{"type":"string","example":""},"serviceLevel":{"type":"string","example":""},"currencyOfTransfer":{"type":"string","example":""},"debtorId":{"type":"string","example":""},"creditorName":{"type":"string","example":"John Miles"},"chargeBearer":{"type":"string","example":""},"creditorNameAndAddress":{"type":"string","example":""},"requestedExecutionTime":{"type":"string","example":""}}},"PaymentAccount":{"required":["iban"],"properties":{"iban":{"type":"string","example":"12345"}}},"EmptyClassJson":{"required":["jsonString"],"properties":{"jsonString":{"type":"string","example":"{}"}}},"PostConsentJson":{"required":["validUntil","recurringIndicator","frequencyPerDay","combinedServiceIndicator","access"],"properties":{"validUntil":{"type":"string","example":"2020-12-31"},"recurringIndicator":{"type":"boolean","example":"true"},"frequencyPerDay":{"type":"integer","format":"int32","example":"4"},"combinedServiceIndicator":{"type":"boolean","example":"false"},"access":{"$ref":"#/definitions/ConsentAccessJson"}}},"JvalueCaseClass":{"required":["jvalueToCaseclass"],"properties":{"jvalueToCaseclass":{"type":"object","properties":{"scaAuthenticationData":{"type":"string","example":"123"}},"required":["scaAuthenticationData"]}}},"PostConsentResponseJson":{"required":["consentId","consentStatus","_links"],"properties":{"consentId":{"type":"string","example":"1234-wertiq-983"},"consentStatus":{"type":"string","example":"received"},"_links":{"$ref":"#/definitions/ConsentLinksV13"}}},"ConsentAccessAccountsJson":{"properties":{"msisdn":{"type":"string","example":""},"maskedPan":{"type":"string","example":""},"currency":{"type":"string","example":""},"pan":{"type":"string","example":""},"iban":{"type":"string","example":"DE91 1000 0000 0123 4567 89"},"bban":{"type":"string","example":""}}},"ConsentAccessJson":{"properties":{"allPsd2":{"type":"string","example":""},"balances":{"type":"array","items":{"$ref":"#/definitions/ConsentAccessAccountsJson"}},"availableAccounts":{"type":"string","example":""},"transactions":{"type":"array","items":{"$ref":"#/definitions/ConsentAccessAccountsJson"}},"accounts":{"type":"array","items":{"$ref":"#/definitions/ConsentAccessAccountsJson"}}}},"ConsentLinksV13":{"required":["startAuthorisation"],"properties":{"startAuthorisation":{"type":"string","example":"/v1.3/consents/1234-wertiq-983/authorisations"}}}}}