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

Paths

Read Account List

GET /v1/accounts

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.

Consent-ID: string
in header

The consentId of the related AIS consent

PSU-Accept: string
in header

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available

PSU-Accept-Charset: string
in header

The forwarded header field of the HTTP request between PSU and TPP, if available

PSU-Accept-Encoding: string
in header

The forwarded header field of the HTTP request between PSU and TPP, if available

PSU-Accept-Language: string
in header

The forwarded header field of the HTTP request between PSU and TPP, if available

PSU-Device-ID: string
in header

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

PSU-Geo-Location: string
in header

The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available

PSU-Http-Method: string GET, POST, PUT, PATCH, DELETE
in header

HTTP method used at the PSU to TPP interface, if available

PSU-IP-Address: string
in header

The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP

PSU-IP-Port: string
in header

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available

PSU-User-Agent: string
in header

The forwarded Agent header field of the HTTP request between PSU and TPP, if available

X-Request-ID: string
in header

ID of the request, unique to the call, as determined by the initiating party

withBalance: boolean
in query

If the balance of the account should be included in the response

400 Bad Request

Bad Request

401 Unauthorized

Bad Request

403 Forbidden

Forbidden

404 Not Found

Not found

405 Method Not Allowed

Method Not Allowed

406 Not Acceptable

Not Acceptable

408 Request Timeout

Request Timeout

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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": "number",
            "currency": "string"
          },
          "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

GET /v1/accounts/{accountId}

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.

Consent-ID: string
in header

The consentId of the related AIS consent

PSU-Accept: string
in header

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available

PSU-Accept-Charset: string
in header

The forwarded header field of the HTTP request between PSU and TPP, if available

PSU-Accept-Encoding: string
in header

The forwarded header field of the HTTP request between PSU and TPP, if available

PSU-Accept-Language: string
in header

The forwarded header field of the HTTP request between PSU and TPP, if available

PSU-Device-ID: string
in header

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

PSU-Geo-Location: string
in header

The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available

PSU-Http-Method: string GET, POST, PUT, PATCH, DELETE
in header

HTTP method used at the PSU to TPP interface, if available

PSU-IP-Address: string
in header

The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP

PSU-IP-Port: string
in header

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available

PSU-User-Agent: string
in header

The forwarded Agent header field of the HTTP request between PSU and TPP, if available

X-Request-ID: string
in header

ID of the request, unique to the call, as determined by the initiating party

accountId: string
in path

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

withBalance: boolean
in query

If the balance of the account should be included in the response

400 Bad Request

Bad Request

401 Unauthorized

Bad Request

403 Forbidden

Forbidden

404 Not Found

Not found

405 Method Not Allowed

Method Not Allowed

406 Not Acceptable

Not Acceptable

408 Request Timeout

Request Timeout

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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": "number",
          "currency": "string"
        },
        "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

GET /v1/accounts/{accountId}/balances

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.

Consent-ID: string
in header

The consentId of the related AIS consent

PSU-Accept: string
in header

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available

PSU-Accept-Charset: string
in header

The forwarded header field of the HTTP request between PSU and TPP, if available

PSU-Accept-Encoding: string
in header

The forwarded header field of the HTTP request between PSU and TPP, if available

PSU-Accept-Language: string
in header

The forwarded header field of the HTTP request between PSU and TPP, if available

PSU-Device-ID: string
in header

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

PSU-Geo-Location: string
in header

The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available

PSU-Http-Method: string GET, POST, PUT, PATCH, DELETE
in header

HTTP method used at the PSU to TPP interface, if available

PSU-IP-Address: string
in header

The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP

PSU-IP-Port: string
in header

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available

PSU-User-Agent: string
in header

The forwarded Agent header field of the HTTP request between PSU and TPP, if available

X-Request-ID: string
in header

ID of the request, unique to the call, as determined by the initiating party

accountId: string
in path

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.

400 Bad Request

Bad Request

401 Unauthorized

Bad Request

403 Forbidden

Forbidden

404 Not Found

Not found

405 Method Not Allowed

Method Not Allowed

406 Not Acceptable

Not Acceptable

408 Request Timeout

Request Timeout

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests

500 Internal Server Error

Internal Server Error

503 Service Unavailable

Service Unavailable

