API Explorer

Berlin Group

Berlin Group v1.3 (38 APIs)

Bank

Accounts

Views

Counterparties

Transactions

Consent status request

        Read the status of an account information consent resource.
Typical Successful Response:

								
									
{ "consentStatus":"received" }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in BGv1.3 by getConsentStatus

Create consent

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.

Typical Successful Response:

								
									
{ "consentStatus":"received", "consentId":"1234-wertiq-983", "_links":{ "startAuthorisation":{ "href":"/v1.3/consents/1234-wertiq-983/authorisations" } } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in BGv1.3 by createConsent

Delete Consent

        The TPP can delete an account information consent object if needed.
Typical Successful Response:

								
									
{ }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in BGv1.3 by deleteConsent

Get Consent Authorisation Sub-Resources Request

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.

Typical Successful Response:

								
									
{ "authorisationIds":"faa3657e-13f0-4feb-a6c3-34bf21a9ae8e" }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in BGv1.3 by getConsentAuthorisation

Get Consent Request

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.

Typical Successful Response:

								
									
{ "access":{ "accounts":[{ "bban":"BARC12345612345678", "maskedPan":"123456xxxxxx1234", "iban":"FR7612345987650123456789014", "currency":"EUR", "msisdn":"+49 170 1234567", "pan":"5409050000000000" },{ "bban":"BARC12345612345678", "maskedPan":"123456xxxxxx1234", "iban":"FR7612345987650123456789014", "currency":"EUR", "msisdn":"+49 170 1234567", "pan":"5409050000000000" }] }, "recurringIndicator":false, "validUntil":"2020-12-31", "frequencyPerDay":4, "combinedServiceIndicator":false, "lastActionDate":"2019-06-30", "consentStatus":"received" }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in BGv1.3 by getConsentInformation

Read Account Details

        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
Typical Successful Response:

								
									
{ "cashAccountType":{ }, "product":"product", "resourceId":"resourceId", "bban":"BARC12345612345678", "_links":{ "balances":"/v1.3/payments/sepa-credit-transfers/1234-wertiq-983", "transactions":"/v1.3/payments/sepa-credit-transfers/1234-wertiq-983" }, "usage":"PRIV", "balances":"", "iban":"FR7612345987650123456789014", "linkedAccounts":"linkedAccounts", "name":"name", "currency":"EUR", "details":"details", "msisdn":"+49 170 1234567", "bic":"AAAADEBBXXX", "status":{ } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in BGv1.3 by readAccountDetails

Read Account List

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.

Typical Successful Response:

								
									
{ "accounts":[{ "cashAccountType":{ }, "product":"product", "resourceId":"resourceId", "bban":"BARC12345612345678", "_links":{ "balances":"/v1.3/payments/sepa-credit-transfers/1234-wertiq-983", "transactions":"/v1.3/payments/sepa-credit-transfers/1234-wertiq-983" }, "usage":"PRIV", "balances":"", "iban":"FR7612345987650123456789014", "linkedAccounts":"linkedAccounts", "name":"name", "currency":"EUR", "details":"details", "msisdn":"+49 170 1234567", "bic":"AAAADEBBXXX", "status":{ } },{ "cashAccountType":{ }, "product":"product", "resourceId":"resourceId", "bban":"BARC12345612345678", "_links":{ "balances":"/v1.3/payments/sepa-credit-transfers/1234-wertiq-983", "transactions":"/v1.3/payments/sepa-credit-transfers/1234-wertiq-983" }, "usage":"PRIV", "balances":"", "iban":"FR7612345987650123456789014", "linkedAccounts":"linkedAccounts", "name":"name", "currency":"EUR", "details":"details", "msisdn":"+49 170 1234567", "bic":"AAAADEBBXXX", "status":{ } }] }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in BGv1.3 by getAccountList

Read Balance

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.

Typical Successful Response:

								
									
{ "balances":"", "account":{ "bban":"BARC12345612345678", "maskedPan":"123456xxxxxx1234", "iban":"FR7612345987650123456789014", "currency":"EUR", "msisdn":"+49 170 1234567", "pan":"5409050000000000" } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in BGv1.3 by getBalances

Read Transaction Details

NOTE: This endpoint currently only returns example data.

        Reads transaction details from a given transaction addressed by "transactionId" on a given account addressed 
        by "account-id". This call is only available on transactions as reported in a JSON format. 
        
        **Remark:** Please note that the PATH might be already given in detail by the corresponding entry of the response 
        of the "Read Transaction List" call within the _links subfield.
Typical Successful Response:

								
									
{ "debtorAccount":{ "bban":"BARC12345612345678", "maskedPan":"123456xxxxxx1234", "iban":"FR7612345987650123456789014", "currency":"EUR", "msisdn":"+49 170 1234567", "pan":"5409050000000000" }, "creditorName":"Creditor Name", "_links":{ "transactionDetails":"/v1.3/payments/sepa-credit-transfers/1234-wertiq-983" }, "remittanceInformationStructured":"remittanceInformationStructured", "ultimateCreditor":"Ultimate Creditor", "bankTransactionCode":"PMNT-RCDT-ESCT", "debtorName":"Debtor Name", "valueDate":"2000-01-23", "endToEndId":"endToEndId", "transactionId":"transactionId", "currencyExchange":"", "ultimateDebtor":"Ultimate Debtor", "creditorAccount":{ "bban":"BARC12345612345678", "maskedPan":"123456xxxxxx1234", "iban":"FR7612345987650123456789014", "currency":"EUR", "msisdn":"+49 170 1234567", "pan":"5409050000000000" }, "mandateId":"mandateId", "purposeCode":{ }, "transactionAmount":{ "amount":"123", "currency":"EUR" }, "proprietaryBankTransactionCode":{ }, "bookingDate":{ }, "remittanceInformationUnstructured":"Ref Number Merchant", "checkId":"checkId", "creditorId":"creditorId", "entryReference":"entryReference" }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in BGv1.3 by getTransactionDetails

Read card account balances

NOTE: This endpoint currently only returns example data.

Reads balance data from a given card 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 Card Account List" call

Typical Successful Response:

								
									
{ "balances":"", "cardAccount":{ "bban":"BARC12345612345678", "maskedPan":"123456xxxxxx1234", "iban":"FR7612345987650123456789014", "currency":"EUR", "msisdn":"+49 170 1234567", "pan":"5409050000000000" } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in BGv1.3 by getCardAccountBalances

Read the SCA status of the consent authorisation.

This method returns the SCA status of a consent initiation's authorisation sub-resource.

Typical Successful Response:

								
									
{ "scaStatus":"started" }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in BGv1.3 by getConsentScaStatus

Read transaction list of a card account

Reads account data from a given card account addressed by "account-id".

Typical Successful Response:

								
									
{ "cardAccount":{ "maskedPan":"525412******3241" }, "transactions":{ "booked":[{ "cardTransactionId":"201710020036959", "transactionAmount":{ "currency":"EUR", "amount":"256.67" }, "transactionDate":"2017-10-25", "bookingDate":"2017-10-26", "originalAmount":{ "currency":"SEK", "amount":"2499" }, "cardAcceptorAddress":{ "city":"STOCKHOLM", "country":"SE" }, "maskedPan":"525412******3241", "proprietaryBankTransactionCode":"PURCHASE", "invoiced":false, "transactionDetails":"WIFIMARKET.SE" },{ "cardTransactionId":"201710020091863", "transactionAmount":{ "currency":"EUR", "amount":"10.72" }, "transactionDate":"2017-10-25", "bookingDate":"2017-10-26", "originalAmount":{ "currency":"SEK", "amount":"99" }, "cardAcceptorAddress":{ "city":"STOCKHOLM", "country":"SE" }, "maskedPan":"525412******8999", "proprietaryBankTransactionCode":"PURCHASE", "invoiced":false, "transactionDetails":"ICA SUPERMARKET SKOGHA" }], "pending":[], "_links":{ "cardAccount":{ "href":"/v1.3/card-accounts/3d9a81b3-a47d-4130-8765-a9c0ff861b99" } } } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in BGv1.3 by getCardAccountTransactionList

Read transaction list of an account

        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.
Typical Successful Response:

								
									
{ "account":{ "iban":"DE2310010010123456788" }, "transactions":{ "booked":[{ "transactionId":"1234567", "creditorName":"John Miles", "creditorAccount":{ "iban":"DE67100100101306118605" }, "transactionAmount":{ "currency":"EUR", "amount":"256.67" }, "bookingDate":"2017-10-25", "valueDate":"2017-10-26", "remittanceInformationUnstructured":"Example 1" },{ "transactionId":"1234568", "debtorName":"Paul Simpson", "debtorAccount":{ "iban":"NL76RABO0359400371" }, "transactionAmount":{ "currency":"EUR", "amount":"343.01" }, "bookingDate":"2017-10-25", "valueDate":"2017-10-26", "remittanceInformationUnstructured":"Example 2" }], "pending":[{ "transactionId":"1234569", "creditorName":"Claude Renault", "creditorAccount":{ "iban":"FR7612345987650123456789014" }, "transactionAmount":{ "currency":"EUR", "amount":"-100.03" }, "valueDate":"2017-10-26", "remittanceInformationUnstructured":"Example 3" }], "_links":{ "account":{ "href":"/v1.3/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f" } } } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in BGv1.3 by getTransactionList

Reads a list of card accounts

NOTE: This endpoint currently only returns example data.

Reads a list of card accounts with additional information, e.g. balance information.
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 card accounts depends then on the PSU ID and the stored consent addressed by consentId,
respectively the OAuth2 access token.

Typical Successful Response:

								
									
{ "cardAccounts":[{ "balances":"", "product":"product", "resourceId":"resourceId", "maskedPan":"123456xxxxxx1234", "_links":{ "balances":"/v1.3/payments/sepa-credit-transfers/1234-wertiq-983", "transactions":"/v1.3/payments/sepa-credit-transfers/1234-wertiq-983" }, "usage":"PRIV", "name":"name", "creditLimit":{ "amount":"123", "currency":"EUR" }, "currency":"EUR", "details":"details", "status":{ } },{ "balances":"", "product":"product", "resourceId":"resourceId", "maskedPan":"123456xxxxxx1234", "_links":{ "balances":"/v1.3/payments/sepa-credit-transfers/1234-wertiq-983", "transactions":"/v1.3/payments/sepa-credit-transfers/1234-wertiq-983" }, "usage":"PRIV", "name":"name", "creditLimit":{ "amount":"123", "currency":"EUR" }, "currency":"EUR", "details":"details", "status":{ } }] }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in BGv1.3 by getCardAccount

Reads details about a card account

NOTE: This endpoint currently only returns example data.

        Reads details about a card account. 
        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.
Typical Successful Response:

								
									
{ "balances":"", "product":"product", "resourceId":"resourceId", "maskedPan":"123456xxxxxx1234", "_links":{ "balances":"/v1.3/payments/sepa-credit-transfers/1234-wertiq-983", "transactions":"/v1.3/payments/sepa-credit-transfers/1234-wertiq-983" }, "usage":"PRIV", "name":"name", "creditLimit":{ "amount":"123", "currency":"EUR" }, "currency":"EUR", "details":"details", "status":{ } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in BGv1.3 by readCardAccount

Start the authorisation process for a consent

        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.
Typical Successful Response:

								
									
{ "scaStatus":"received", "psuMessage":"Please use your BankApp for transaction Authorisation.", "_links":{ "scaStatus":{ "href":"/v1.3/consents/qwer3456tzui7890/authorisations/123auth456" } } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in BGv1.3 by startConsentAuthorisation

Update PSU Data for consents

        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.
Typical Successful Response:

								
									
{ }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in BGv1.3 by updateConsentsPsuData

Confirmation of Funds Request

     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.     
Typical Successful Response:

								
									
{ "fundsAvailable":true }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in BGv1.3 by checkAvailabilityOfFunds

Get Cancellation Authorisation Sub-Resources Request

Retrieve a list of all created cancellation authorisation sub-resources.

Typical Successful Response:

								
									
{ }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in BGv1.3 by getPaymentInitiationCancellationAuthorisationInformation

Get Payment Information

    Returns the content of a payment object
Typical Successful Response:

								
									
{ "debtorAccount":{ "iban":"GR12 1234 5123 4511 3981 4475 477" }, "instructedAmount":{ "currency":"EUR", "amount":"1234" }, "creditorAccount":{ "iban":"GR12 1234 5123 4514 4575 3645 077" }, "creditorName":"70charname" }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in BGv1.3 by getPaymentInformation

Get Payment Initiation Authorisation Sub-Resources Request

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.

Typical Successful Response:

								
									
{ "jvalueToCaseclass":[{ "scaStatus":"received", "authorisationId":"940948c7-1c86-4d88-977e-e739bf2c1492", "psuMessage":"Please check your SMS at a mobile device.", "_links":{ "scaStatus":"/v1.3/payments/sepa-credit-transfers/940948c7-1c86-4d88-977e-e739bf2c1492" } },{ "scaStatus":"received", "authorisationId":"0ae75eee-deba-41d6-8116-1a4d6e05dd83", "psuMessage":"Please check your SMS at a mobile device.", "_links":{ "scaStatus":"/v1.3/payments/sepa-credit-transfers/0ae75eee-deba-41d6-8116-1a4d6e05dd83" } }] }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in BGv1.3 by getPaymentInitiationAuthorisation

Payment Cancellation Request

NOTE: This endpoint currently only returns example data.

        This method initiates the cancellation of a payment. Depending on the payment-service, the payment-product 
        and the ASPSP's implementation, this TPP call might be sufficient to cancel a payment. If an authorisation 
        of the payment cancellation is mandated by the ASPSP, a corresponding hyperlink will be contained in the 
        response message. Cancels the addressed payment with resource identification paymentId if applicable to the 
        payment-service, payment-product and received in product related timelines (e.g. before end of business day 
        for scheduled payments of the last business day before the scheduled execution day). The response to this 
        DELETE command will tell the TPP whether the * access method was rejected * access method was successful, 
        or * access method is generally applicable, but further authorisation processes are needed.
Typical Successful Response:

								
									
{ "challengeData":{ "otpMaxLength":0, "additionalInformation":"additionalInformation", "image":"image", "imageLink":"http://example.com/aeiou", "otpFormat":"characters", "data":["data","data"] }, "scaMethods":"", "_links":{ "startAuthorisationWithEncryptedPsuAuthentication":"/v1.3/payments/sepa-credit-transfers/1234-wertiq-983", "startAuthorisationWithAuthenticationMethodSelection":"/v1.3/payments/sepa-credit-transfers/1234-wertiq-983", "startAuthorisationWithPsuAuthentication":"/v1.3/payments/sepa-credit-transfers/1234-wertiq-983", "startAuthorisationWithPsuIdentification":"/v1.3/payments/sepa-credit-transfers/1234-wertiq-983", "startAuthorisation":"/v1.3/payments/sepa-credit-transfers/1234-wertiq-983" }, "chosenScaMethod":"", "transactionStatus":"ACCP" }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in BGv1.3 by cancelPayment

Payment initiation request

This method is used to initiate a payment at the ASPSP.

Variants of Payment Initiation Requests

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:

  • Payment products with payment information in JSON format:
    • sepa-credit-transfers
    • instant-sepa-credit-transfers
    • target-2-payments
    • cross-border-credit-transfers
  • Payment products with payment information in pain.001 XML format:
    • pain.001-sepa-credit-transfers
    • pain.001-instant-sepa-credit-transfers
    • pain.001-target-2-payments
    • pain.001-cross-border-credit-transfers
  • Furthermore the request body depends on the payment-service

    • payments: A single payment initiation request.
    • bulk-payments: A collection of several payment iniatiation requests.
      In case of a pain.001 message there are more than one payments contained in the *pain.001 message.
      In case of a JSON there are several JSON payment blocks contained in a joining list.
    • periodic-payments:
      Create a standing order initiation resource for recurrent i.e. periodic payments addressable under {paymentId}
      with all data relevant for the corresponding payment product and the execution of the standing order contained in a JSON body.

This is the first step in the API to initiate the related recurring/periodic payment.

Single and mulitilevel SCA Processes

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

Typical Successful Response:

								
									
{ "transactionStatus":"RCVD", "paymentId":"1234-wertiq-983", "_links":{ "scaRedirect":{ "href":"https://apisandbox.openbankproject.com/otp?flow=payment&paymentService=payments&paymentProduct=sepa_credit_transfers&paymentId=b0472c21-6cea-4ee0-b036-3e253adb3b0b" }, "self":{ "href":"/v1.3/payments/sepa-credit-transfers/1234-wertiq-983" }, "status":{ "href":"/v1.3/payments/1234-wertiq-983/status" }, "scaStatus":{ "href":"/v1.3/payments/1234-wertiq-983/authorisations/123auth456" } } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in BGv1.3 by initiatePayment

Payment initiation status request

Check the transaction status of a payment initiation.

Typical Successful Response:

								
									
{ "transactionStatus":"ACCP" }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in BGv1.3 by getPaymentInitiationStatus

Read the SCA Status of the payment authorisation

This method returns the SCA status of a payment initiation's authorisation sub-resource.

Typical Successful Response:

								
									
{ "scaStatus":"psuAuthenticated" }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in BGv1.3 by getPaymentInitiationScaStatus

Read the SCA status of the payment cancellation's authorisation.

This method returns the SCA status of a payment initiation's authorisation sub-resource.

Typical Successful Response:

								
									
{ "scaStatus":"psuAuthenticated" }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in BGv1.3 by getPaymentCancellationScaStatus

Start the authorisation process for a payment initiation

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:

  • The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceeding 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' #TODO
    • '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 preceeding
    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.
Typical Successful Response:

								
									
{ "challengeData":{ "scaStatus":"received", "authorisationId":"88695566-6642-46d5-9985-0d824624f507", "psuMessage":"Please check your SMS at a mobile device.", "_links":{ "scaStatus":"/v1.3/payments/sepa-credit-transfers/88695566-6642-46d5-9985-0d824624f507" } } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in BGv1.3 by startPaymentAuthorisation

Start the authorisation process for the cancellation of the addressed payment

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:

  • The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceeding 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' #TODO
    • '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 preceeding
    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.
Typical Successful Response:

								
									
{ "scaStatus":"received", "authorisationId":"8a49b79b-b400-4e6b-b88d-637c3a71479d", "psuMessage":"Please check your SMS at a mobile device.", "_links":{ "scaStatus":"/v1.3/payments/sepa-credit-transfers/PAYMENT_ID/8a49b79b-b400-4e6b-b88d-637c3a71479d" } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in BGv1.3 by startPaymentInitiationCancellationAuthorisation

Update PSU Data for payment initiation cancellation

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:

  • 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.

Typical Successful Response:

								
									
{ "scaStatus":"finalised", "authorisationId":"4f4a8b7f-9968-4183-92ab-ca512b396bfc", "psuMessage":"Please check your SMS at a mobile device.", "_links":{ "scaStatus":"/v1.3/payments/sepa-credit-transfers/PAYMENT_ID/4f4a8b7f-9968-4183-92ab-ca512b396bfc" } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in BGv1.3 by updatePaymentCancellationPsuData

Update PSU data for payment initiation

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:

  • 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.

NOTE: For this endpoint, for sandbox mode, the `scaAuthenticationData` is fixed value: 12345. To make the process work.
      Normally the app use will get SMS/EMAIL to get the value for this process.
Typical Successful Response:

								
									
{ "scaStatus":"finalised", "authorisationId":"88695566-6642-46d5-9985-0d824624f507", "psuMessage":"Please check your SMS at a mobile device.", "_links":{ "scaStatus":"/v1.3/payments/sepa-credit-transfers/88695566-6642-46d5-9985-0d824624f507" } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in BGv1.3 by updatePaymentPsuData

Create a signing basket resource

NOTE: This endpoint currently only returns example data.

Create a signing basket resource for authorising several transactions with one SCA method.
The resource identifications of these transactions are contained in the payload of this access method

Typical Successful Response:

								
									
{ "basketId":"1234-basket-567", "challengeData":{ "otpMaxLength":0, "additionalInformation":"additionalInformation", "image":"image", "imageLink":"http://example.com/aeiou", "otpFormat":"characters", "data":["data","data"] }, "scaMethods":"", "tppMessages":[{ "path":"path", "code":{ }, "text":{ }, "category":{ } },{ "path":"path", "code":{ }, "text":{ }, "category":{ } }], "_links":{ "scaStatus":"/v1.3/payments/sepa-credit-transfers/1234-wertiq-983", "startAuthorisationWithEncryptedPsuAuthentication":"/v1.3/payments/sepa-credit-transfers/1234-wertiq-983", "scaRedirect":"/v1.3/payments/sepa-credit-transfers/1234-wertiq-983", "startAuthorisationWithAuthenticationMethodSelection":"/v1.3/payments/sepa-credit-transfers/1234-wertiq-983", "startAuthorisationWithPsuAuthentication":"/v1.3/payments/sepa-credit-transfers/1234-wertiq-983", "scaOAuth":"/v1.3/payments/sepa-credit-transfers/1234-wertiq-983", "self":"/v1.3/payments/sepa-credit-transfers/1234-wertiq-983", "startAuthorisationWithPsuIdentification":"/v1.3/payments/sepa-credit-transfers/1234-wertiq-983", "startAuthorisation":"/v1.3/payments/sepa-credit-transfers/1234-wertiq-983", "startAuthorisationWithTransactionAuthorisation":"/v1.3/payments/sepa-credit-transfers/1234-wertiq-983", "status":"/v1.3/payments/sepa-credit-transfers/1234-wertiq-983" }, "chosenScaMethod":"", "transactionStatus":"ACCP", "psuMessage":{ } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in BGv1.3 by createSigningBasket

Delete the signing basket

NOTE: This endpoint currently only returns example data.

Delete the signing basket structure as long as no (partial) authorisation has yet been applied.
The undlerying transactions are not affected by this deletion.

Remark: The signing basket as such is not deletable after a first (partial) authorisation has been applied.
Nevertheless, single transactions might be cancelled on an individual basis on the XS2A interface.

Typical Successful Response:

								
									
{ }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in BGv1.3 by deleteSigningBasket

Get Signing Basket Authorisation Sub-Resources Request

NOTE: 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.

Typical Successful Response:

								
									
{ "authorisationIds":"" }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in BGv1.3 by getSigningBasketAuthorisation

Read the SCA status of the signing basket authorisation

NOTE: This endpoint currently only returns example data.

This method returns the SCA status of a signing basket's authorisation sub-resource.

Typical Successful Response:

								
									
{ "scaStatus":"psuAuthenticated" }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in BGv1.3 by getSigningBasketScaStatus

Read the status of the signing basket

NOTE: This endpoint currently only returns example data.

Returns the status of a signing basket object.

Typical Successful Response:

								
									
{ "transactionStatus":"RCVD" }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in BGv1.3 by getSigningBasketStatus

Returns the content of an signing basket object.

NOTE: This endpoint currently only returns example data.

Returns the content of an signing basket object.

Typical Successful Response:

								
									
{ "transactionStatus":"ACCP", "payments":"", "consents":"" }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in BGv1.3 by getSigningBasket

Start the authorisation process for a signing basket

NOTE: This endpoint currently only returns example data.

Create an authorisation sub-resource and start the authorisation process of a signing basket.
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 signing-baskets.

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 signing basket 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 preceeding 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' #TODO
    • '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 preceeding
    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.
Typical Successful Response:

								
									
{ "challengeData":{ "otpMaxLength":0, "additionalInformation":"additionalInformation", "image":"image", "imageLink":"http://example.com/aeiou", "otpFormat":"characters", "data":"data" }, "scaMethods":"", "scaStatus":"psuAuthenticated", "_links":{ "scaStatus":"/v1.3/payments/sepa-credit-transfers/1234-wertiq-983", "startAuthorisationWithEncryptedPsuAuthentication":"/v1.3/payments/sepa-credit-transfers/1234-wertiq-983", "scaRedirect":"/v1.3/payments/sepa-credit-transfers/1234-wertiq-983", "selectAuthenticationMethod":"/v1.3/payments/sepa-credit-transfers/1234-wertiq-983", "startAuthorisationWithPsuAuthentication":"/v1.3/payments/sepa-credit-transfers/1234-wertiq-983", "authoriseTransaction":"/v1.3/payments/sepa-credit-transfers/1234-wertiq-983", "scaOAuth":"/v1.3/payments/sepa-credit-transfers/1234-wertiq-983", "updatePsuIdentification":"/v1.3/payments/sepa-credit-transfers/1234-wertiq-983" }, "chosenScaMethod":"", "psuMessage":{ } }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in BGv1.3 by startSigningBasketAuthorisation

Update PSU Data for signing basket

NOTE: This endpoint currently only returns example data.

This method update PSU data on the signing basket resource if needed.
It may authorise a igning basket 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.

Typical Successful Response:

								
									
{ "jvalueToCaseclass":"" }
Headers:

								
									
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in BGv1.3 by updateSigningBasketPsuData