API Explorer

Berlin Group
Login

Berlin Group v1.3 (5 APIs)

API Host: https://openlab.openbankproject.com

Bank

Accounts

Views

Counterparties

Transactions

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.

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "consentId":"1234-wertiq-983",
  "consentStatus":"received",
  "_links":{
    "startAuthorisation":"/v1.3/consents/1234-wertiq-983/authorisations"
  }
}
Headers:
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in BGv1.3 by createConsent

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.

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "accounts":[{
    "resourceId":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
    "iban":"DE91 1000 0000 0123 4567 89",
    "bban":" 1000 0000 0123 4567 89",
    "currency":"EUR",
    "name":"TOM",
    "product":"AC",
    "cashAccountType":"AC",
    "bic":"AAAADEBBXXX",
    "balances":{
      "balanceAmount":{
        "currency":"EUR",
        "amount":"50.89"
      },
      "balanceType":"AC",
      "lastChangeDateTime":"2020-07-02T10:23:57.81Z",
      "referenceDate":"2020-07-02",
      "lastCommittedTransaction":"entryReference of the last commited transaction to support the TPP in identifying whether all PSU transactions are already known."
    },
    "_links":{
      "balances":{
        "href":"/v1.3/accounts/8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0/balances"
      }
    }
  }]
}
Headers:
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
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.

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "account":{
    "iban":"DE91 1000 0000 0123 4567 89"
  },
  "balances":[{
    "balanceAmount":{
      "currency":"EUR",
      "amount":"50.89"
    },
    "balanceType":"AC",
    "lastChangeDateTime":"yyyy-MM-dd'T'HH:mm:ss.SSSZ",
    "lastCommittedTransaction":"String",
    "referenceDate":"2018-03-08"
  }]
}
Headers:
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in BGv1.3 by getBalances

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.

Authentication is Mandatory

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.
Connector Methods:
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.

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "cardAccounts":[{
    "resourceId":"3d9a81b3-a47d-4130-8765-a9c0ff861b99",
    "maskedPan":"525412******3241",
    "currency":"EUR",
    "name":"Main",
    "product":"Basic Credit",
    "status":"enabled",
    "creditLimit":{
      "currency":"EUR",
      "amount":15000
    },
    "balances":[{
      "balanceType":"interimBooked",
      "balanceAmount":{
        "currency":"EUR",
        "amount":14355.78
      }
    },{
      "balanceType":"nonBilled",
      "balanceAmount":{
        "currency":"EUR",
        "amount":4175.86
      }
    }],
    "_links":{
      "transactions":{
        "href":"/v1/card-accounts/3d9a81b3-a47d-4130-8765-a9c0ff861b99/transactions"
      }
    }
  }]
}
Headers:
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in BGv1.3 by getCardAccounts