Response Content-Types: */*, application/json
Response Example (200 OK)
{
  "account": {
    "currency": "string",
    "iban": "string"
  },
  "balances": [
    {
      "balanceAmount": {
        "amount": "number",
        "currency": "string"
      },
      "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

GET /v1/accounts/{accountId}/transactions

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.

Consent-ID: string
in header

The consentId of the related AIS consent

PSU-Accept: string
in header

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available

PSU-Accept-Charset: string
in header

The forwarded header field of the HTTP request between PSU and TPP, if available

PSU-Accept-Encoding: string
in header

The forwarded header field of the HTTP request between PSU and TPP, if available

PSU-Accept-Language: string
in header

The forwarded header field of the HTTP request between PSU and TPP, if available

PSU-Device-ID: string
in header

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

PSU-Geo-Location: string
in header

The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available

PSU-Http-Method: string GET, POST, PUT, PATCH, DELETE
in header

HTTP method used at the PSU to TPP interface, if available

PSU-IP-Address: string
in header

The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP

PSU-IP-Port: string
in header

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available

PSU-User-Agent: string
in header

The forwarded Agent header field of the HTTP request between PSU and TPP, if available

X-Request-ID: string
in header

ID of the request, unique to the call, as determined by the initiating party

accountId: string
in path

The account id which the details should be fetched

bookingStatus: string booked, pending, both
in query

The status of the transactionDetails to be included

dateFrom: string (date)
in query

Starting date (inclusive the date dateFrom) of the transaction list

dateTo: string (date)
in query

End date (inclusive the data dateTo) of the transaction list, defaults to now if not given

withBalance: boolean
in query

If the balance of the account should be included in the response

400 Bad Request

Bad Request

401 Unauthorized

Bad Request

403 Forbidden

Forbidden

404 Not Found

Not found

405 Method Not Allowed

Method Not Allowed

406 Not Acceptable

Not Acceptable

408 Request Timeout

Request Timeout

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests

500 Internal Server Error

Internal Server Error

503 Service Unavailable

Service Unavailable

Response Content-Types: application/json
Response Example (200 OK)
{
  "account": {
    "currency": "string",
    "iban": "string"
  },
  "balances": [
    {
      "balanceAmount": {
        "amount": "number",
        "currency": "string"
      },
      "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": [
      {
        "bookingDate": "string (date)",
        "checkId": "string",
        "creditorAccount": {
          "currency": "string",
          "iban": "string"
        },
        "creditorId": "string",
        "creditorName": "string",
        "endToEndId": "string",
        "entryReference": "string",
        "exchangeRate": [
          {
            "currencyFrom": "EUR",
            "currencyTo": "EUR",
            "rateContract": "string",
            "rateDate": "string (date)",
            "rateFrom": "string",
            "rateTo": "string"
          }
        ],
        "mandateId": "string",
        "transactionAmount": {
          "amount": "number",
          "currency": "string"
        },
        "transactionId": "string",
        "valueDate": "string (date)"
      }
    ],
    "pending": [
      {
        "bookingDate": "string (date)",
        "checkId": "string",
        "creditorAccount": {
          "currency": "string",
          "iban": "string"
        },
        "creditorId": "string",
        "creditorName": "string",
        "endToEndId": "string",
        "entryReference": "string",
        "exchangeRate": [
          {
            "currencyFrom": "EUR",
            "currencyTo": "EUR",
            "rateContract": "string",
            "rateDate": "string (date)",
            "rateFrom": "string",
            "rateTo": "string"
          }
        ],
        "mandateId": "string",
        "transactionAmount": {
          "amount": "number",
          "currency": "string"
        },
        "transactionId": "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

Read Transaction Details

GET /v1/accounts/{accountId}/transactions/{resourceId}

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.

Consent-ID: string
in header

The consentId of the related AIS consent

PSU-Accept: string
in header

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available

PSU-Accept-Charset: string
in header

The forwarded header field of the HTTP request between PSU and TPP, if available

PSU-Accept-Encoding: string
in header

The forwarded header field of the HTTP request between PSU and TPP, if available

PSU-Accept-Language: string
in header

The forwarded header field of the HTTP request between PSU and TPP, if available

PSU-Device-ID: string
in header

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

PSU-Geo-Location: string
in header

The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available

PSU-Http-Method: string GET, POST, PUT, PATCH, DELETE
in header

HTTP method used at the PSU to TPP interface, if available

PSU-IP-Address: string
in header

The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP

PSU-IP-Port: string
in header

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available

PSU-User-Agent: string
in header

The forwarded Agent header field of the HTTP request between PSU and TPP, if available

X-Request-ID: string
in header

ID of the request, unique to the call, as determined by the initiating party

accountId: string
in path

This identification is denoting the addressed account, where the transaction has been performed

resourceId: string
in path

This identification is given by the attribute transactionId of the corresponding entry of a transaction list

400 Bad Request

Bad Request

401 Unauthorized

Bad Request

403 Forbidden

Forbidden

404 Not Found

Not found

405 Method Not Allowed

Method Not Allowed

406 Not Acceptable

Not Acceptable

408 Request Timeout

Request Timeout

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests

500 Internal Server Error

Internal Server Error

503 Service Unavailable

Service Unavailable

Response Content-Types: application/json
Response Example (200 OK)
{
  "transactionDetails": {
    "bookingDate": "string (date)",
    "checkId": "string",
    "creditorAccount": {
      "currency": "string",
      "iban": "string"
    },
    "creditorId": "string",
    "creditorName": "string",
    "endToEndId": "string",
    "entryReference": "string",
    "exchangeRate": [
      {
        "currencyFrom": "EUR",
        "currencyTo": "EUR",
        "rateContract": "string",
        "rateDate": "string (date)",
        "rateFrom": "string",
        "rateTo": "string"
      }
    ],
    "mandateId": "string",
    "transactionAmount": {
      "amount": "number",
      "currency": "string"
    },
    "transactionId": "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

POST /v1/consents

consentRequest

Authorization: string
in header

Contains the OAuth 2.0 Bearer Token

Consent-ID: string
in header

The consentId of the related AIS consent

PSU-Accept: string
in header

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available

PSU-Accept-Charset: string
in header

The forwarded header field of the HTTP request between PSU and TPP, if available

PSU-Accept-Encoding: string
in header

The forwarded header field of the HTTP request between PSU and TPP, if available

PSU-Accept-Language: string
in header

The forwarded header field of the HTTP request between PSU and TPP, if available

PSU-Device-ID: string
in header

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

PSU-Geo-Location: string
in header

The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available

PSU-Http-Method: string GET, POST, PUT, PATCH, DELETE
in header

HTTP method used at the PSU to TPP interface, if available

PSU-IP-Address: string
in header

The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP

PSU-IP-Port: string
in header

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available

PSU-User-Agent: string
in header

The forwarded Agent header field of the HTTP request between PSU and TPP, if available

X-Request-ID: string
in header

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"
}
201 Created

Account information consent was created

400 Bad Request

Validation error occurred

401 Unauthorized

The requestor is not correctly authorized to perform the request

403 Forbidden

Forbidden

404 Not Found

Not Found

500 Internal Server Error

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

GET /v1/consents/{consentId}
Authorization: string
in header

Contains the OAuth 2.0 Bearer Token

Consent-ID: string
in header

The consentId of the related AIS consent

PSU-Accept: string
in header

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available

PSU-Accept-Charset: string
in header

The forwarded header field of the HTTP request between PSU and TPP, if available

PSU-Accept-Encoding: string
in header

The forwarded header field of the HTTP request between PSU and TPP, if available

PSU-Accept-Language: string
in header

The forwarded header field of the HTTP request between PSU and TPP, if available

PSU-Device-ID: string
in header

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

PSU-Geo-Location: string
in header

The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available

PSU-Http-Method: string GET, POST, PUT, PATCH, DELETE
in header

HTTP method used at the PSU to TPP interface, if available

PSU-IP-Address: string
in header

The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP

PSU-IP-Port: string
in header

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available

PSU-User-Agent: string
in header

The forwarded Agent header field of the HTTP request between PSU and TPP, if available

X-Request-ID: string
in header

ID of the request, unique to the call, as determined by the initiating party

consentId: string
in path

consentId

Account information consent is returned

400 Bad Request

Validation error occurred

401 Unauthorized

The requestor is not authorized to perform the request

403 Forbidden

Forbidden

404 Not Found

The requested account information consent does not exist

405 Method Not Allowed

Method Not Allowed

406 Not Acceptable

Not Acceptable

408 Request Timeout

Request Timeout

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests

500 Internal Server Error

Internal server error

503 Service Unavailable

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

DELETE /v1/consents/{consentId}
Authorization: string
in header

Contains the OAuth 2.0 Bearer Token

Consent-ID: string
in header

The consentId of the related AIS consent

PSU-Accept: string
in header

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available

PSU-Accept-Charset: string
in header

The forwarded header field of the HTTP request between PSU and TPP, if available

PSU-Accept-Encoding: string
in header

The forwarded header field of the HTTP request between PSU and TPP, if available

PSU-Accept-Language: string
in header

The forwarded header field of the HTTP request between PSU and TPP, if available

PSU-Device-ID: string
in header

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

PSU-Geo-Location: string
in header

The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available

PSU-Http-Method: string GET, POST, PUT, PATCH, DELETE
in header

HTTP method used at the PSU to TPP interface, if available

PSU-IP-Address: string
in header

The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP

PSU-IP-Port: string
in header

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available

PSU-User-Agent: string
in header

The forwarded Agent header field of the HTTP request between PSU and TPP, if available

X-Request-ID: string
in header

ID of the request, unique to the call, as determined by the initiating party

consentId: string
in path

consentId

200 OK

OK

204 No Content

Consent was deleted

400 Bad Request

Validation error occurred

401 Unauthorized

The requestor is not authorized to perform the request

403 Forbidden

Forbidden

404 Not Found

The requested account information consent does not exist

500 Internal Server Error

Internal server error

Response Content-Types: */*

