Berlin Group
|
Berlin Group v1.3 (38 APIs)
API Host: https://apisandbox.strings.my
BankAccountsViewsCounterpartiesTransactionsConsent status request
Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in BGv1.3 by getConsentStatus
Create consentThis method create a consent resource, defining access rights to dedicated accounts of Side Effects Optional Extension: As another option an ASPSP might optionally also accept a command, where only access rights are inserted without mentioning the addressed account. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in BGv1.3 by createConsent
Delete Consent
Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in BGv1.3 by deleteConsent
Get Consent Authorisation Sub-Resources RequestReturn 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 Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in BGv1.3 by getConsentAuthorisation
Get Consent RequestReturns the content of an account information consent object. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in BGv1.3 by getConsentInformation
Read Account DetailsReads details about an account, with balances where required. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in BGv1.3 by readAccountDetails
Read Account ListRead the identifiers of the available payment account together with It is assumed that a consent of the PSU to this access is already given and stored on the ASPSP system. Returns all identifiers of the accounts, to which an account access has been granted to through Remark: Note that the /consents endpoint optionally offers to grant an access on all available Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in BGv1.3 by getAccountList
Read BalanceReads 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 The account-id is constant at least throughout the lifecycle of a given consent. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in BGv1.3 by getBalances
Read Transaction DetailsNOTE: This endpoint currently only returns example data. Reads transaction details from a given transaction addressed by "transactionId" on a given account addressed Remark: Please note that the PATH might be already given in detail by the corresponding entry of the response Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in BGv1.3 by getTransactionDetails
Read card account balancesReads balance data from a given card account addressed by Remark: This account-id can be a tokenised identification due Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in BGv1.3 by getCardAccountBalances
Read the SCA status of the consent authorisationThis method returns the SCA status of a consent initiation's authorisation sub-resource. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in BGv1.3 by getConsentScaStatus
Read transaction list of a card accountReads account data from a given card account addressed by "account-id". Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in BGv1.3 by getCardAccountTransactionList
Read transaction list of an accountRead transaction reports or transaction lists of a given account ddressed by "account-id", Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in BGv1.3 by getTransactionList
Reads a list of card accountsNOTE: This endpoint currently only returns example data. Reads a list of card accounts with additional information, e.g. balance information. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in BGv1.3 by getCardAccounts
Reads details about a card accountReads details about a card account. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in BGv1.3 by readCardAccount
Start the authorisation process for a consentCreate an authorisation sub-resource and start the authorisation process of a consent. This applies in the following scenarios: * The ASPSP has indicated with an 'startAuthorisation' hyperlink The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in BGv1.3 by startConsentAuthorisation
Update PSU Data for consentsThis method update PSU data on the consents resource if needed. It may authorise a consent within the Embedded Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in BGv1.3 by updateConsentsPsuData
Confirmation of Funds RequestCreates a confirmation of funds request at the ASPSP. Checks whether a specific amount is available at point Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in BGv1.3 by checkAvailabilityOfFunds
Get Cancellation Authorisation Sub-Resources RequestRetrieve a list of all created cancellation authorisation sub-resources. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in BGv1.3 by getPaymentInitiationCancellationAuthorisationInformation
Get Payment InformationReturns the content of a payment object Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in BGv1.3 by getPaymentInformation
Get Payment Initiation Authorisation Sub-Resources RequestRead 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 Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in BGv1.3 by getPaymentInitiationAuthorisation
Payment Cancellation RequestNOTE: This endpoint currently only returns example data. This method initiates the cancellation of a payment. Depending on the payment-service, the payment-product Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in BGv1.3 by cancelPayment
Payment initiation requestThis method is used to initiate a payment at the ASPSP. Variants of Payment Initiation RequestsThis 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:
This is the first step in the API to initiate the related recurring/periodic payment. Single and mulitilevel SCA ProcessesThe Payment Initiation Requests are independent from the need of one ore multilevel 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, Additional Instructions: for PAYMENT_SERVICE use payments for PAYMENT_PRODUCT use sepa-credit-transfers Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in BGv1.3 by initiatePayment
Payment initiation status requestCheck the transaction status of a payment initiation. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in BGv1.3 by getPaymentInitiationStatus
Read the SCA Status of the payment authorisationThis method returns the SCA status of a payment initiation's authorisation sub-resource. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in BGv1.3 by getPaymentInitiationScaStatus
Read the SCA status of the payment cancellation's authorisationThis method returns the SCA status of a payment initiation's authorisation sub-resource. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in BGv1.3 by getPaymentCancellationScaStatus
Start the authorisation process for a payment initiationCreate an authorisation sub-resource and start the authorisation process. This method is iterated n times for a n times SCA authorisation in a The ASPSP might make the usage of this access method unnecessary in case The start authorisation process is a process which is needed for creating a new authorisation This applies in the following scenarios:
Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in BGv1.3 by startPaymentAuthorisation
Start the authorisation process for the cancellation of the addressed paymentCreates an authorisation sub-resource and start the authorisation process of the cancellation of the addressed payment. This method is iterated n times for a n times SCA authorisation in a The ASPSP might make the usage of this access method unnecessary in case The start authorisation process is a process which is needed for creating a new authorisation This applies in the following scenarios:
Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in BGv1.3 by startPaymentInitiationCancellationAuthorisation
Update PSU Data for payment initiation cancellationThis method updates PSU data on the cancellation authorisation resource if needed. Independently from the SCA Approach it supports e.g. the selection of 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,
The SCA Approach might depend on the chosen SCA method.
There are the following request types on this access path: Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in BGv1.3 by updatePaymentCancellationPsuData
Update PSU data for payment initiationThis methods updates PSU data on the authorisation resource if needed. Independently from the SCA Approach it supports e.g. the selection of There are several possible Update PSU Data requests in the context of payment initiation services needed,
The SCA Approach might depend on the chosen SCA method.
There are the following request types on this access path:
Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in BGv1.3 by updatePaymentPsuData
Create a signing basket resourceNOTE: This endpoint currently only returns example data. Create a signing basket resource for authorising several transactions with one SCA method. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in BGv1.3 by createSigningBasket
Delete the signing basketNOTE: This endpoint currently only returns example data. Delete the signing basket structure as long as no (partial) authorisation has yet been applied. Remark: The signing basket as such is not deletable after a first (partial) authorisation has been applied. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in BGv1.3 by deleteSigningBasket
Get Signing Basket Authorisation Sub-Resources RequestNOTE: This endpoint currently only returns example data. 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 Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in BGv1.3 by getSigningBasketAuthorisation
Read the SCA status of the signing basket authorisationNOTE: This endpoint currently only returns example data. This method returns the SCA status of a signing basket's authorisation sub-resource. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in BGv1.3 by getSigningBasketScaStatus
Read the status of the signing basketNOTE: This endpoint currently only returns example data. Returns the status of a signing basket object. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in BGv1.3 by getSigningBasketStatus
Returns the content of an signing basket objectNOTE: This endpoint currently only returns example data. Returns the content of an signing basket object. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in BGv1.3 by getSigningBasket
Start the authorisation process for a signing basketNOTE: This endpoint currently only returns example data. Create an authorisation sub-resource and start the authorisation process of a signing basket. This method is iterated n times for a n times SCA authorisation in a The ASPSP might make the usage of this access method unnecessary in case The start authorisation process is a process which is needed for creating a new authorisation This applies in the following scenarios:
Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in BGv1.3 by startSigningBasketAuthorisation
Update PSU Data for signing basketNOTE: This endpoint currently only returns example data. This method update PSU data on the signing basket resource if needed. Independently from the SCA Approach it supports e.g. the selection of 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,
The SCA Approach might depend on the chosen SCA method.
There are the following request types on this access path: Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in BGv1.3 by updateSigningBasketPsuData
|