Developer Documentation API Reference
The payments service user (PSU) wants faster, better and more secure ways of interacting when it comes to their assets or the services they want access to. After PSD2 comes into effect on September 14th 2019, banks will open up their APIs for Third Party Provider. Our API documentation lets developers experiment and test their implementations before that happens, giving you the chance to be ahead of the game.
In our documentation, you´ll find an explanation on how to work with our API and what information that you can access with it. Please refer to the leftmost column to quickly navigate throughout the documentation, each path is detailed in the description and respectively, you will find the response examples from the column on the right.
Since we value the smooth and easy to use experience, we have built our API around the Representational State Transfer Service architecture (REST for short), standard HTTP and easy-to-read and to write JavaScript Object Nation (JSON). We follow the Berlin Group API specification and we have extended the documentation to meet regulatory requirements.
For any questions please do not hesitate to contact us at developer@enfuce.com
API Endpoint
https://api.openbanking.enfuce.com/Contact: developer@enfuce.com
Schemes: https
Version: 1.0
Account Information Service (AIS)
The Account Information Service (AIS) offers the following services:
- Transaction reports for a given account including balances if applicable.
- Balances of a given account
- A list of available accounts
- Account details of a given account or of the list of all accessible accounts relative to a granted consent
Read Account List
Reads 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.
The consentId of the related AIS consent
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available
The forwarded header field of the HTTP request between PSU and TPP, if available
The forwarded header field of the HTTP request between PSU and TPP, if available
The forwarded header field of the HTTP request between PSU and TPP, if available
UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependent application installation. In case of an installation identification, this ID needs to be unaltered until removal from the device
The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available
HTTP method used at the PSU to TPP interface, if available
The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP
The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available
The forwarded Agent header field of the HTTP request between PSU and TPP, if available
ID of the request, unique to the call, as determined by the initiating party
If the balance of the account should be included in the response
OK
Bad Request
Bad Request
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Response Content-Types: application/json
Response Example (200 OK)
{
"accounts": [
{
"_links": [
{
"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"rel": "string",
"templated": "boolean",
"title": "string",
"type": "string"
}
],
"balances": [
{
"balanceAmount": {
"amount": 123.5,
"currency": "EUR"
},
"balanceType": "string",
"lastChangeDateTime": "string (date-time)",
"lastCommittedTransaction": "string",
"referenceDate": "string (date)"
}
],
"bban": "string",
"bic": "string",
"cashAccountType": "string",
"currency": "string",
"details": "string",
"iban": "string",
"linkedAccounts": "string",
"msisdn": "string",
"name": "string",
"product": "string",
"resourceId": "string (uuid)",
"status": "string",
"usage": "string"
}
]
}
Response Headers (200 OK)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (400 Bad Request)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (401 Unauthorized)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (403 Forbidden)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (404 Not Found)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (405 Method Not Allowed)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (406 Not Acceptable)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (408 Request Timeout)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (415 Unsupported Media Type)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (429 Too Many Requests)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (500 Internal Server Error)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (503 Service Unavailable)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
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.
The consentId of the related AIS consent
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available
The forwarded header field of the HTTP request between PSU and TPP, if available
The forwarded header field of the HTTP request between PSU and TPP, if available
The forwarded header field of the HTTP request between PSU and TPP, if available
UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependent application installation. In case of an installation identification, this ID needs to be unaltered until removal from the device
The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available
HTTP method used at the PSU to TPP interface, if available
The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP
The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available
The forwarded Agent header field of the HTTP request between PSU and TPP, if available
ID of the request, unique to the call, as determined by the initiating party
This identification is denoting the addressed account. The accountId is retrieved by using a "Read Account List" call. The accountId is the "id" attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent
If the balance of the account should be included in the response
OK
Bad Request
Bad Request
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Response Content-Types: application/json
Response Example (200 OK)
{
"account": {
"_links": [
{
"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"rel": "string",
"templated": "boolean",
"title": "string",
"type": "string"
}
],
"balances": [
{
"balanceAmount": {
"amount": 123.5,
"currency": "EUR"
},
"balanceType": "string",
"lastChangeDateTime": "string (date-time)",
"lastCommittedTransaction": "string",
"referenceDate": "string (date)"
}
],
"bban": "string",
"bic": "string",
"cashAccountType": "string",
"currency": "string",
"details": "string",
"iban": "string",
"linkedAccounts": "string",
"msisdn": "string",
"name": "string",
"product": "string",
"resourceId": "string (uuid)",
"status": "string",
"usage": "string"
}
}
Response Headers (200 OK)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (400 Bad Request)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (401 Unauthorized)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (403 Forbidden)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (404 Not Found)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (405 Method Not Allowed)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (406 Not Acceptable)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (408 Request Timeout)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (415 Unsupported Media Type)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (429 Too Many Requests)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (500 Internal Server Error)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (503 Service Unavailable)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Read Balance
Reads account data from a given account addressed by "account-id".
Remark: This accountId can be a tokenized identification due to data protection reason since the path information might be logged on intermediary servers within the ASPSP sphere. This accountId then can be retrieved by the "GET Account List" call. The accountId is constant at least throughout the lifecycle of a given consent.
The consentId of the related AIS consent
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available
The forwarded header field of the HTTP request between PSU and TPP, if available
The forwarded header field of the HTTP request between PSU and TPP, if available
The forwarded header field of the HTTP request between PSU and TPP, if available
UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependent application installation. In case of an installation identification, this ID needs to be unaltered until removal from the device
The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available
HTTP method used at the PSU to TPP interface, if available
The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP
The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available
The forwarded Agent header field of the HTTP request between PSU and TPP, if available
ID of the request, unique to the call, as determined by the initiating party
This identification is denoting the addressed account. The accountId is retrieved by using a "Read Account List" call. The accountId is the "resourceId" attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent.
OK
Bad Request
Bad Request
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Response Content-Types: */*, application/json
Response Example (200 OK)
{
"account": {
"iban": "FI9814283500171141"
},
"balances": [
{
"balanceAmount": {
"amount": 123.5,
"currency": "EUR"
},
"balanceType": "string",
"lastChangeDateTime": "string (date-time)",
"lastCommittedTransaction": "string",
"referenceDate": "string (date)"
}
]
}
Response Headers (200 OK)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (400 Bad Request)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (401 Unauthorized)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (403 Forbidden)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (404 Not Found)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (405 Method Not Allowed)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (406 Not Acceptable)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (408 Request Timeout)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (415 Unsupported Media Type)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (429 Too Many Requests)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (500 Internal Server Error)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (503 Service Unavailable)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Read Transaction List
Read transaction reports or transaction lists of a given account addressed by "accountId", 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.
The consentId of the related AIS consent
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available
The forwarded header field of the HTTP request between PSU and TPP, if available
The forwarded header field of the HTTP request between PSU and TPP, if available
The forwarded header field of the HTTP request between PSU and TPP, if available
UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependent application installation. In case of an installation identification, this ID needs to be unaltered until removal from the device
The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available
HTTP method used at the PSU to TPP interface, if available
The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP
The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available
The forwarded Agent header field of the HTTP request between PSU and TPP, if available
ID of the request, unique to the call, as determined by the initiating party
The account id which the details should be fetched
The status of the transactionDetails to be included
Starting date (inclusive the date dateFrom) of the transaction list
End date (inclusive the data dateTo) of the transaction list, defaults to now if not given
page
If the balance of the account should be included in the response
OK
Bad Request
Bad Request
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Response Content-Types: application/json
Response Example (200 OK)
{
"account": {
"iban": "FI9814283500171141"
},
"balances": [
{
"balanceAmount": {
"amount": 123.5,
"currency": "EUR"
},
"balanceType": "string",
"lastChangeDateTime": "string (date-time)",
"lastCommittedTransaction": "string",
"referenceDate": "string (date)"
}
],
"transactions": {
"_links": [
{
"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"rel": "string",
"templated": "boolean",
"title": "string",
"type": "string"
}
],
"booked": [
{
"bankTransactionCode": "string",
"bookingDate": "string (date)",
"checkId": "string",
"creditorAccount": {
"iban": "FI9814283500171141"
},
"creditorId": "string",
"creditorName": "string",
"debtorAccount": {
"iban": "FI9814283500171141"
},
"debtorName": "string",
"endToEndId": "string",
"entryReference": "string",
"exchangeRate": [
{
"currencyFrom": "EUR",
"currencyTo": "EUR",
"rateContract": "string",
"rateDate": "string (date)",
"rateFrom": "string",
"rateTo": "string"
}
],
"mandateId": "string",
"proprietaryBankTransactionCode": "string",
"purposeCode": "string",
"remittanceInformationStructured": "string",
"remittanceInformationUnstructured": "string",
"transactionAmount": {
"amount": 123.5,
"currency": "EUR"
},
"transactionId": "string",
"ultimateCreditor": "string",
"ultimateDebtor": "string",
"valueDate": "string (date)"
}
],
"meta": {
"totalPages": "integer (int32)"
},
"pending": [
{
"bankTransactionCode": "string",
"bookingDate": "string (date)",
"checkId": "string",
"creditorAccount": {
"iban": "FI9814283500171141"
},
"creditorId": "string",
"creditorName": "string",
"debtorAccount": {
"iban": "FI9814283500171141"
},
"debtorName": "string",
"endToEndId": "string",
"entryReference": "string",
"exchangeRate": [
{
"currencyFrom": "EUR",
"currencyTo": "EUR",
"rateContract": "string",
"rateDate": "string (date)",
"rateFrom": "string",
"rateTo": "string"
}
],
"mandateId": "string",
"proprietaryBankTransactionCode": "string",
"purposeCode": "string"
}
]
}
}
Response Headers (200 OK)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (400 Bad Request)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (401 Unauthorized)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (403 Forbidden)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (404 Not Found)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (405 Method Not Allowed)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (406 Not Acceptable)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (408 Request Timeout)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (415 Unsupported Media Type)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (429 Too Many Requests)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (500 Internal Server Error)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (503 Service Unavailable)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Read Transaction Details
Reads transaction details from a given transaction addressed by "resourceId" on a given account addressed by "accountId". 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.
The consentId of the related AIS consent
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available
The forwarded header field of the HTTP request between PSU and TPP, if available
The forwarded header field of the HTTP request between PSU and TPP, if available
The forwarded header field of the HTTP request between PSU and TPP, if available
UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependent application installation. In case of an installation identification, this ID needs to be unaltered until removal from the device
The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available
HTTP method used at the PSU to TPP interface, if available
The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP
The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available
The forwarded Agent header field of the HTTP request between PSU and TPP, if available
ID of the request, unique to the call, as determined by the initiating party
This identification is denoting the addressed account, where the transaction has been performed
This identification is given by the attribute transactionId of the corresponding entry of a transaction list
OK
Bad Request
Bad Request
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Response Content-Types: application/json
Response Example (200 OK)
{
"transactionDetails": {
"bankTransactionCode": "string",
"bookingDate": "string (date)",
"checkId": "string",
"creditorAccount": {
"iban": "FI9814283500171141"
},
"creditorId": "string",
"creditorName": "string",
"debtorAccount": {
"iban": "FI9814283500171141"
},
"debtorName": "string",
"endToEndId": "string",
"entryReference": "string",
"exchangeRate": [
{
"currencyFrom": "EUR",
"currencyTo": "EUR",
"rateContract": "string",
"rateDate": "string (date)",
"rateFrom": "string",
"rateTo": "string"
}
],
"mandateId": "string",
"proprietaryBankTransactionCode": "string",
"purposeCode": "string",
"remittanceInformationStructured": "string",
"remittanceInformationUnstructured": "string",
"transactionAmount": {
"amount": 123.5,
"currency": "EUR"
},
"transactionId": "string",
"ultimateCreditor": "string",
"ultimateDebtor": "string",
"valueDate": "string (date)"
}
}
Response Headers (200 OK)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (400 Bad Request)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (401 Unauthorized)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (403 Forbidden)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (404 Not Found)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (405 Method Not Allowed)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (406 Not Acceptable)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (408 Request Timeout)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (415 Unsupported Media Type)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (429 Too Many Requests)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (500 Internal Server Error)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (503 Service Unavailable)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Create Consent
consentRequest
Contains the OAuth 2.0 Bearer Token
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available
The forwarded header field of the HTTP request between PSU and TPP, if available
The forwarded header field of the HTTP request between PSU and TPP, if available
The forwarded header field of the HTTP request between PSU and TPP, if available
UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependent application installation. In case of an installation identification, this ID needs to be unaltered until removal from the device
The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available
HTTP method used at the PSU to TPP interface, if available
The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP
The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available
The forwarded Agent header field of the HTTP request between PSU and TPP, if available
ID of the request, unique to the call, as determined by the initiating party
Request Content-Types: application/json
Request Example
{
"access": {
"accounts": [
{
"currency": "string",
"iban": "string",
"maskedPan": "string",
"msisdn": "string",
"pan": "string"
}
],
"allPsd2": "string",
"availableAccounts": "string",
"balances": [
{
"currency": "string",
"iban": "string",
"maskedPan": "string",
"msisdn": "string",
"pan": "string"
}
],
"transactions": [
{
"currency": "string",
"iban": "string",
"maskedPan": "string",
"msisdn": "string",
"pan": "string"
}
]
},
"recurringIndicator": "boolean",
"validUntil": "2018-10-30",
"frequencyPerDay": 1,
"combinedServiceIndicator": "boolean"
}
OK
Account information consent was created
Validation error occurred
The requestor is not correctly authorized to perform the request
Forbidden
Not Found
Internal server error
Response Content-Types: */*
Response Example (200 OK)
{
"_links": [
{
"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"rel": "string",
"templated": "boolean",
"title": "string",
"type": "string"
}
],
"consentId": "string",
"consentStatus": "string"
}
Response Example (201 Created)
{
"_links": [
{
"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"rel": "string",
"templated": "boolean",
"title": "string",
"type": "string"
}
],
"consentId": "string",
"consentStatus": "string"
}
Get Consent Request
Contains the OAuth 2.0 Bearer Token
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available
The forwarded header field of the HTTP request between PSU and TPP, if available
The forwarded header field of the HTTP request between PSU and TPP, if available
The forwarded header field of the HTTP request between PSU and TPP, if available
UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependent application installation. In case of an installation identification, this ID needs to be unaltered until removal from the device
The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available
HTTP method used at the PSU to TPP interface, if available
The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP
The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available
The forwarded Agent header field of the HTTP request between PSU and TPP, if available
ID of the request, unique to the call, as determined by the initiating party
consentId
Account information consent is returned
Validation error occurred
The requestor is not authorized to perform the request
Forbidden
The requested account information consent does not exist
Method Not Allowed
Not Acceptable
Request Timeout
Unsupported Media Type
Too Many Requests
Internal server error
Service Unavailable
Response Content-Types: */*
Response Example (200 OK)
{
"_links": [
{
"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"rel": "string",
"templated": "boolean",
"title": "string",
"type": "string"
}
],
"access": {
"accounts": [
{
"currency": "string",
"iban": "string",
"maskedPan": "string",
"msisdn": "string",
"pan": "string"
}
],
"allPsd2": "string",
"availableAccounts": "string",
"balances": [
{
"currency": "string",
"iban": "string",
"maskedPan": "string",
"msisdn": "string",
"pan": "string"
}
],
"transactions": [
{
"currency": "string",
"iban": "string",
"maskedPan": "string",
"msisdn": "string",
"pan": "string"
}
]
},
"consentStatus": "string",
"frequencyPerDay": "integer (int32)",
"lastActionDate": "string (date)",
"recurringIndicator": "boolean",
"validUntil": "string (date)"
}
Response Headers (200 OK)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (400 Bad Request)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (401 Unauthorized)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (403 Forbidden)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (404 Not Found)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (405 Method Not Allowed)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (406 Not Acceptable)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (408 Request Timeout)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (415 Unsupported Media Type)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (429 Too Many Requests)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (500 Internal Server Error)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (503 Service Unavailable)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Delete Consent
Contains the OAuth 2.0 Bearer Token
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available
The forwarded header field of the HTTP request between PSU and TPP, if available
The forwarded header field of the HTTP request between PSU and TPP, if available
The forwarded header field of the HTTP request between PSU and TPP, if available
UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependent application installation. In case of an installation identification, this ID needs to be unaltered until removal from the device
The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available
HTTP method used at the PSU to TPP interface, if available
The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP
The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available
The forwarded Agent header field of the HTTP request between PSU and TPP, if available
ID of the request, unique to the call, as determined by the initiating party
consentId
OK
Consent was deleted
Validation error occurred
The requestor is not authorized to perform the request
Forbidden
The requested account information consent does not exist
Internal server error
Response Content-Types: */*
Get Consent Request Status
Contains the OAuth 2.0 Bearer Token
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available
The forwarded header field of the HTTP request between PSU and TPP, if available
The forwarded header field of the HTTP request between PSU and TPP, if available
The forwarded header field of the HTTP request between PSU and TPP, if available
UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependent application installation. In case of an installation identification, this ID needs to be unaltered until removal from the device
The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available
HTTP method used at the PSU to TPP interface, if available
The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP
The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available
The forwarded Agent header field of the HTTP request between PSU and TPP, if available
ID of the request, unique to the call, as determined by the initiating party
consentId
Account information consent is returned
Validation error occurred
The requestor is not authorized to perform the request
Forbidden
The requested consent does not exist
Method Not Allowed
Not Acceptable
Request Timeout
Unsupported Media Type
Too Many Requests
Internal server error
Service Unavailable
Response Content-Types: */*
Response Example (200 OK)
{
"_links": [
{
"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"rel": "string",
"templated": "boolean",
"title": "string",
"type": "string"
}
],
"consentStatus": "string"
}
Response Headers (200 OK)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (400 Bad Request)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (401 Unauthorized)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (403 Forbidden)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (404 Not Found)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (405 Method Not Allowed)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (406 Not Acceptable)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (408 Request Timeout)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (415 Unsupported Media Type)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (429 Too Many Requests)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (500 Internal Server Error)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (503 Service Unavailable)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Payment Initiation Service (PIS)
The Payment Initiation Service (PIS) offers the following services:
- Initiation of a payment request
- Retrieve information of a payment
- Status information of a payment
Initiate cross-border credit transfer
This method is used to initiate a cross-border credit transfer.
requestBody
Contains the OAuth 2.0 Bearer Token
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available
The forwarded header field of the HTTP request between PSU and TPP, if available
The forwarded header field of the HTTP request between PSU and TPP, if available
The forwarded header field of the HTTP request between PSU and TPP, if available
UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependent application installation. In case of an installation identification, this ID needs to be unaltered until removal from the device
The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available
HTTP method used at the PSU to TPP interface, if available
The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP
The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available
The forwarded Agent header field of the HTTP request between PSU and TPP, if available
ID of the request, unique to the call, as determined by the initiating party
Request Content-Types: application/json
Request Example
{
"chargeBearer": "string",
"creditorAgent": "BSUIFIHH",
"creditorName": "Firstname Lastname",
"debtorAccount": {
"iban": "FI9814283500171141"
},
"remittanceInformationUnstructured": "Message to you",
"instructedAmount": {
"amount": 123.5,
"currency": "EUR"
},
"creditorAccount": {
"iban": "FI9814283500171141"
},
"creditorAddress": {
"buildingNumber": 12,
"city": "Espoo",
"country": "FI",
"postalCode": "02130",
"street": "Metsänneidonkuja"
}
}
OK
Bad Request
Bad Request
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Response Content-Types: application/json
Response Example (200 OK)
{
"links": [
{
"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"rel": "string",
"templated": "boolean",
"title": "string",
"type": "string"
}
],
"paymentId": "string (uuid)",
"transactionFeeIndicator": "boolean",
"transactionFees": {
"amount": 123.5,
"currency": "EUR"
},
"transactionStatus": "string"
}
Response Headers (200 OK)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (400 Bad Request)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (401 Unauthorized)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (403 Forbidden)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (404 Not Found)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (405 Method Not Allowed)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (406 Not Acceptable)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (408 Request Timeout)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (415 Unsupported Media Type)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (429 Too Many Requests)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (500 Internal Server Error)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (503 Service Unavailable)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Initiate SEPA transfer
This method is used to initiate a SEPA credit transfer.
requestBody
Contains the OAuth 2.0 Bearer Token
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available
The forwarded header field of the HTTP request between PSU and TPP, if available
The forwarded header field of the HTTP request between PSU and TPP, if available
The forwarded header field of the HTTP request between PSU and TPP, if available
UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependent application installation. In case of an installation identification, this ID needs to be unaltered until removal from the device
The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available
HTTP method used at the PSU to TPP interface, if available
The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP
The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available
The forwarded Agent header field of the HTTP request between PSU and TPP, if available
ID of the request, unique to the call, as determined by the initiating party
Request Content-Types: application/json
Request Example
{
"creditorAccount": {
"iban": "FI9814283500171141"
},
"creditorAddress": {
"buildingNumber": 12,
"city": "Espoo",
"country": "FI",
"postalCode": "02130",
"street": "Metsänneidonkuja"
},
"creditorAgent": "BSUIFIHH",
"creditorName": "Firstname Lastname",
"debtorAccount": {
"iban": "FI9814283500171141"
},
"endToEndIdentification": "Firstname Lastname",
"instructedAmount": {
"amount": 123.5,
"currency": "EUR"
},
"remittanceInformationStructured": {
"reference": "RF67123456780"
},
"remittanceInformationUnstructured": "Message to you"
}
OK
Bad Request
Bad Request
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Response Content-Types: application/json
Response Example (200 OK)
{
"links": [
{
"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"rel": "string",
"templated": "boolean",
"title": "string",
"type": "string"
}
],
"paymentId": "string (uuid)",
"transactionFeeIndicator": "boolean",
"transactionFees": {
"amount": 123.5,
"currency": "EUR"
},
"transactionStatus": "string"
}
Response Headers (200 OK)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (400 Bad Request)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (401 Unauthorized)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (403 Forbidden)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (404 Not Found)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (405 Method Not Allowed)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (406 Not Acceptable)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (408 Request Timeout)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (415 Unsupported Media Type)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (429 Too Many Requests)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (500 Internal Server Error)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (503 Service Unavailable)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Payment initiation status request
Check the transaction status of a payment initiation..
Contains the OAuth 2.0 Bearer Token
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available
The forwarded header field of the HTTP request between PSU and TPP, if available
The forwarded header field of the HTTP request between PSU and TPP, if available
The forwarded header field of the HTTP request between PSU and TPP, if available
UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependent application installation. In case of an installation identification, this ID needs to be unaltered until removal from the device
The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available
HTTP method used at the PSU to TPP interface, if available
The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP
The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available
The forwarded Agent header field of the HTTP request between PSU and TPP, if available
ID of the request, unique to the call, as determined by the initiating party
paymentId
OK
Unauthorized
Forbidden
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"transactionStatus": "string"
}
Get payment information
Returns the content of a payment object.
Contains the OAuth 2.0 Bearer Token
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available
The forwarded header field of the HTTP request between PSU and TPP, if available
The forwarded header field of the HTTP request between PSU and TPP, if available
The forwarded header field of the HTTP request between PSU and TPP, if available
UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependent application installation. In case of an installation identification, this ID needs to be unaltered until removal from the device
The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available
HTTP method used at the PSU to TPP interface, if available
The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP
The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available
The forwarded Agent header field of the HTTP request between PSU and TPP, if available
ID of the request, unique to the call, as determined by the initiating party
paymentId
paymentProduct
paymentService
OK
Unauthorized
Forbidden
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"creditorAccount": {
"iban": "FI9814283500171141"
},
"creditorAddress": {
"buildingNumber": 12,
"city": "Espoo",
"country": "FI",
"postalCode": "02130",
"street": "Metsänneidonkuja"
},
"creditorName": "Firstname Lastname",
"debtorAccount": {
"iban": "FI9814283500171141"
},
"instructedAmount": {
"amount": 123.5,
"currency": "EUR"
},
"remittanceInformationStructured": {
"reference": "RF67123456780"
},
"remittanceInformationUnstructured": "Message to you"
}
Confirmation of Funds Service (PIIS)
The Confirmation of Funds Service offers the following services:
- 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
Confirmation of Funds
Check whether a specific amount is available on a given account at point of time of the request.
Request body for a confirmation of funds request
Contains a hash of the message body.
A signature of the request by the TPP on application level
The certificate used for signing the request, in base64 encoding.
ID of the request, unique to the call, as determined by the initiating party
Request Content-Types: application/json
Request Example
{
"account": {
"iban": "FI9814283500171141"
},
"cardNumber": "string",
"instructedAmount": {
"amount": 123.5,
"currency": "EUR"
},
"payee": "string"
}
OK
Bad Request
Bad Request
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Response Content-Types: application/json
Response Example (200 OK)
{
"fundsAvailable": "boolean"
}
Response Headers (200 OK)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (400 Bad Request)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (401 Unauthorized)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (403 Forbidden)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (404 Not Found)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (405 Method Not Allowed)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (406 Not Acceptable)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (408 Request Timeout)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (415 Unsupported Media Type)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (429 Too Many Requests)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (500 Internal Server Error)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Response Headers (503 Service Unavailable)
| X-Request-ID |
ID of the request, unique to the call, as determined by the initiating party. |
string |
Schema Definitions
AccountDetails: object
A representation of an account in the system
- _links: Link
-
Link - balances: Balance
-
List of balances
-
Balance - bban: string
-
BBAN of the account, this data elements is used for payment accounts which have no IBAN
- bic: string
-
The BIC associated to the account
- cashAccountType: string
-
ExternalCashAccountType1Code from ISO 20022
- currency: string
-
Currency of the account ISO 4217 currency code
- details: string
-
Specifications that might be provided by the ASPSP; characteristics of the account or characteristics of the relevant card
- iban: string
-
IBAN of the account
- linkedAccounts: string
-
Case of a set of pending card transactions,the ASPSP will provide the relevant cash account the card is set up on.
- msisdn: string
-
An alias to access a payment account via a registered mobile phone number.
- name: string
-
The name of the account
- product: string
-
Proprietary product name for the account
- resourceId: string (uuid)
-
The unique identifier of the account, RFC4122
- status: string enabled, deleted, blocked
-
AccountDetails status
- usage: string
-
Specifies the usage of the account; PRIV: private personal account, ORGA: professional account
Example
{
"_links": [
{
"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"rel": "string",
"templated": "boolean",
"title": "string",
"type": "string"
}
],
"balances": [
{
"balanceAmount": {
"amount": 123.5,
"currency": "EUR"
},
"balanceType": "string",
"lastChangeDateTime": "string (date-time)",
"lastCommittedTransaction": "string",
"referenceDate": "string (date)"
}
],
"bban": "string",
"bic": "string",
"cashAccountType": "string",
"currency": "string",
"details": "string",
"iban": "string",
"linkedAccounts": "string",
"msisdn": "string",
"name": "string",
"product": "string",
"resourceId": "string (uuid)",
"status": "string",
"usage": "string"
}
AccountReport: object
Account report
- _links: Link
-
Link - booked: TransactionDetails
-
List of booked transactions
-
TransactionDetails - meta: TransactionListMeta
-
Additional meta data regarding the transactions
- pending: TransactionDetails
-
List of pending transactions
-
TransactionDetails
Example
{
"_links": [
{
"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"rel": "string",
"templated": "boolean",
"title": "string",
"type": "string"
}
],
"booked": [
{
"bankTransactionCode": "string",
"bookingDate": "string (date)",
"checkId": "string",
"creditorAccount": {
"iban": "FI9814283500171141"
},
"creditorId": "string",
"creditorName": "string",
"debtorAccount": {
"iban": "FI9814283500171141"
},
"debtorName": "string",
"endToEndId": "string",
"entryReference": "string",
"exchangeRate": [
{
"currencyFrom": "EUR",
"currencyTo": "EUR",
"rateContract": "string",
"rateDate": "string (date)",
"rateFrom": "string",
"rateTo": "string"
}
],
"mandateId": "string",
"proprietaryBankTransactionCode": "string",
"purposeCode": "string",
"remittanceInformationStructured": "string",
"remittanceInformationUnstructured": "string",
"transactionAmount": {
"amount": 123.5,
"currency": "EUR"
},
"transactionId": "string",
"ultimateCreditor": "string",
"ultimateDebtor": "string",
"valueDate": "string (date)"
}
],
"meta": {
"totalPages": "integer (int32)"
},
"pending": [
{
"bankTransactionCode": "string",
"bookingDate": "string (date)",
"checkId": "string",
"creditorAccount": {
"iban": "FI9814283500171141"
},
"creditorId": "string",
"creditorName": "string",
"debtorAccount": {
"iban": "FI9814283500171141"
},
"debtorName": "string",
"endToEndId": "string",
"entryReference": "string",
"exchangeRate": [
{
"currencyFrom": "EUR",
"currencyTo": "EUR",
"rateContract": "string",
"rateDate": "string (date)",
"rateFrom": "string",
"rateTo": "string"
}
],
"mandateId": "string",
"proprietaryBankTransactionCode": "string",
"purposeCode": "string",
"remittanceInformationStructured": "string",
"remittanceInformationUnstructured": "string",
"transactionAmount": {
"amount": 123.5,
"currency": "EUR"
},
"transactionId": "string",
"ultimateCreditor": "string",
"ultimateDebtor": "string",
"valueDate": "string (date)"
}
]
}
Amount: object
- amount: number
- currency: string
-
ISO 4217 currency code
Example
{
"amount": 123.5,
"currency": "EUR"
}
Balance: object
- balanceAmount: Amount
- balanceType: string closingBooked, expected, authorised, openingBooked, interimAvailable, forwardAvailable, nonInvoiced, available
- lastChangeDateTime: string (date-time)
-
This data element might be used to indicate e.g. with the expected or booked balance that no action is known on the account, which is not yet booked.
- lastCommittedTransaction: string
-
entryReference of the last commited transaction to support the TPP in identifying whether all PSU transactions are already known.
- referenceDate: string (date)
-
Reference date of the balance.
Example
{
"balanceAmount": {
"amount": 123.5,
"currency": "EUR"
},
"balanceType": "string",
"lastChangeDateTime": "string (date-time)",
"lastCommittedTransaction": "string",
"referenceDate": "string (date)"
}
ExchangeRate: object
Exchange rate
- currencyFrom: string
-
ISO 4217 Alpha 3 currency code
- currencyTo: string
-
ISO 4217 Alpha 3 currency code
- rateContract: string
- rateDate: string (date)
- rateFrom: string
- rateTo: string
Example
{
"currencyFrom": "EUR",
"currencyTo": "EUR",
"rateContract": "string",
"rateDate": "string (date)",
"rateFrom": "string",
"rateTo": "string"
}
IbanAccountReference: object
IBAN account reference
- iban: string
-
IBAN of the account
Example
{
"iban": "FI9814283500171141"
}
Link: object
- deprecation: string
- href: string
- hreflang: string
- media: string
- rel: string
- templated: boolean
- title: string
- type: string
Example
{
"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"rel": "string",
"templated": "boolean",
"title": "string",
"type": "string"
}
ReadAccountDetailsResponse: object
Account details response
- account: AccountDetails
-
The account
Example
{
"account": {
"_links": [
{
"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"rel": "string",
"templated": "boolean",
"title": "string",
"type": "string"
}
],
"balances": [
{
"balanceAmount": {
"amount": 123.5,
"currency": "EUR"
},
"balanceType": "string",
"lastChangeDateTime": "string (date-time)",
"lastCommittedTransaction": "string",
"referenceDate": "string (date)"
}
],
"bban": "string",
"bic": "string",
"cashAccountType": "string",
"currency": "string",
"details": "string",
"iban": "string",
"linkedAccounts": "string",
"msisdn": "string",
"name": "string",
"product": "string",
"resourceId": "string (uuid)",
"status": "string",
"usage": "string"
}
}
ReadAccountListResponse: object
AccountDetails list response
- accounts: AccountDetails
-
The accountDetails
-
AccountDetails
Example
{
"accounts": [
{
"_links": [
{
"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"rel": "string",
"templated": "boolean",
"title": "string",
"type": "string"
}
],
"balances": [
{
"balanceAmount": {
"amount": 123.5,
"currency": "EUR"
},
"balanceType": "string",
"lastChangeDateTime": "string (date-time)",
"lastCommittedTransaction": "string",
"referenceDate": "string (date)"
}
],
"bban": "string",
"bic": "string",
"cashAccountType": "string",
"currency": "string",
"details": "string",
"iban": "string",
"linkedAccounts": "string",
"msisdn": "string",
"name": "string",
"product": "string",
"resourceId": "string (uuid)",
"status": "string",
"usage": "string"
}
]
}
ReadBalanceResponse: object
Read Balance response
- account: IbanAccountReference
-
Identifier of the addressed account.
- balances: Balance
-
A list of balances regarding this account, e.g. the current balance, the last booked balance.
-
Balance
Example
{
"account": {
"iban": "FI9814283500171141"
},
"balances": [
{
"balanceAmount": {
"amount": 123.5,
"currency": "EUR"
},
"balanceType": "string",
"lastChangeDateTime": "string (date-time)",
"lastCommittedTransaction": "string",
"referenceDate": "string (date)"
}
]
}
ReadTransactionDetailsResponse: object
Read Transaction Details response
- transactionDetails: TransactionDetails
-
The transaction details
Example
{
"transactionDetails": {
"bankTransactionCode": "string",
"bookingDate": "string (date)",
"checkId": "string",
"creditorAccount": {
"iban": "FI9814283500171141"
},
"creditorId": "string",
"creditorName": "string",
"debtorAccount": {
"iban": "FI9814283500171141"
},
"debtorName": "string",
"endToEndId": "string",
"entryReference": "string",
"exchangeRate": [
{
"currencyFrom": "EUR",
"currencyTo": "EUR",
"rateContract": "string",
"rateDate": "string (date)",
"rateFrom": "string",
"rateTo": "string"
}
],
"mandateId": "string",
"proprietaryBankTransactionCode": "string",
"purposeCode": "string",
"remittanceInformationStructured": "string",
"remittanceInformationUnstructured": "string",
"transactionAmount": {
"amount": 123.5,
"currency": "EUR"
},
"transactionId": "string",
"ultimateCreditor": "string",
"ultimateDebtor": "string",
"valueDate": "string (date)"
}
}
ReadTransactionListResponse: object
Read transaction list response
- account: IbanAccountReference
-
AccountDetails reference
- balances: Balance
-
Balances
-
Balance - transactions: AccountReport
-
The transactions
Example
{
"account": {
"iban": "FI9814283500171141"
},
"balances": [
{
"balanceAmount": {
"amount": 123.5,
"currency": "EUR"
},
"balanceType": "string",
"lastChangeDateTime": "string (date-time)",
"lastCommittedTransaction": "string",
"referenceDate": "string (date)"
}
],
"transactions": {
"_links": [
{
"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"rel": "string",
"templated": "boolean",
"title": "string",
"type": "string"
}
],
"booked": [
{
"bankTransactionCode": "string",
"bookingDate": "string (date)",
"checkId": "string",
"creditorAccount": {
"iban": "FI9814283500171141"
},
"creditorId": "string",
"creditorName": "string",
"debtorAccount": {
"iban": "FI9814283500171141"
},
"debtorName": "string",
"endToEndId": "string",
"entryReference": "string",
"exchangeRate": [
{
"currencyFrom": "EUR",
"currencyTo": "EUR",
"rateContract": "string",
"rateDate": "string (date)",
"rateFrom": "string",
"rateTo": "string"
}
],
"mandateId": "string",
"proprietaryBankTransactionCode": "string",
"purposeCode": "string",
"remittanceInformationStructured": "string",
"remittanceInformationUnstructured": "string",
"transactionAmount": {
"amount": 123.5,
"currency": "EUR"
},
"transactionId": "string",
"ultimateCreditor": "string",
"ultimateDebtor": "string",
"valueDate": "string (date)"
}
],
"meta": {
"totalPages": "integer (int32)"
},
"pending": [
{
"bankTransactionCode": "string",
"bookingDate": "string (date)",
"checkId": "string",
"creditorAccount": {
"iban": "FI9814283500171141"
},
"creditorId": "string",
"creditorName": "string",
"debtorAccount": {
"iban": "FI9814283500171141"
},
"debtorName": "string",
"endToEndId": "string",
"entryReference": "string",
"exchangeRate": [
{
"currencyFrom": "EUR",
"currencyTo": "EUR",
"rateContract": "string",
"rateDate": "string (date)",
"rateFrom": "string",
"rateTo": "string"
}
],
"mandateId": "string",
"proprietaryBankTransactionCode": "string",
"purposeCode": "string",
"remittanceInformationStructured": "string"
}
]
}
}
TransactionDetails: object
Transaction details
- bankTransactionCode: string
-
Bank transaction code as used by the ASPSP and using the sub elements of this structured code defined by ISO20022
- bookingDate: string (date)
-
The Date when an entry is posted to an account on the ASPSPs books
- checkId: string
-
Identification of a Cheque
- creditorAccount: IbanAccountReference
-
Creditor account
- creditorId: string
-
Identification of Creditors, e.g. a SEPA Creditor ID
- creditorName: string
-
Name of the creditor if a "Debited" transaction
- debtorAccount: IbanAccountReference
-
Debtor account
- debtorName: string
-
Name of the debtor if a "Credited" transaction
- endToEndId: string
-
Unique end to end identity
- entryReference: string
-
Is the identification of the transaction as used e.g. for reference for deltafunction on application level. The same identification as for example used within camt.05x messages
- exchangeRate: ExchangeRate
-
Exchange rates
-
ExchangeRate - mandateId: string
-
Identification of Mandates, e.g. a SEPA Mandate ID
- proprietaryBankTransactionCode: string
-
Proprietary bank transaction code as used within a community or within an ASPSP e.g. for MT94x based transaction reports
- purposeCode: string BKDF, BKFE, BKFM, BKIP, BKPP, CBLK, CDCB, CDCD, CDCS, CDDP, CDOC, CDQC, ETUP, FCOL, MTUP, ACCT, CASH, COLL, CSDB, DEPT, INTC, LIMA, NETT, BFWD, CCIR, CCPC, CCPM, CCSM, CRDS, CRPR, CRSP, CRTL, EQPT, EQUS, EXPT, EXTD, FIXI, FWBC, FWCC, FWSB, FWSC, MARG, MBSB, MBSC, MGCC, MGSC, OCCC, OPBC, OPCC, OPSB, OPSC, OPTN, OTCD, REPO, RPBC, RPCC, RPSB, RPSC, RVPO, SBSC, SCIE, SCIR, SCRP, SHBC, SHCC, SHSL, SLEB, SLOA, SWBC, SWCC, SWPT, SWSB, SWSC, TBAS, TBBC, TBCC, TRCP, AGRT, AREN, BEXP, BOCE, COMC, CPYR, GDDS, GDSV, GSCB, LICF, MP2B, POPE, ROYA, SCVE, SERV, SUBS, SUPP, TRAD, CHAR, COMT, MP2P, ECPG, ECPR, ECPU, EPAY, CLPR, COMP, DBTC, GOVI, HLRP, HLST, INPC, INPR, INSC, INSU, INTE, LBRI, LIFI, LOAN, LOAR, PENO, PPTI, RELG, RINP, TRFD, FORW, FXNT, ADMG, ADVA, BCDM, BCFG, BLDM, BNET, CBFF, CBFR, CCRD, CDBL, CFEE, CGDD, CORT, COST, CPKC, DCRD, DSMT, DVPM, EDUC, FACT, FAND, FCPM, FEES, GOVT, ICCP, IDCP, IHRP, INSM, IVPT, MCDM, MCFG, MSVC, NOWS, OCDM, OCFG, OFEE, OTHR, PADD, PTSP, RCKE, RCPT, REBT, REFU, RENT, REOD, RIMB, RPNT, RRBN, RVPM, SLPI, SPLT, STDY, TBAN, TBIL, TCSC, TELI, TMPG, TPRI, TPRP, TRNC, TRVC, WEBI, ANNI, CAFI, CFDI, CMDT, DERI, DIVD, FREX, HEDG, INVS, PRME, SAVG, SECU, SEPI, TREA, UNIT, FNET, FUTR, ANTS, CVCF, DMEQ, DNTS, HLTC, HLTI, HSPC, ICRF, LTCF, MAFC, MARF, MDCS, VIEW, CDEP, SWFP, SWPP, SWRS, SWUF, ADCS, AEMP, ALLW, ALMY, BBSC, BECH, BENE, BONU, CCHD, COMM, CSLP, GFRP, GVEA, GVEB, GVEC, GVED, GWLT, HREC, PAYR, PEFC, PENS, PRCP, RHBS, SALA, SSBE, LBIN, LCOL, LFEE, LMEQ, LMFI, LMRK, LREB, LREV, LSFL, ESTX, FWLV, GSTX, HSTX, INTX, NITX, PTXP, RDTX, TAXS, VATX, WHLD, TAXR, B112, BR12, TLRF, TLRR, AIRB, BUSB, FERB, RLWY, TRPT, CBTV, ELEC, ENRG, GASB, NWCH, NWCM, OTLC, PHON, UBIL, WTER
-
ExternalPurpose1Code from ISO 20022. Values from ISO 20022 External Code List ExternalCodeSets_1Q2018 June 2018.
- remittanceInformationStructured: string
-
Reference as contained in the structured remittance reference structure (without the surrounding XML structure)
- remittanceInformationUnstructured: string
-
Remittance information unstructured
- transactionAmount: Amount
-
The amount of the transaction as billed to the account
- transactionId: string
-
Can be used as access-ID in the API, where more details on an transaction is offered. If this data attribute is provided this shows that the AIS can get access on more details about this transaction using the GET Transaction Details Request
- ultimateCreditor: string
-
Name of the ultimate creditor if a "Debited" transaction
- ultimateDebtor: string
-
Name of the ultimate debtor if a "Credited" transaction
- valueDate: string (date)
-
The Date at which assets become available to the account owner in case of a credit
Example
{
"bankTransactionCode": "string",
"bookingDate": "string (date)",
"checkId": "string",
"creditorAccount": {
"iban": "FI9814283500171141"
},
"creditorId": "string",
"creditorName": "string",
"debtorAccount": {
"iban": "FI9814283500171141"
},
"debtorName": "string",
"endToEndId": "string",
"entryReference": "string",
"exchangeRate": [
{
"currencyFrom": "EUR",
"currencyTo": "EUR",
"rateContract": "string",
"rateDate": "string (date)",
"rateFrom": "string",
"rateTo": "string"
}
],
"mandateId": "string",
"proprietaryBankTransactionCode": "string",
"purposeCode": "string",
"remittanceInformationStructured": "string",
"remittanceInformationUnstructured": "string",
"transactionAmount": {
"amount": 123.5,
"currency": "EUR"
},
"transactionId": "string",
"ultimateCreditor": "string",
"ultimateDebtor": "string",
"valueDate": "string (date)"
}
TransactionListMeta: object
- totalPages: integer (int32)
-
Indicates how many pages of transactions are available
Example
{
"totalPages": "integer (int32)"
}
AccountAccess: object
- accounts: AccountReference
-
AccountReference - allPsd2: string
- availableAccounts: string
- balances: AccountReference
-
AccountReference - transactions: AccountReference
-
AccountReference
Example
{
"accounts": [
{
"currency": "string",
"iban": "string",
"maskedPan": "string",
"msisdn": "string",
"pan": "string"
}
],
"allPsd2": "string",
"availableAccounts": "string",
"balances": [
{
"currency": "string",
"iban": "string",
"maskedPan": "string",
"msisdn": "string",
"pan": "string"
}
],
"transactions": [
{
"currency": "string",
"iban": "string",
"maskedPan": "string",
"msisdn": "string",
"pan": "string"
}
]
}
AccountReference: object
- currency: string
- iban: string
- maskedPan: string
- msisdn: string
- pan: string
Example
{
"currency": "string",
"iban": "string",
"maskedPan": "string",
"msisdn": "string",
"pan": "string"
}
CreateConsentRequest: object
- access: AccountAccess
-
Requested access services
- recurringIndicator: boolean
-
"true" if the consent is for recurring access to the account data "false", if the consent is for one access to the account data
- validUntil: string (date)
-
This parameter is requesting a valid until date for the requested consent. The content is the local ASPSP date in ISODate Format, e.g. 2017-10-30. If a maximal available date is requested, a date in far future is to be used: "9999-12-31". The consent object to be retrieved by the GET Consent Request will contain the adjusted date.
- frequencyPerDay: integer (int32)
-
This field indicates the requested maximum frequency for an access per day. For a one-off access, this attribute is set to "1"
- combinedServiceIndicator: boolean
-
If "true" indicates that a payment initiation service will be addressed in the same "session", cp. Section 8.
Example
{
"access": {
"accounts": [
{
"currency": "string",
"iban": "string",
"maskedPan": "string",
"msisdn": "string",
"pan": "string"
}
],
"allPsd2": "string",
"availableAccounts": "string",
"balances": [
{
"currency": "string",
"iban": "string",
"maskedPan": "string",
"msisdn": "string",
"pan": "string"
}
],
"transactions": [
{
"currency": "string",
"iban": "string",
"maskedPan": "string",
"msisdn": "string",
"pan": "string"
}
]
},
"recurringIndicator": "boolean",
"validUntil": "2018-10-30",
"frequencyPerDay": 1,
"combinedServiceIndicator": "boolean"
}
CreateConsentResponse: object
Example
{
"_links": [
{
"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"rel": "string",
"templated": "boolean",
"title": "string",
"type": "string"
}
],
"consentId": "string",
"consentStatus": "string"
}
GetConsentResponse: object
- _links: Link
-
Link - access: AccountAccess
- consentStatus: string RECEIVED, REJECTED, VALID, REVOKED_BY_PSU, EXPIRED, TERMINATED_BY_TPP
- frequencyPerDay: integer (int32)
- lastActionDate: string (date)
- recurringIndicator: boolean
- validUntil: string (date)
Example
{
"_links": [
{
"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"rel": "string",
"templated": "boolean",
"title": "string",
"type": "string"
}
],
"access": {
"accounts": [
{
"currency": "string",
"iban": "string",
"maskedPan": "string",
"msisdn": "string",
"pan": "string"
}
],
"allPsd2": "string",
"availableAccounts": "string",
"balances": [
{
"currency": "string",
"iban": "string",
"maskedPan": "string",
"msisdn": "string",
"pan": "string"
}
],
"transactions": [
{
"currency": "string",
"iban": "string",
"maskedPan": "string",
"msisdn": "string",
"pan": "string"
}
]
},
"consentStatus": "string",
"frequencyPerDay": "integer (int32)",
"lastActionDate": "string (date)",
"recurringIndicator": "boolean",
"validUntil": "string (date)"
}
GetConsentStatusResponse: object
Example
{
"_links": [
{
"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"rel": "string",
"templated": "boolean",
"title": "string",
"type": "string"
}
],
"consentStatus": "string"
}
FundsConfirmationRequest: object
- account: IbanAccountReference
-
PSU's account number
- cardNumber: string
-
Card Number of the card issued by the PIISP. Should be delivered if available
- instructedAmount: Amount
-
Transaction amount to be checked within the funds check mechanism
- payee: string (up to 70 chars)
-
The merchant where the card is accepted as an information to the PSU
Example
{
"account": {
"iban": "FI9814283500171141"
},
"cardNumber": "string",
"instructedAmount": {
"amount": 123.5,
"currency": "EUR"
},
"payee": "string"
}
FundsConfirmationResponse: object
- fundsAvailable: boolean
-
Equals "true" if sufficient funds are available at the time of the request, "false" otherwise
Example
{
"fundsAvailable": "boolean"
}
Address: object
- buildingNumber: string
-
Building number
- city: string
-
City or municipality
- country: string
-
ISO 3166-1 alpha-2 country code
- postalCode: string
-
Postal code
- street: string
-
Street name
Example
{
"buildingNumber": 12,
"city": "Espoo",
"country": "FI",
"postalCode": "02130",
"street": "Metsänneidonkuja"
}
CrossBorderCreditTransfer: object
Holds information needed for initiating a cross-border credit transfer
- chargeBearer: string DEBT, CRED, SHAR, SLEV
-
Transaction charge bearer
- creditorAgent: string
-
Creditors account servicing financial institution
- creditorName: string
-
Name of the creditor
- debtorAccount: IbanAccountReference
- remittanceInformationUnstructured: string
-
Message field to creditor
- instructedAmount: Amount
- creditorAccount: IbanAccountReference
- creditorAddress: Address
Example
{
"chargeBearer": "string",
"creditorAgent": "BSUIFIHH",
"creditorName": "Firstname Lastname",
"debtorAccount": {
"iban": "FI9814283500171141"
},
"remittanceInformationUnstructured": "Message to you",
"instructedAmount": {
"amount": 123.5,
"currency": "EUR"
},
"creditorAccount": {
"iban": "FI9814283500171141"
},
"creditorAddress": {
"buildingNumber": 12,
"city": "Espoo",
"country": "FI",
"postalCode": "02130",
"street": "Metsänneidonkuja"
}
}
PaymentInformationResponse: object
- creditorAccount: IbanAccountReference
- creditorAddress: Address
- creditorName: string
-
Name of the creditor
- debtorAccount: IbanAccountReference
- instructedAmount: Amount
- remittanceInformationStructured: RemittanceInformationStructured
- remittanceInformationUnstructured: string
-
Message field to creditor
Example
{
"creditorAccount": {
"iban": "FI9814283500171141"
},
"creditorAddress": {
"buildingNumber": 12,
"city": "Espoo",
"country": "FI",
"postalCode": "02130",
"street": "Metsänneidonkuja"
},
"creditorName": "Firstname Lastname",
"debtorAccount": {
"iban": "FI9814283500171141"
},
"instructedAmount": {
"amount": 123.5,
"currency": "EUR"
},
"remittanceInformationStructured": {
"reference": "RF67123456780"
},
"remittanceInformationUnstructured": "Message to you"
}
PaymentInitiationResponse: object
Example
{
"links": [
{
"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"rel": "string",
"templated": "boolean",
"title": "string",
"type": "string"
}
],
"paymentId": "string (uuid)",
"transactionFeeIndicator": "boolean",
"transactionFees": {
"amount": 123.5,
"currency": "EUR"
},
"transactionStatus": "string"
}
PaymentStatusResponse: object
- transactionStatus: string ACCP, ACSC, ACSP, ACTC, ACWC, ACWP, RCVD, PDNG, RJCT
Example
{
"transactionStatus": "string"
}
RemittanceInformationStructured: object
- reference: string
-
Actual reference number
Example
{
"reference": "RF67123456780"
}
SepaCreditTransfer: object
Holds information needed for initiating a SEPA credit transfer
- creditorAccount: IbanAccountReference
- creditorAddress: Address
- creditorAgent: string
-
Creditors account servicing financial institution
- creditorName: string
-
Name of the creditor
- debtorAccount: IbanAccountReference
- endToEndIdentification: string
-
Unique end to end identity
- instructedAmount: Amount
- remittanceInformationStructured: RemittanceInformationStructured
- remittanceInformationUnstructured: string
-
Message field to creditor
Example
{
"creditorAccount": {
"iban": "FI9814283500171141"
},
"creditorAddress": {
"buildingNumber": 12,
"city": "Espoo",
"country": "FI",
"postalCode": "02130",
"street": "Metsänneidonkuja"
},
"creditorAgent": "BSUIFIHH",
"creditorName": "Firstname Lastname",
"debtorAccount": {
"iban": "FI9814283500171141"
},
"endToEndIdentification": "Firstname Lastname",
"instructedAmount": {
"amount": 123.5,
"currency": "EUR"
},
"remittanceInformationStructured": {
"reference": "RF67123456780"
},
"remittanceInformationUnstructured": "Message to you"
}