Get Consent Request Status

GET /v1/consents/{consentId}/status
Authorization: string
in header

Contains the OAuth 2.0 Bearer Token

Consent-ID: string
in header

The consentId of the related AIS consent

PSU-Accept: string
in header

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available

PSU-Accept-Charset: string
in header

The forwarded header field of the HTTP request between PSU and TPP, if available

PSU-Accept-Encoding: string
in header

The forwarded header field of the HTTP request between PSU and TPP, if available

PSU-Accept-Language: string
in header

The forwarded header field of the HTTP request between PSU and TPP, if available

PSU-Device-ID: string
in header

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

PSU-Geo-Location: string
in header

The forwarded Geo Location of the corresponding HTTP request between PSU and TPP if available

PSU-Http-Method: string GET, POST, PUT, PATCH, DELETE
in header

HTTP method used at the PSU to TPP interface, if available

PSU-IP-Address: string
in header

The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP

PSU-IP-Port: string
in header

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available

PSU-User-Agent: string
in header

The forwarded Agent header field of the HTTP request between PSU and TPP, if available

X-Request-ID: string
in header

ID of the request, unique to the call, as determined by the initiating party

consentId: string
in path

consentId

Account information consent is returned

400 Bad Request

Validation error occurred

401 Unauthorized

The requestor is not authorized to perform the request

403 Forbidden

Forbidden

404 Not Found

The requested consent does not exist

405 Method Not Allowed

Method Not Allowed

406 Not Acceptable

Not Acceptable

408 Request Timeout

Request Timeout

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests

500 Internal Server Error

Internal server error

503 Service Unavailable

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

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": "number",
        "currency": "string"
      },
      "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
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": [
    {
      "bookingDate": "string (date)",
      "checkId": "string",
      "creditorAccount": {
        "currency": "string",
        "iban": "string"
      },
      "creditorId": "string",
      "creditorName": "string",
      "endToEndId": "string",
      "entryReference": "string",
      "exchangeRate": [
        {
          "currencyFrom": "EUR",
          "currencyTo": "EUR",
          "rateContract": "string",
          "rateDate": "string (date)",
          "rateFrom": "string",
          "rateTo": "string"
        }
      ],
      "mandateId": "string",
      "transactionAmount": {
        "amount": "number",
        "currency": "string"
      },
      "transactionId": "string",
      "valueDate": "string (date)"
    }
  ],
  "pending": [
    {
      "bookingDate": "string (date)",
      "checkId": "string",
      "creditorAccount": {
        "currency": "string",
        "iban": "string"
      },
      "creditorId": "string",
      "creditorName": "string",
      "endToEndId": "string",
      "entryReference": "string",
      "exchangeRate": [
        {
          "currencyFrom": "EUR",
          "currencyTo": "EUR",
          "rateContract": "string",
          "rateDate": "string (date)",
          "rateFrom": "string",
          "rateTo": "string"
        }
      ],
      "mandateId": "string",
      "transactionAmount": {
        "amount": "number",
        "currency": "string"
      },
      "transactionId": "string",
      "valueDate": "string (date)"
    }
  ]
}

Amount: object

amount: number
currency: string
Example
{
  "amount": "number",
  "currency": "string"
}

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": "number",
    "currency": "string"
  },
  "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

currency: string
iban: string

IBAN of the account

Example
{
  "currency": "string",
  "iban": "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": "number",
          "currency": "string"
        },
        "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": "number",
            "currency": "string"
          },
          "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": {
    "currency": "string",
    "iban": "string"
  },
  "balances": [
    {
      "balanceAmount": {
        "amount": "number",
        "currency": "string"
      },
      "balanceType": "string",
      "lastChangeDateTime": "string (date-time)",
      "lastCommittedTransaction": "string",
      "referenceDate": "string (date)"
    }
  ]
}

ReadTransactionDetailsResponse: object

Read Transaction Details response

transactionDetails: TransactionDetails

The transaction details

Example
{
  "transactionDetails": {
    "bookingDate": "string (date)",
    "checkId": "string",
    "creditorAccount": {
      "currency": "string",
      "iban": "string"
    },
    "creditorId": "string",
    "creditorName": "string",
    "endToEndId": "string",
    "entryReference": "string",
    "exchangeRate": [
      {
        "currencyFrom": "EUR",
        "currencyTo": "EUR",
        "rateContract": "string",
        "rateDate": "string (date)",
        "rateFrom": "string",
        "rateTo": "string"
      }
    ],
    "mandateId": "string",
    "transactionAmount": {
      "amount": "number",
      "currency": "string"
    },
    "transactionId": "string",
    "valueDate": "string (date)"
  }
}

ReadTransactionListResponse: object

Read transaction list response

account: IbanAccountReference

AccountDetails reference

balances: Balance

Balances

Balance
transactions: AccountReport

The transactions

Example
{
  "account": {
    "currency": "string",
    "iban": "string"
  },
  "balances": [
    {
      "balanceAmount": {
        "amount": "number",
        "currency": "string"
      },
      "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": [
      {
        "bookingDate": "string (date)",
        "checkId": "string",
        "creditorAccount": {
          "currency": "string",
          "iban": "string"
        },
        "creditorId": "string",
        "creditorName": "string",
        "endToEndId": "string",
        "entryReference": "string",
        "exchangeRate": [
          {
            "currencyFrom": "EUR",
            "currencyTo": "EUR",
            "rateContract": "string",
            "rateDate": "string (date)",
            "rateFrom": "string",
            "rateTo": "string"
          }
        ],
        "mandateId": "string",
        "transactionAmount": {
          "amount": "number",
          "currency": "string"
        },
        "transactionId": "string",
        "valueDate": "string (date)"
      }
    ],
    "pending": [
      {
        "bookingDate": "string (date)",
        "checkId": "string",
        "creditorAccount": {
          "currency": "string",
          "iban": "string"
        },
        "creditorId": "string",
        "creditorName": "string",
        "endToEndId": "string",
        "entryReference": "string",
        "exchangeRate": [
          {
            "currencyFrom": "EUR",
            "currencyTo": "EUR",
            "rateContract": "string",
            "rateDate": "string (date)",
            "rateFrom": "string",
            "rateTo": "string"
          }
        ],
        "mandateId": "string",
        "transactionAmount": {
          "amount": "number",
          "currency": "string"
        },
        "transactionId": "string",
        "valueDate": "string (date)"
      }
    ]
  }
}

TransactionDetails: object

Transaction details

bookingDate: string (date)
checkId: string

Identification of a Cheque

creditorAccount: IbanAccountReference

Creditor account

creditorId: string

Identification of Creditors, e.g. a SEPA Creditor ID

creditorName: string

Creditor name

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
ExchangeRate
mandateId: string

Identification of Mandates, e.g. a SEPA Mandate ID

transactionAmount: Amount
transactionId: string

the Transaction Id 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

valueDate: string (date)
Example
{
  "bookingDate": "string (date)",
  "checkId": "string",
  "creditorAccount": {
    "currency": "string",
    "iban": "string"
  },
  "creditorId": "string",
  "creditorName": "string",
  "endToEndId": "string",
  "entryReference": "string",
  "exchangeRate": [
    {
      "currencyFrom": "EUR",
      "currencyTo": "EUR",
      "rateContract": "string",
      "rateDate": "string (date)",
      "rateFrom": "string",
      "rateTo": "string"
    }
  ],
  "mandateId": "string",
  "transactionAmount": {
    "amount": "number",
    "currency": "string"
  },
  "transactionId": "string",
  "valueDate": "string (date)"
}

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

_links: Link
Link
consentId: string
consentStatus: string RECEIVED, REJECTED, VALID, REVOKED_BY_PSU, EXPIRED, TERMINATED_BY_TPP
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

_links: Link
Link
consentStatus: string RECEIVED, REJECTED, VALID, REVOKED_BY_PSU, EXPIRED, TERMINATED_BY_TPP
Example
{
  "_links": [
    {
      "deprecation": "string",
      "href": "string",
      "hreflang": "string",
      "media": "string",
      "rel": "string",
      "templated": "boolean",
      "title": "string",
      "type": "string"
    }
  ],
  "consentStatus": "string"
}