This set of methods involves the implementation of a PSD2 compliant API based on Berlin Group XS2A Framework.
Base Gateway API Endpoint
Paths
/consents
/consents/{consentId}
/consents/{consentId}/status
/consents/{consentId}/authorisations
/consents/{consentId}/authorisations/{authorisationId}
/accounts
getAccountList
Read the identifiers of the available payment account together with booking balance information, depending on the consent granted.
Resource Owner Implicit Grant Type
This header should be in the form "Bearer Token", where Token is returned from the call to OAuth2.
Application's client id
EIDAS QWac Client Certificate, for EBA Catalog verification
ID of the request, unique to the call, as determined by the initiating party.
This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.
If contained, this function reads the list of accessible payment accounts including the booking balance, if granted by the PSU in the related consent and available by the ASPSP. This parameter might be ignored by the ASPSP.
Is contained if and only if the "Signature" element is contained in the header of the request.
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.
The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
HTTP method used at the PSU ? TPP interface, if available. Valid values are:
- GET
- POST
- PUT
- PATCH
- DELETE
{
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
]
}UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
The forwarded Geo Location of the corresponding http request between PSU and TPP if available.
{
"pattern": "GEO:-?[0-9]{1,2}\\.[0-9]{6};-?[0-9]{1,3}\\.[0-9]{6}"
}OK
Bad Request
Not Authorized
Consent Unknown
Not Found
Service Invalid
Not Acceptable
Request Timeout
Status Invalid
Unsupported Media Type
Too Many Requests
Service Unavailable
Internal Server Error
/accounts/{account-id}
readAccountDetails
Reads details about an account, with balances where required.
Resource Owner Implicit Grant Type
This header should be in the form "Bearer Token", where Token is returned from the call to OAuth2.
Application's client id
EIDAS QWac Client Certificate, for EBA Catalog verification
This identification is denoting the addressed account. The account-id is retrieved by using a "Read Account List" call. The account-id is the "id" attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent.
ID of the request, unique to the call, as determined by the initiating party.
This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.
If contained, this function reads the list of accessible payment accounts including the booking balance, if granted by the PSU in the related consent and available by the ASPSP. This parameter might be ignored by the ASPSP.
Is contained if and only if the "Signature" element is contained in the header of the request.
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.
The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
HTTP method used at the PSU ? TPP interface, if available. Valid values are:
- GET
- POST
- PUT
- PATCH
- DELETE
{
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
]
}UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
The forwarded Geo Location of the corresponding http request between PSU and TPP if available.
{
"pattern": "GEO:-?[0-9]{1,2}\\.[0-9]{6};-?[0-9]{1,3}\\.[0-9]{6}"
}Bad Request
Not Authorized
Consent Unknown
Not Found
Service Invalid
Not Acceptable
Request Timeout
Status Invalid
Unsupported Media Type
Too Many Requests
Service Unavailable
Internal Server Error
/accounts/{account-id}/balances
getBalances
Reads account balances data from a given account addressed by "account-id"
Resource Owner Implicit Grant Type
This header should be in the form "Bearer Token", where Token is returned from the call to OAuth2.
Application's client id
EIDAS QWac Client Certificate, for EBA Catalog verification
This identification is denoting the addressed account. The account-id is retrieved by using a "Read Account List" call. The account-id is the "id" attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent.
ID of the request, unique to the call, as determined by the initiating party.
This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.
Is contained if and only if the "Signature" element is contained in the header of the request.
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.
The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
HTTP method used at the PSU ? TPP interface, if available. Valid values are:
- GET
- POST
- PUT
- PATCH
- DELETE
{
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
]
}UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
The forwarded Geo Location of the corresponding http request between PSU and TPP if available.
{
"pattern": "GEO:-?[0-9]{1,2}\\.[0-9]{6};-?[0-9]{1,3}\\.[0-9]{6}"
}Bad Request
Not Authorized
Consent Unknown
Not Found
Service Invalid
Not Acceptable
Request Timeout
Status Invalid
Unsupported Media Type
Too Many Requests
Service Unavailable
Internal Server Error
/accounts/{account-id}/transactions
getTransactionList
Read transaction reports or transaction lists of a given account ddressed by "account-id", depending on the steering parameter "bookingStatus" together with balances. For a given account, additional parameters are e.g. the attributes "dateFrom" and "dateTo".
Resource Owner Implicit Grant Type
This header should be in the form "Bearer Token", where Token is returned from the call to OAuth2.
Application's client id
EIDAS QWac Client Certificate, for EBA Catalog verification
This identification is denoting the addressed account. The account-id is retrieved by using a "Read Account List" call. The account-id is the "id" attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent.
Permitted codes are
- "booked",
- "pending" and
- "both" "booked" shall be supported by the ASPSP. To support the "pending" and "both" feature is optional for the ASPSP, Error code if not supported in the online banking frontend
{
"enum": [
"booked",
"pending",
"both"
]
}ID of the request, unique to the call, as determined by the initiating party.
This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.
Conditional: Starting date (inclusive the date dateFrom) of the transaction list, mandated if no delta access is required.
For booked transactions, the relevant date is the booking date.
For pending transactions, the relevant date is the entry date, which may not be transparent neither in this API nor other channels of the ASPSP.
End date (inclusive the data dateTo) of the transaction list, default is "now" if not given.
Might be ignored if a delta function is used.
For booked transactions, the relevant date is the booking date.
For pending transactions, the relevant date is the entry date, which may not be transparent neither in this API nor other channels of the ASPSP.
This data attribute is indicating that the AISP is in favour to get all transactions after the transaction with identification entryReferenceFrom alternatively to the above defined period. This is a implementation of a delta access. If this data element is contained, the entries "dateFrom" and "dateTo" might be ignored by the ASPSP if a delta report is supported.
Optional if supported by API provider.
This data attribute is indicating that the AISP is in favour to get all transactions after the last report access for this PSU on the addressed account. This is another implementation of a delta access-report. This delta indicator might be rejected by the ASPSP if this function is not supported. Optional if supported by API provider
If contained, this function reads the list of accessible payment accounts including the booking balance, if granted by the PSU in the related consent and available by the ASPSP. This parameter might be ignored by the ASPSP.
Is contained if and only if the "Signature" element is contained in the header of the request.
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.
The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
HTTP method used at the PSU ? TPP interface, if available. Valid values are:
- GET
- POST
- PUT
- PATCH
- DELETE
{
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
]
}UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
The forwarded Geo Location of the corresponding http request between PSU and TPP if available.
{
"pattern": "GEO:-?[0-9]{1,2}\\.[0-9]{6};-?[0-9]{1,3}\\.[0-9]{6}"
}Bad Request
Not Authorized
Consent Unknown
Not Found
Service Invalid
Not Acceptable
Request Timeout
Status Invalid
Unsupported Media Type
Too Many Requests
Service Unavailable
Internal Server Error
/accounts/{account-id}/transactions/{resourceId}
getTransactionDetails
Reads transaction details from a given transaction addressed by "resourceId" on a given account addressed by "account-id".
Resource Owner Implicit Grant Type
This header should be in the form "Bearer Token", where Token is returned from the call to OAuth2.
Application's client id
EIDAS QWac Client Certificate, for EBA Catalog verification
This identification is denoting the addressed account. The account-id is retrieved by using a "Read Account List" call. The account-id is the "id" attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent.
This identification is given by the attribute resourceId of the corresponding entry of a transaction list.
ID of the request, unique to the call, as determined by the initiating party.
This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.
Is contained if and only if the "Signature" element is contained in the header of the request.
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.
The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
HTTP method used at the PSU ? TPP interface, if available. Valid values are:
- GET
- POST
- PUT
- PATCH
- DELETE
{
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
]
}UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
The forwarded Geo Location of the corresponding http request between PSU and TPP if available.
{
"pattern": "GEO:-?[0-9]{1,2}\\.[0-9]{6};-?[0-9]{1,3}\\.[0-9]{6}"
}Bad Request
Not Authorized
Consent Unknown
Not Found
Service Invalid
Not Acceptable
Request Timeout
Status Invalid
Unsupported Media Type
Too Many Requests
Service Unavailable
Internal Server Error
/card-accounts
getCardAccount
Reads a list of card accounts with additional information, e.g. balance information. It is assumed that a consent of the PSU to this access is already given and stored on the ASPSP system. The addressed list of card accounts depends then on the PSU ID and the stored consent addressed by consentId, respectively the OAuth2 access token.
Resource Owner Implicit Grant Type
This header should be in the form "Bearer Token", where Token is returned from the call to OAuth2.
Application's client id
EIDAS QWac Client Certificate, for EBA Catalog verification
ID of the request, unique to the call, as determined by the initiating party.
This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.
Is contained if and only if the "Signature" element is contained in the header of the request.
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.
The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
HTTP method used at the PSU ? TPP interface, if available. Valid values are:
- GET
- POST
- PUT
- PATCH
- DELETE
{
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
]
}UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
The forwarded Geo Location of the corresponding http request between PSU and TPP if available.
{
"pattern": "GEO:-?[0-9]{1,2}\\.[0-9]{6};-?[0-9]{1,3}\\.[0-9]{6}"
}Bad Request
Not Authorized
Consent Unknown
Not Found
Service Invalid
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Service Unavailable
Internal Server Error
/card-accounts/{account-id}
ReadCardAccount
Reads details about a card account. It is assumed that a consent of the PSU to this access is already given and stored on the ASPSP system. The addressed details of this account depends then on the stored consent addressed by consentId, respectively the OAuth2 access token.
Resource Owner Implicit Grant Type
This header should be in the form "Bearer Token", where Token is returned from the call to OAuth2.
Application's client id
EIDAS QWac Client Certificate, for EBA Catalog verification
This identification is denoting the addressed account. The account-id is retrieved by using a "Read Account List" call. The account-id is the "id" attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent.
ID of the request, unique to the call, as determined by the initiating party.
This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.
Is contained if and only if the "Signature" element is contained in the header of the request.
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.
The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
HTTP method used at the PSU ? TPP interface, if available. Valid values are:
- GET
- POST
- PUT
- PATCH
- DELETE
{
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
]
}UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
The forwarded Geo Location of the corresponding http request between PSU and TPP if available.
{
"pattern": "GEO:-?[0-9]{1,2}\\.[0-9]{6};-?[0-9]{1,3}\\.[0-9]{6}"
}Bad Request
Not Authorized
Consent Unknown
Not Found
Service Invalid
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Service Unavailable
Internal Server Error
/card-accounts/{account-id}/balances
getCardAccountBalances
Reads balance data from a given card account addressed by "account-id".
Remark: This account-id can be a tokenised identification due to data protection reason since the path information might be logged on intermediary servers within the ASPSP sphere. This account-id then can be retrieved by the "GET Card Account List" call
Resource Owner Implicit Grant Type
This header should be in the form "Bearer Token", where Token is returned from the call to OAuth2.
Application's client id
EIDAS QWac Client Certificate, for EBA Catalog verification
This identification is denoting the addressed account. The account-id is retrieved by using a "Read Account List" call. The account-id is the "id" attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent.
ID of the request, unique to the call, as determined by the initiating party.
This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.
Is contained if and only if the "Signature" element is contained in the header of the request.
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.
The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
HTTP method used at the PSU ? TPP interface, if available. Valid values are:
- GET
- POST
- PUT
- PATCH
- DELETE
{
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
]
}UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
The forwarded Geo Location of the corresponding http request between PSU and TPP if available.
{
"pattern": "GEO:-?[0-9]{1,2}\\.[0-9]{6};-?[0-9]{1,3}\\.[0-9]{6}"
}Bad Request
Not Authorized
Consent Unknown
Not Found
Service Invalid
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Service Unavailable
Internal Server Error
/card-accounts/{account-id}/transactions
getCardAccountTransactionList
Reads account data from a given card account addressed by "account-id".
Resource Owner Implicit Grant Type
This header should be in the form "Bearer Token", where Token is returned from the call to OAuth2.
Application's client id
EIDAS QWac Client Certificate, for EBA Catalog verification
This identification is denoting the addressed account. The account-id is retrieved by using a "Read Account List" call. The account-id is the "id" attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent.
Permitted codes are
- "booked",
- "pending" and
- "both" "booked" shall be supported by the ASPSP. To support the "pending" and "both" feature is optional for the ASPSP, Error code if not supported in the online banking frontend
{
"enum": [
"booked",
"pending",
"both"
]
}ID of the request, unique to the call, as determined by the initiating party.
This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.
Conditional: Starting date (inclusive the date dateFrom) of the transaction list, mandated if no delta access is required.
For booked transactions, the relevant date is the booking date.
For pending transactions, the relevant date is the entry date, which may not be transparent neither in this API nor other channels of the ASPSP.
End date (inclusive the data dateTo) of the transaction list, default is "now" if not given.
Might be ignored if a delta function is used.
For booked transactions, the relevant date is the booking date.
For pending transactions, the relevant date is the entry date, which may not be transparent neither in this API nor other channels of the ASPSP.
This data attribute is indicating that the AISP is in favour to get all transactions after the transaction with identification entryReferenceFrom alternatively to the above defined period. This is a implementation of a delta access. If this data element is contained, the entries "dateFrom" and "dateTo" might be ignored by the ASPSP if a delta report is supported.
Optional if supported by API provider.
This data attribute is indicating that the AISP is in favour to get all transactions after the last report access for this PSU on the addressed account. This is another implementation of a delta access-report. This delta indicator might be rejected by the ASPSP if this function is not supported. Optional if supported by API provider
If contained, this function reads the list of accessible payment accounts including the booking balance, if granted by the PSU in the related consent and available by the ASPSP. This parameter might be ignored by the ASPSP.
Is contained if and only if the "Signature" element is contained in the header of the request.
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.
The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
HTTP method used at the PSU ? TPP interface, if available. Valid values are:
- GET
- POST
- PUT
- PATCH
- DELETE
{
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
]
}UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
The forwarded Geo Location of the corresponding http request between PSU and TPP if available.
{
"pattern": "GEO:-?[0-9]{1,2}\\.[0-9]{6};-?[0-9]{1,3}\\.[0-9]{6}"
}Bad Request
Not Authorized
Consent Unknown
Not Found
Service Invalid
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Service Unavailable
Internal Server Error
Definitions
The transaction status is filled with codes of the ISO 20022 data table:
- 'ACCC' (AcceptedSettlementCompleted): Settlement on the creditor's account has been completed.
- 'ACCP' (AcceptedCustomerProfile): Preceding check of technical validation was successful. Customer profile check was also successful.
- 'ACSC' (AcceptedSettlementCompleted): Settlement on the debtor's account has been completed. This can be used by the first agent to report to the debtor that the transaction has been completed and is provided for transaction status reasons, not for financial information. It can only be used after bilateral agreement.
- 'ACSP' (AcceptedSettlementInProcess): All preceding checks such as technical validation and customer profile were successful and therefore the payment initiation has been accepted for execution.
- 'ACTC' (AcceptedTechnicalValidation): Authentication and syntactical and semantic validation are successful.
- 'ACWC' (AcceptedWithChange): Instruction is accepted but a change will be made, such as date or remittance not sent.
- 'ACWP' (AcceptedWithoutPosting): Payment instruction included in the credit transfer is accepted without being posted to the creditor customer's account.
- 'RCVD' (Received): Payment initiation has been received by the receiving agent.
- 'PDNG' (Pending): Payment initiation or individual transaction included in the payment initiation is pending. Further checks and status update will be performed.
- 'RJCT' (Rejected): Payment initiation or individual transaction included in the payment initiation has been rejected.
- 'CANC' (Cancelled): Payment initiation has been cancelled before execution. This code is accepted as new code by ISO20022.
- 'ACFC' (AcceptedFundsChecked): Preceding check of technical validation and customer profile was successful and an automatic funds check was positive. This code is accepted as new code by ISO20022.
- 'PATC' (PartiallyAcceptedTechnical): Correct The payment initiation needs multiple authentications, where some but not yet all have been performed. Syntactical and semantic validations are successful. This code is accepted as new code by ISO20022.
- 'PART' (PartiallyAccepted): A number of transactions have been accepted, whereas another number of transactions have not yet achieved 'accepted' status. This code may be used only in case of bulk payments. It is only used in a situation where all mandated authorisations have been applied, but some payments have been rejected.
{
"example": "ACCC",
"type": "string",
"enum": [
"ACCC",
"ACCP",
"ACSC",
"ACSP",
"ACTC",
"ACWC",
"ACWP",
"RCVD",
"PDNG",
"RJCT",
"CANC",
"ACFC",
"PATC",
"PART"
]
}
This data element is containing information about the status of the SCA method applied. The following codes are defined for this data type.
- 'received': An authorisation or cancellation-authorisation resource has been created successfully.
- 'psuIdentified': The PSU related to the authorisation or cancellation-authorisation resource has been identified.
- 'psuAuthenticated': The PSU related to the authorisation or cancellation-authorisation resource has been identified and authenticated e.g. by a password or by an access token.
- 'scaMethodSelected': The PSU/TPP has selected the related SCA routine. If the SCA method is chosen implicitly since only one SCA method is available, then this is the first status to be reported instead of 'received'.
- 'started': The addressed SCA routine has been started.
- 'finalised': The SCA routine has been finalised successfully.
- 'failed': The SCA routine failed.
- 'exempted': SCA was exempted for the related transaction, the related authorisation is successful.
{
"example": "received",
"type": "string",
"enum": [
"received",
"psuIdentified",
"psuAuthenticated",
"scaMethodSelected",
"started",
"finalised",
"failed",
"exempted"
]
}
This is the overall lifecycle status of the consent. Valid values are:
- 'received': The consent data have been received and are technically correct. The data is not authorised yet.
- 'rejected': The consent data have been rejected e.g. since no successful authorisation has taken place.
- 'valid': The consent is accepted and valid for GET account data calls and others as specified in the consent object.
- 'revokedByPsu': The consent has been revoked by the PSU towards the ASPSP.
- 'expired': The consent expired.
- 'terminatedByTpp': The corresponding TPP has terminated the consent by applying the DELETE method to the consent resource.
{
"example": "received",
"type": "string",
"enum": [
"received",
"rejected",
"valid",
"revokedByPsu",
"expired",
"terminatedByTpp"
]
}
Authentication Object
{
"type": "object",
"properties": {
"authenticationType": {
"$ref": "#\/definitions\/authenticationType"
},
"authenticationVersion": {
"description": "Depending on the \"authenticationType\".\nThis version can be used by differentiating authentication tools used within performing OTP generation in the same authentication type.\nThis version can be referred to in the ASPSP?s documentation.",
"type": "string"
},
"authenticationMethodId": {
"description": "An identification provided by the ASPSP for the later identification of the authentication method selection.",
"example": "myAuthenticationID",
"type": "string",
"maxLength": 35
},
"name": {
"description": "This is the name of the authentication method defined by the PSU in the Online Banking frontend of the ASPSP.\nAlternatively this could be a description provided by the ASPSP like \"SMS OTP on phone +49160 xxxxx 28\".\nThis name shall be used by the TPP when presenting a list of authentication methods to the PSU, if available.",
"example": "SMS OTP on phone +49160 xxxxx 28",
"type": "string"
},
"explanation": {
"description": "Detailed information about the SCA method for the PSU.",
"example": "Detailed information about the SCA method for the PSU.",
"type": "string"
}
},
"required": [
"authenticationType",
"authenticationMethodId"
]
}
Type of the authentication method. Valid values:
- 'SMS_OTP': An SCA method, where an OTP linked to the transaction to be authorised is sent to the PSU through a SMS channel.
- 'CHIP_OTP': An SCA method, where an OTP is generated at predefined intervals, by a chip device.
- 'PUSH_OTP': An OTP is pushed to the PSU's registered winbank mobile APP and displayed to the PSU.
- 'TOUCH_OTP': A request for approval is sent to PSU's registered winbank mobile app. If PSU approves the transaction, using phones touch functionality or dedicated pin, the SCA gets completed automatically.
{
"example": "SMS_OTP",
"type": "string",
"enum": [
"SMS_OTP",
"CHIP_OTP",
"PUSH_OTP",
"TOUCH_OTP"
]
}
It is contained in addition to the data element 'chosenScaMethod' if challenge data is needed for SCA. In rare cases this attribute is also used in the context of the 'startAuthorisationWithPsuAuthentication' link.
{
"type": "object",
"properties": {
"image": {
"description": "PNG data (max. 512 kilobyte) to be displayed to the PSU,\nBase64 encoding, cp. [RFC4648].\nThis attribute is used only, when PHOTO_OTP or CHIP_OTP\nis the selected SCA method.",
"type": "string"
},
"data": {
"description": "String challenge data",
"type": "string"
},
"imageLink": {
"description": "A link where the ASPSP will provides the challenge image for the TPP.",
"type": "string"
},
"otpMaxLength": {
"description": "The maximal length for the OTP to be typed in by the PSU.",
"type": "integer",
"format": "int32"
},
"otpFormat": {
"$ref": "#\/definitions\/OtpFormat"
},
"additionalInformation": {
"description": "Additional explanation for the PSU to explain\ne.g. fallback mechanism for the chosen SCA method.\nThe TPP is obliged to show this to the PSU.",
"type": "string"
}
}
}
Link to a resource
{
"type": "object",
"properties": {
"href": {
"description": "Link to a resource",
"example": "\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
}
}
}
Reference to an account by either:
- IBAN, of a payment accounts, or
- BBAN, for payment accounts if there is no IBAN, or
- the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
- the Primary Account Number (PAN) of a card in a masked form, or
- an alias to access a payment account via a registered mobile phone number (MSISDN).
{
"type": "object",
"properties": {
"iban": {
"description": "IBAN of an account",
"example": "FR7612345987650123456789014",
"type": "string",
"pattern": "[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}"
},
"bban": {
"description": "Basic Bank Account Number (BBAN) Identifier\n\nThis data element can be used in the body of the Consent Request\n Message for retrieving Account access Consent from this Account. This\n data elements is used for payment Accounts which have no IBAN.\n ISO20022: Basic Bank Account Number (BBAN).\n\n Identifier used nationally by financial institutions, i.e., in individual countries,\n generally as part of a National Account Numbering Scheme(s),\n which uniquely identifies the account of a customer.",
"example": "BARC12345612345678",
"type": "string",
"pattern": "[a-zA-Z0-9]{1,30}"
},
"pan": {
"description": "Primary Account Number according to ISO\/IEC 7812.",
"example": 5409050000000000,
"type": "string",
"maxLength": 35
},
"maskedPan": {
"description": "Masked Primary Account Number",
"example": "123456xxxxxx1234",
"type": "string",
"maxLength": 35
},
"msisdn": {
"description": "Mobile phone number.",
"example": "+49 170 1234567",
"type": "string",
"maxLength": 35
},
"currency": {
"description": "ISO 4217 Alpha 3 currency code",
"example": "EUR",
"type": "string",
"pattern": "[A-Z]{3}"
}
}
}
The following balance types are defined:
- "closingBooked": Balance of the account at the end of the pre-agreed account reporting period. It is the sum of the opening booked balance at the beginning of the period and all entries booked to the account during the pre-agreed account reporting period. For card-accounts, this is composed of invoiced, but not yet paid entries.
- "expected": Balance composed of booked entries and pending items known at the time of calculation, which projects the end of day balance if everything is booked on the account and no other entry is posted. For card accounts, this is composed of: i) invoiced, but not yet paid entries, ii) not yet invoiced but already booked entries and iii) pending items (not yet booked)
- "authorised": The expected balance together with the value of a pre-approved credit line the ASPSP makes permanently available to the user. For card-accounts: "money to spend with the value of a pre-approved credit limit on the card account"
- "openingBooked": Book balance of the account at the beginning of the account reporting period. It always equals the closing book balance from the previous report.
- "interimAvailable": Available balance calculated in the course of the account ?servicer?s business day, at the time specified, and subject to further changes during the business day. The interim balance is calculated on the basis of booked credit and debit items during the calculation time/period specified. For card-accounts, this is composed of: i) invoiced, but not yet paid entries, ii) not yet invoiced but already booked entries
- "forwardAvailable": Forward available balance of money that is at the disposal of the account owner on the date specified.
- "nonInvoiced": Only for card accounts, to be checked yet.
{
"example": "closingBooked",
"type": "string",
"enum": [
"closingBooked",
"expected",
"authorised",
"openingBooked",
"interimAvailable",
"interimBooked",
"forwardAvailable",
"nonInvoiced"
]
}
Requested access services for a consent.
{
"type": "object",
"properties": {
"accounts": {
"description": "Is asking for detailed account information.\n\nIf the array is empty, the TPP is asking for an accessible account list.\nThis may be restricted in a PSU\/ASPSP authorization dialogue.\nIf the array is empty, also the arrays for balances or transactions shall be empty, if used.",
"type": "array",
"items": {
"$ref": "#\/definitions\/accountReference"
}
},
"balances": {
"description": "Is asking for balances of the addressed accounts.\n\nIf the array is empty, the TPP is asking for the balances of all accessible account lists.\nThis may be restricted in a PSU\/ASPSP authorization dialogue.\nIf the array is empty, also the arrays for accounts or transactions shall be empty, if used.",
"type": "array",
"items": {
"$ref": "#\/definitions\/accountReference"
}
},
"transactions": {
"description": "Is asking for transactions of the addressed accounts.\n\nIf the array is empty, the TPP is asking for the transactions of all accessible account lists.\nThis may be restricted in a PSU\/ASPSP authorization dialogue.\nIf the array is empty, also the arrays for accounts or balances shall be empty, if used.",
"type": "array",
"items": {
"$ref": "#\/definitions\/accountReference"
}
},
"availableAccounts": {
"$ref": "#\/definitions\/AvailableAccounts"
},
"allPsd2": {
"$ref": "#\/definitions\/AllPsd2"
}
}
}
Account status. The value is one of the following:
- "enabled": account is available
- "deleted": account is terminated
- "blocked": account is blocked e.g. for legal reasons If this field is not used, than the account is available in the sense of this specification.
{
"example": "enabled",
"type": "string",
"enum": [
"enabled",
"deleted",
"blocked"
]
}
The bank provides at least one of the account reference identifiers:
- iban
- bban
- pan
- maskedPan
- msisdn If the account is a multicurrency account, currency code in "currency" is set to "XXX".
{
"type": "object",
"properties": {
"resourceId": {
"description": "This shall be filled, if addressable resource are created by the ASPSP on the \/accounts or \/card-accounts endpoint.",
"type": "string"
},
"iban": {
"description": "IBAN of an account",
"example": "FR7612345987650123456789014",
"type": "string",
"pattern": "[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}"
},
"bban": {
"description": "Basic Bank Account Number (BBAN) Identifier\n\nThis data element can be used in the body of the Consent Request\n Message for retrieving Account access Consent from this Account. This\n data elements is used for payment Accounts which have no IBAN.\n ISO20022: Basic Bank Account Number (BBAN).\n\n Identifier used nationally by financial institutions, i.e., in individual countries,\n generally as part of a National Account Numbering Scheme(s),\n which uniquely identifies the account of a customer.",
"example": "BARC12345612345678",
"type": "string",
"pattern": "[a-zA-Z0-9]{1,30}"
},
"msisdn": {
"description": "Mobile phone number.",
"example": "+49 170 1234567",
"type": "string",
"maxLength": 35
},
"currency": {
"description": "ISO 4217 Alpha 3 currency code",
"example": "EUR",
"type": "string",
"pattern": "[A-Z]{3}"
},
"name": {
"description": "Name of the account given by the bank or the PSU in online-banking.",
"type": "string",
"maxLength": 35
},
"product": {
"description": "Product name of the bank for this account, proprietary definition.",
"type": "string",
"maxLength": 35
},
"cashAccountType": {
"description": "ExternalCashAccountType1Code from ISO 20022.",
"type": "string"
},
"status": {
"$ref": "#\/definitions\/accountStatus"
},
"bic": {
"description": "BICFI",
"example": "AAAADEBBXXX",
"type": "string",
"pattern": "[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}"
},
"linkedAccounts": {
"description": "Case of a set of pending card transactions, the APSP will provide the relevant cash account the card is set up on.",
"type": "string",
"maxLength": 70
},
"usage": {
"$ref": "#\/definitions\/Usage"
},
"details": {
"description": "Specifications that might be provided by the ASPSP\n - characteristics of the account\n - characteristics of the relevant card",
"type": "string",
"maxLength": 140
},
"balances": {
"description": "A list of balances regarding this account, e.g. the current balance, the last booked balance.\nThe list migght be restricted to the current ballance.",
"type": "array",
"items": {
"$ref": "#\/definitions\/balance"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAccountDetails"
},
"ownerName": {
"type": "string",
"description": "Name of the primary beneficiary."
}
},
"required": [
"currency"
]
}
Card account details
{
"type": "object",
"properties": {
"resourceId": {
"description": "This is the data element to be used in the path when retrieving data from a dedicated account.\nThis shall be filled, if addressable resource are created by the ASPSP on the \/card-accounts endpoint.",
"type": "string"
},
"maskedPan": {
"description": "Masked Primary Account Number",
"example": "123456xxxxxx1234",
"type": "string",
"maxLength": 35
},
"currency": {
"description": "ISO 4217 Alpha 3 currency code",
"example": "EUR",
"type": "string",
"pattern": "[A-Z]{3}"
},
"name": {
"description": "Name of the account, as assigned by the ASPSP, in order to provide an additional means of identification of the account. In card accounts, it is used to distinguish cards between primary and add-on. In account details, it provides the account kind (e.g. joint tenant account)",
"type": "string",
"maxLength": 35
},
"product": {
"description": "Product name of the bank for this account, proprietary definition.",
"type": "string",
"maxLength": 35
},
"status": {
"$ref": "#\/definitions\/accountStatus"
},
"usage": {
"$ref": "#\/definitions\/Usage"
},
"details": {
"description": "Specifications that might be provided by the ASPSP\n - characteristics of the account\n - characteristics of the relevant card",
"type": "string",
"maxLength": 140
},
"creditLimit": {
"$ref": "#\/definitions\/amount"
},
"balances": {
"description": "A list of balances regarding this account, e.g. the current balance, the last booked balance.\nThe list migght be restricted to the current ballance.",
"type": "array",
"items": {
"$ref": "#\/definitions\/balance"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAccountDetails"
},
"cardAccountType": {
"type": "string",
"description": "Type of card (credit, debit, prepaid)"
},
"linkedAccount": {
"type": "string",
"description": "The account to which the card is linked (if available)"
},
"ownerName": {
"type": "string",
"description": "Name of the card holder."
},
"displayName": {
"type": "string",
"description": "The account name (alias), as defined by the PSU within online channels"
},
"pan": {
"type": "string",
"description": "Primary Account Number (unmasked)",
"example": "1234567890001234"
}
},
"required": [
"currency"
]
}
List of accounts with details.
{
"type": "object",
"properties": {
"accounts": {
"type": "array",
"items": {
"$ref": "#\/definitions\/accountDetails"
},
"description": "Array of accountDetails objects."
}
},
"required": [
"accounts"
]
}
List of card accounts with details.
{
"type": "object",
"properties": {
"cardAccounts": {
"type": "array",
"items": {
"$ref": "#\/definitions\/cardAccountDetails"
}
}
},
"required": [
"cardAccounts"
]
}
JSON based account report. This account report contains transactions resulting from the query parameters.
- 'booked' shall be contained if bookingStatus parameter is set to "booked" or "both".
- 'pending' is not contained if the bookingStatus parameter is set to "booked".
{
"type": "object",
"properties": {
"booked": {
"description": "Array of transaction details",
"type": "array",
"items": {
"$ref": "#\/definitions\/transactionDetails"
}
},
"pending": {
"description": "Array of transaction details",
"type": "array",
"items": {
"$ref": "#\/definitions\/transactionDetails"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAccountReport"
}
},
"required": [
"_links"
]
}
JSON based card account report.
This card account report contains transactions resulting from the query parameters.
{
"type": "object",
"properties": {
"booked": {
"description": "Array of transaction details",
"type": "array",
"items": {
"$ref": "#\/definitions\/cardTransaction"
}
},
"pending": {
"description": "Array of transaction details",
"type": "array",
"items": {
"$ref": "#\/definitions\/cardTransaction"
}
},
"_links": {
"$ref": "#\/definitions\/_linksCardAccountReport"
}
},
"required": [
"booked",
"_links"
]
}
Transaction details
{
"type": "object",
"properties": {
"transactionId": {
"description": "Unique identification. 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 thistransaction using the GET Transaction Details Request",
"type": "string"
},
"entryReference": {
"description": "Identification of the transaction as used for reference in pagination or for delta function on application level. The same identification as for example used within camt.05x messages.",
"type": "string",
"maxLength": 35
},
"endToEndId": {
"description": "End to end idenitification, used for cross-reference in internal bank systems. Unique in single transactions performed via the electronic channels.",
"type": "string",
"maxLength": 35
},
"mandateId": {
"description": "Identification of Mandates, e.g. a SEPA Mandate ID.",
"type": "string",
"maxLength": 35
},
"checkId": {
"description": "Identification of a Cheque.",
"type": "string",
"maxLength": 35
},
"creditorId": {
"description": "Identification of Creditors, e.g. a SEPA Creditor ID.",
"type": "string",
"maxLength": 35
},
"bookingDate": {
"description": "The Date when an entry is posted to an account on the ASPSPs books.",
"type": "string",
"format": "date"
},
"valueDate": {
"description": "The Date at which assets become available to the account owner in case of a credit.",
"type": "string",
"format": "date"
},
"transactionAmount": {
"$ref": "#\/definitions\/amount"
},
"currencyExchange": {
"description": "Array of exchange rates",
"type": "array",
"items": {
"$ref": "#\/definitions\/reportExchangeRate"
}
},
"creditorName": {
"description": "Creditor Name",
"example": "Creditor Name",
"type": "string",
"maxLength": 70
},
"creditorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"ultimateCreditor": {
"description": "Ultimate Creditor",
"example": "Ultimate Creditor",
"type": "string",
"maxLength": 70
},
"debtorName": {
"description": "Debtor Name",
"example": "Debtor Name",
"type": "string",
"maxLength": 70
},
"debtorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"ultimateDebtor": {
"description": "Ultimate Debtor",
"example": "Ultimate Debtor",
"type": "string",
"maxLength": 70
},
"remittanceInformationUnstructured": {
"description": "Unstructured remittance information",
"example": "Ref Number Merchant",
"type": "string",
"maxLength": 140
},
"remittanceInformationStructured": {
"description": "Reference as contained in the structured remittance reference structure (without the surrounding XML structure).\n\nDifferent from other places the content is containt in plain form not in form of a structered field.",
"type": "string",
"maxLength": 140
},
"additionalInformation": {
"description": "Might be used by the ASPSP to transport additional transaction related information to the PSU.",
"type": "string",
"maxLength": 512
},
"purposeCode": {
"$ref": "#\/definitions\/purposeCode"
},
"bankTransactionCode": {
"description": "Bank transaction code as used by the ASPSP and using the sub elements of this structured code defined by ISO 20022.\n\nThis code type is concatenating the three ISO20022 Codes\n * Domain Code,\n * Family Code, and\n * SubFamiliy Code\nby hyphens, resulting in �DomainCode�-�FamilyCode�-�SubFamilyCode�.",
"example": "PMNT-RCDT-ESCT",
"type": "string"
},
"proprietaryBankTransactionCode": {
"description": "Proprietary bank transaction code as used within a community or within an ASPSP e.g.\nfor MT94x based transaction reports.",
"type": "string",
"maxLength": 35
},
"_links": {
"$ref": "#\/definitions\/_linksTransactionDetails"
}
},
"required": [
"transactionAmount"
]
}
Card transaction information
{
"type": "object",
"properties": {
"cardTransactionId": {
"description": "Unique end to end identity.",
"type": "string",
"maxLength": 35
},
"terminalId": {
"description": "Identification of the Terminal, where the card has been used.",
"type": "string",
"maxLength": 35
},
"transactionDate": {
"description": "Date of the actual card transaction",
"type": "string",
"format": "date"
},
"bookingDate": {
"description": "The Date when an entry is posted to an account on the ASPSPs books.",
"type": "string",
"format": "date"
},
"transactionAmount": {
"$ref": "#\/definitions\/amount"
},
"currencyExchange": {
"description": "Array of exchange rates",
"type": "array",
"items": {
"$ref": "#\/definitions\/reportExchangeRate"
}
},
"originalAmount": {
"$ref": "#\/definitions\/amount"
},
"markupFee": {
"$ref": "#\/definitions\/amount"
},
"markupFeePercentage": {
"example": 0.3,
"type": "string"
},
"cardAcceptorId": {
"type": "string",
"maxLength": 35
},
"cardAcceptorAddress": {
"$ref": "#\/definitions\/address"
},
"merchantCategoryCode": {
"description": "Merchant category code",
"type": "string",
"minLength": 4,
"maxLength": 4
},
"maskedPAN": {
"description": "Masked Primary Account Number",
"example": "123456xxxxxx1234",
"type": "string",
"maxLength": 35
},
"transactionDetails": {
"type": "string",
"maxLength": 140
},
"invoiced": {
"type": "boolean"
},
"proprietaryBankTransactionCode": {
"description": "Proprietary bank transaction code as used within a community or within an ASPSP e.g.\nfor MT94x based transaction reports.",
"type": "string",
"maxLength": 35
}
},
"required": [
"transactionAmount"
]
}
Exchange Rate
{
"type": "object",
"properties": {
"sourceCurrency": {
"description": "ISO 4217 Alpha 3 currency code",
"example": "EUR",
"type": "string",
"pattern": "[A-Z]{3}"
},
"exchangeRate": {
"type": "string"
},
"unitCurrency": {
"type": "string"
},
"targetCurrency": {
"description": "ISO 4217 Alpha 3 currency code",
"example": "EUR",
"type": "string",
"pattern": "[A-Z]{3}"
},
"quotationDate": {
"type": "string",
"format": "date"
},
"contractIdentification": {
"type": "string"
}
},
"required": [
"sourceCurrency",
"exchangeRate",
"unitCurrency",
"targetCurrency",
"quotationDate"
]
}
A single balance element
{
"type": "object",
"properties": {
"balanceAmount": {
"$ref": "#\/definitions\/amount"
},
"balanceType": {
"$ref": "#\/definitions\/balanceType"
},
"lastChangeDateTime": {
"description": "This data element might be used to indicate e.g. with the expected or booked balance that no action is known\non the account, which is not yet booked.",
"type": "string",
"format": "date-time"
},
"referenceDate": {
"description": "Reference date of the balance",
"type": "string",
"format": "date"
},
"lastCommittedTransaction": {
"description": "\"entryReference\" of the last commited transaction to support the TPP in identifying whether all\nPSU transactions are already known.",
"type": "string",
"maxLength": 35
}
},
"required": [
"balanceAmount",
"balanceType"
]
}
Object containing information about a specific address
{
"example": {
"street": "rue blue",
"buildingnNumber": 89,
"city": "Paris",
"postalCode": 75000,
"country": "FR"
},
"type": "object",
"properties": {
"street": {
"type": "string",
"maxLength": 70
},
"buildingNumber": {
"type": "string"
},
"city": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"country": {
"description": "ISO 3166 ALPHA2 country code",
"example": "SE",
"type": "string",
"pattern": "[A-Z]{2}"
}
},
"required": [
"country"
]
}
Object describing an amount as a combination of its value and currency code
{
"example": {
"currency": "EUR",
"amount": 123
},
"type": "object",
"properties": {
"currency": {
"description": "ISO 4217 Alpha 3 currency code",
"example": "EUR",
"type": "string",
"pattern": "[A-Z]{3}"
},
"amount": {
"description": "The amount given with fractional digits, where fractions must be compliant to the currency definition.\nUp to 14 significant figures. Negative amounts are signed by minus.\nThe decimal separator is a dot.\n\n**Example:**\nValid representations for EUR with up to two decimals are:\n\n * 1056\n * 5768.2\n * -1.50\n * 5877.78",
"example": 5877.78,
"type": "string",
"pattern": "-?[0-9]{1,14}(\\.[0-9]{1,3})?"
}
},
"required": [
"currency",
"amount"
]
}
Charge Bearer. ChargeBearerType1Code from ISO20022
{
"example": "DEBT",
"type": "string",
"enum": [
"DEBT",
"CRED",
"SHAR",
"SLEV"
]
}
ExternalPurpose1Code from ISO 20022. Values from ISO 20022 External Code List ExternalCodeSets_1Q2018 June 2018.
{
"example": "BKDF",
"type": "string",
"enum": [
"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"
]
}
Content of the body of a consent request.
{
"type": "object",
"properties": {
"access": {
"$ref": "#\/definitions\/accountAccess"
},
"recurringIndicator": {
"description": "\"true\", if the consent is for recurring access to the account data.\n\n\"false\", if the consent is for one access to the account data.",
"example": false,
"type": "boolean"
},
"validUntil": {
"description": "This parameter is requesting a valid until date for the requested consent.\nThe content is the local ASPSP date in ISO-Date Format, e.g. 2017-10-30.\n\nFuture dates might get adjusted by ASPSP.\n\nIf a maximal available date is requested, a date in far future is to be used: \"9999-12-31\".\n\nIn both cases the consent object to be retrieved by the GET Consent Request will contain the adjusted date.",
"example": "2020-12-31T00:00:00.000Z",
"type": "string",
"format": "date"
},
"frequencyPerDay": {
"description": "This field indicates the requested maximum frequency for an access without PSU involvement per day.\nFor a one-off access, this attribute is set to \"1\".\n\nThe frequency needs to be greater equal to one.",
"example": 4,
"type": "integer",
"minimum": 1,
"format": "int32"
},
"combinedServiceIndicator": {
"description": "If \"true\" indicates that a payment initiation service will be addressed in the same \"session\".",
"example": false,
"type": "boolean"
}
},
"required": [
"access",
"recurringIndicator",
"validUntil",
"frequencyPerDay",
"combinedServiceIndicator"
]
}
Content of the body of a Transaction Authorisation Request
{
"type": "object",
"properties": {
"scaAuthenticationData": {
"description": "SCA authentication data, depending on the chosen authentication method.\nIf the data is binary, then it is base64 encoded.",
"type": "string"
}
},
"required": [
"scaAuthenticationData"
]
}
Body of the JSON response with SCA Status
{
"example": {
"description": "Response of an Update PSU Identification for a payment initiation request for the decoupled approach.",
"value": {
"scatransactionStatus": "psuIdentified",
"psuMessage": "Please use your BankApp for transaction Authorisation.",
"_links": {
"scaStatus": {
"href": "\/payments\/qwer3456tzui7890\/authorisations\/123auth456"
}
}
}
},
"type": "object",
"properties": {
"scaStatus": {
"$ref": "#\/definitions\/scaStatus"
}
}
}
Body of the JSON response for a Start SCA authorisation request.
{
"type": "object",
"properties": {
"scaStatus": {
"$ref": "#\/definitions\/scaStatus"
},
"authorisationId": {
"description": "Resource identification of the related SCA",
"example": "123auth456",
"type": "string"
},
"scaMethods": {
"description": "This data element might be contained, if SCA is required and if the PSU has a choice between different\nauthentication methods.\n\nDepending on the risk management of the ASPSP this choice might be offered before or after the PSU\nhas been identified with the first relevant factor, or if an access token is transported.\n\nIf this data element is contained, then there is also an hyperlink of type 'startAuthorisationWithAuthenticationMethodSelection'\ncontained in the response body.\n\nThese methods shall be presented towards the PSU for selection by the TPP.",
"type": "array",
"items": {
"$ref": "#\/definitions\/authenticationObject"
}
},
"chosenScaMethod": {
"$ref": "#\/definitions\/authenticationObject"
},
"challengeData": {
"$ref": "#\/definitions\/challengeData"
},
"_links": {
"$ref": "#\/definitions\/_linksStartScaProcess"
},
"psuMessage": {
"description": "Text to be displayed to the PSU",
"type": "string",
"maxLength": 512
}
},
"required": [
"scaStatus",
"authorisationId",
"_links"
]
}
Body of the JSON response for a successful select PSU Authentication Method request.
{
"type": "object",
"properties": {
"chosenScaMethod": {
"$ref": "#\/definitions\/authenticationObject"
},
"challengeData": {
"$ref": "#\/definitions\/challengeData"
},
"_links": {
"$ref": "#\/definitions\/_linksSelectPsuAuthenticationMethod"
},
"scaStatus": {
"$ref": "#\/definitions\/scaStatus"
},
"psuMessage": {
"description": "Text to be displayed to the PSU",
"type": "string",
"maxLength": 512
}
},
"required": [
"scaStatus"
]
}
Body of the JSON response for a successful conset request.
{
"type": "object",
"properties": {
"consentStatus": {
"$ref": "#\/definitions\/consentStatus"
},
"consentId": {
"description": "ID of the corresponding consent object as returned by an Account Information Consent Request.",
"type": "string"
},
"scaMethods": {
"description": "This data element might be contained, if SCA is required and if the PSU has a choice between different\nauthentication methods.\n\nDepending on the risk management of the ASPSP this choice might be offered before or after the PSU\nhas been identified with the first relevant factor, or if an access token is transported.\n\nIf this data element is contained, then there is also an hyperlink of type 'startAuthorisationWithAuthenticationMethodSelection'\ncontained in the response body.\n\nThese methods shall be presented towards the PSU for selection by the TPP.",
"type": "array",
"items": {
"$ref": "#\/definitions\/authenticationObject"
}
},
"chosenScaMethod": {
"$ref": "#\/definitions\/authenticationObject"
},
"challengeData": {
"$ref": "#\/definitions\/challengeData"
},
"_links": {
"$ref": "#\/definitions\/_linksConsents"
},
"message": {
"description": "Text to be displayed to the PSU, e.g. in a Decoupled SCA Approach.",
"type": "string",
"maxLength": 512
}
},
"required": [
"consentStatus",
"consentId",
"_links"
]
}
Body of the JSON response for a successful get status request for a consent.
{
"type": "object",
"properties": {
"consentStatus": {
"$ref": "#\/definitions\/consentStatus"
}
},
"required": [
"consentStatus"
]
}
Body of the JSON response for a successfull get consent request.
{
"type": "object",
"properties": {
"access": {
"$ref": "#\/definitions\/accountAccess"
},
"recurringIndicator": {
"description": "\"true\", if the consent is for recurring access to the account data.\n\n\"false\", if the consent is for one access to the account data.",
"example": false,
"type": "boolean"
},
"validUntil": {
"description": "This parameter is requesting a valid until date for the requested consent.\nThe content is the local ASPSP date in ISO-Date Format, e.g. 2017-10-30.\n\nFuture dates might get adjusted by ASPSP.\n\nIf a maximal available date is requested, a date in far future is to be used: \"9999-12-31\".\n\nIn both cases the consent object to be retrieved by the GET Consent Request will contain the adjusted date.",
"example": "2020-12-31T00:00:00.000Z",
"type": "string",
"format": "date"
},
"frequencyPerDay": {
"description": "This field indicates the requested maximum frequency for an access without PSU involvement per day.\nFor a one-off access, this attribute is set to \"1\".\n\nThe frequency needs to be greater equal to one.",
"example": 4,
"type": "integer",
"minimum": 1,
"format": "int32"
},
"lastActionDate": {
"description": "This date is containing the date of the last action on the consent object either through\nthe XS2A interface or the PSU\/ASPSP interface having an impact on the status.",
"example": "2018-07-01T00:00:00.000Z",
"type": "string",
"format": "date"
},
"consentStatus": {
"$ref": "#\/definitions\/consentStatus"
}
},
"required": [
"access",
"recurringIndicator",
"validUntil",
"frequencyPerDay",
"lastActionDate",
"consentStatus"
]
}
Body of the response for a successful read balance for an account request.
{
"type": "object",
"properties": {
"account": {
"$ref": "#\/definitions\/accountReference"
},
"balances": {
"description": "A list of balances regarding this account, e.g. the current balance, the last booked balance.The list might be restricted to the current balance.",
"type": "array",
"items": {
"$ref": "#\/definitions\/balance"
}
}
},
"required": [
"balances"
]
}
Body of the response for a successful read balance for a card account request.
{
"type": "object",
"properties": {
"cardAccount": {
"$ref": "#\/definitions\/accountReference"
},
"balances": {
"description": "A list of balances regarding this account, e.g. the current balance, the last booked balance.\nThe list migght be restricted to the current ballance.",
"type": "array",
"items": {
"$ref": "#\/definitions\/balance"
}
}
},
"required": [
"balances"
]
}
Body of the JSON response for a successful read transaction list request. This account report contains transactions resulting from the query parameters.
{
"example": {
"description": "Response in JSON format for an access on a regular account",
"value": {
"account": {
"iban": "DE2310010010123456788"
},
"transactions": {
"booked": [
{
"transactionId": 1234567,
"creditorName": "John Miles",
"creditorAccount": {
"iban": "DE67100100101306118605"
},
"transactionAmount": {
"currency": "EUR",
"amount": 256.67
},
"bookingDate": "2017-10-25T00:00:00.000Z",
"valueDate": "2017-10-26T00:00:00.000Z",
"remittanceInformationUnstructured": "Example 1"
},
{
"transactionId": 1234568,
"debtorName": "Paul Simpson",
"debtorAccount": {
"iban": "NL76RABO0359400371"
},
"transactionAmount": {
"currency": "EUR",
"amount": 343.01
},
"bookingDate": "2017-10-25T00:00:00.000Z",
"valueDate": "2017-10-26T00:00:00.000Z",
"remittanceInformationUnstructured": "Example 2"
}
],
"pending": [
{
"transactionId": 1234569,
"creditorName": "Claude Renault",
"creditorAccount": {
"iban": "FR7612345987650123456789014"
},
"transactionAmount": {
"currency": "EUR",
"amount": -100.03
},
"valueDate": "2017-10-26T00:00:00.000Z",
"remittanceInformationUnstructured": "Example 3"
}
],
"_links": {
"account": {
"href": "\/accounts\/3dc3d5b3-7023-4848-9853-f5400a64e80f"
}
}
}
}
},
"type": "object",
"properties": {
"account": {
"$ref": "#\/definitions\/accountReference"
},
"transactions": {
"$ref": "#\/definitions\/accountReport"
},
"balances": {
"description": "A list of balances regarding this account, e.g. the current balance, the last booked balance.\nThe list migght be restricted to the current ballance.",
"type": "array",
"items": {
"$ref": "#\/definitions\/balance"
}
},
"_links": {
"$ref": "#\/definitions\/_linksDownload_AccountTransactions"
}
}
}
Body of the JSON response for a successful read card account transaction list request. This card account report contains transactions resulting from the query parameters.
{
"type": "object",
"properties": {
"cardAccount": {
"$ref": "#\/definitions\/accountReference"
},
"cardTransactions": {
"$ref": "#\/definitions\/cardAccountReport"
},
"balances": {
"description": "A list of balances regarding this account, e.g. the current balance, the last booked balance.\nThe list migght be restricted to the current ballance.",
"type": "array",
"items": {
"$ref": "#\/definitions\/balance"
}
},
"_links": {
"$ref": "#\/definitions\/_linksDownload_AccountTransactions"
}
}
}
A _link object with all available link types
{
"type": "object",
"properties": {
"scaRedirect": {
"$ref": "#\/definitions\/hrefType"
},
"scaOAuth": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisation": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithPsuIdentification": {
"$ref": "#\/definitions\/hrefType"
},
"updatePsuIdentification": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithProprietaryData": {
"$ref": "#\/definitions\/hrefType"
},
"updateProprietaryData": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithPsuAuthentication": {
"$ref": "#\/definitions\/hrefType"
},
"updatePsuAuthentication": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithEncryptedPsuAuthentication": {
"$ref": "#\/definitions\/hrefType"
},
"updateEncryptedPsuAuthentication": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithAuthenticationMethodSelection": {
"$ref": "#\/definitions\/hrefType"
},
"selectAuthenticationMethod": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithTransactionAuthorisation": {
"$ref": "#\/definitions\/hrefType"
},
"authoriseTransaction": {
"$ref": "#\/definitions\/hrefType"
},
"self": {
"$ref": "#\/definitions\/hrefType"
},
"status": {
"$ref": "#\/definitions\/hrefType"
},
"scaStatus": {
"$ref": "#\/definitions\/hrefType"
},
"account": {
"$ref": "#\/definitions\/hrefType"
},
"balances": {
"$ref": "#\/definitions\/hrefType"
},
"transactions": {
"$ref": "#\/definitions\/hrefType"
},
"transactionDetails": {
"$ref": "#\/definitions\/hrefType"
},
"cardAccount": {
"$ref": "#\/definitions\/hrefType"
},
"cardTransactions": {
"$ref": "#\/definitions\/hrefType"
},
"first": {
"$ref": "#\/definitions\/hrefType"
},
"next": {
"$ref": "#\/definitions\/hrefType"
},
"previous": {
"$ref": "#\/definitions\/hrefType"
},
"last": {
"$ref": "#\/definitions\/hrefType"
},
"download": {
"$ref": "#\/definitions\/hrefType"
}
}
}
A list of hyperlinks to be recognised by the TPP. The actual hyperlinks used in the response depend on the dynamical decisions of the ASPSP when processing the request.
Remark: All links can be relative or full links, to be decided by the ASPSP.
Remark: This method can be applied before or after PSU identification. This leads to many possible hyperlink responses. Type of links admitted in this response, (further links might be added for ASPSP defined extensions):
- "scaRedirect": In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
- "scaOAuth": In case of a SCA OAuth2 Approach, the ASPSP is transmitting the URI where the configuration of the Authorisation Server can be retrieved. The configuration follows the OAuth 2.0 Authorisation Server Metadata specification.
- "updatePsuIdentification": The link to the authorisation or cancellation authorisation sub-resource, where PSU identification data needs to be uploaded.
- "updatePsuAuthentication": The link to the authorisation or cancellation authorisation sub-resource, where PSU authentication data needs to be uploaded. "authoriseTransaction": The link to the authorisation or cancellation authorisation sub-resource, where the authorisation data has to be uploaded, e.g. the TOP received by SMS. "scaStatus": The link to retrieve the scaStatus of the corresponding authorisation sub-resource.
{
"type": "object",
"properties": {
"scaRedirect": {
"$ref": "#\/definitions\/hrefType"
},
"scaOAuth": {
"$ref": "#\/definitions\/hrefType"
},
"updatePsuIdentification": {
"$ref": "#\/definitions\/hrefType"
},
"updatePsuAuthentication": {
"$ref": "#\/definitions\/hrefType"
},
"authoriseTransaction": {
"$ref": "#\/definitions\/hrefType"
},
"scaStatus": {
"$ref": "#\/definitions\/hrefType"
}
}
}
A _link object with available link types for starting the SCA process
{
"type": "object",
"properties": {
"scaRedirect": {
"$ref": "#\/definitions\/hrefType"
},
"scaOAuth": {
"$ref": "#\/definitions\/hrefType"
},
"updatePsuIdentification": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithPsuAuthentication": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithEncryptedPsuAuthentication": {
"$ref": "#\/definitions\/hrefType"
},
"selectAuthenticationMethod": {
"$ref": "#\/definitions\/hrefType"
},
"authoriseTransaction": {
"$ref": "#\/definitions\/hrefType"
},
"scaStatus": {
"$ref": "#\/definitions\/hrefType"
}
}
}
A _link object with available link types for resource download
{
"type": "object",
"properties": {
"download": {
"$ref": "#\/definitions\/hrefType"
}
},
"required": [
"download"
],
"additionalProperties": true
}
A _link object with available link types for resource download when getting account transactions
{
"type": "object",
"properties": {
"download": {
"$ref": "#\/definitions\/hrefType"
},
"next": {
"$ref": "#\/definitions\/hrefType"
}
},
"required": [
"next"
],
"additionalProperties": false
}
A _link object with available consent-related link types
{
"type": "object",
"properties": {
"scaRedirect": {
"$ref": "#\/definitions\/hrefType"
},
"scaOAuth": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisation": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithPsuIdentification": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithPsuAuthentication": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithEncryptedPsuAuthentication": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithAuthenticationMethodSelection": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithTransactionAuthorisation": {
"$ref": "#\/definitions\/hrefType"
},
"self": {
"$ref": "#\/definitions\/hrefType"
},
"status": {
"$ref": "#\/definitions\/hrefType"
},
"scaStatus": {
"$ref": "#\/definitions\/hrefType"
}
}
}
A _link object managing the navigation across the elements of an account report
{
"type": "object",
"properties": {
"account": {
"$ref": "#\/definitions\/hrefType"
},
"first": {
"$ref": "#\/definitions\/hrefType"
},
"next": {
"$ref": "#\/definitions\/hrefType"
},
"previous": {
"$ref": "#\/definitions\/hrefType"
},
"last": {
"$ref": "#\/definitions\/hrefType"
}
},
"required": [
"account"
]
}
{
"type": "object",
"properties": {
"cardAccount": {
"$ref": "#\/definitions\/hrefType"
},
"first": {
"$ref": "#\/definitions\/hrefType"
},
"next": {
"$ref": "#\/definitions\/hrefType"
},
"previous": {
"$ref": "#\/definitions\/hrefType"
},
"last": {
"$ref": "#\/definitions\/hrefType"
}
},
"required": [
"cardAccount"
]
}
A _link object with available link types for getting transaction details
{
"type": "object",
"properties": {
"transactionDetails": {
"$ref": "#\/definitions\/hrefType"
}
},
"required": [
"transactionDetails"
]
}
Links to the account, which can be directly used for retrieving account information from this dedicated account. Links to "balances" and/or "transactions". These links are only supported, when the corresponding consent has been already granted.
{
"type": "object",
"properties": {
"balances": {
"$ref": "#\/definitions\/hrefType"
},
"transactions": {
"$ref": "#\/definitions\/hrefType"
}
}
}
Category of the TPP message
{
"example": "ERROR",
"type": "string",
"enum": [
"ERROR",
"WARNING"
]
}
Message codes for HTTP Error codes 2XX.
{
"example": "WARNING",
"type": "string",
"enum": [
"WARNING"
]
}
Message codes defined for AIS for HTTP Error code 400 (BAD_REQUEST).
{
"example": "FORMAT_ERROR",
"type": "string",
"enum": [
"FORMAT_ERROR",
"PARAMETER_NOT_CONSISTENT",
"PARAMETER_NOT_SUPPORTED",
"SERVICE_INVALID",
"RESOURCE_UNKNOWN",
"RESOURCE_EXPIRED",
"RESOURCE_BLOCKED",
"TIMESTAMP_INVALID",
"PERIOD_INVALID",
"SCA_METHOD_UNKNOWN",
"CONSENT_UNKNOWN",
"SESSIONS_NOT_SUPPORTED"
]
}
Message codes defined for AIS for HTTP Error code 401 (UNAUTHORIZED).
{
"example": "CERTIFICATE_INVALID",
"type": "string",
"enum": [
"CERTIFICATE_INVALID",
"CERTIFICATE_EXPIRED",
"CERTIFICATE_BLOCKED",
"CERTIFICATE_REVOKE",
"CERTIFICATE_MISSING",
"SIGNATURE_INVALID",
"SIGNATURE_MISSING",
"CORPORATE_ID_INVALID",
"PSU_CREDENTIALS_INVALID",
"CONSENT_INVALID",
"CONSENT_EXPIRED",
"TOKEN_UNKNOWN",
"TOKEN_INVALID",
"TOKEN_EXPIRED"
]
}
Message codes defined for AIS for HTTP Error code 403 (FORBIDDEN).
{
"example": "CONSENT_UNKNOWN",
"type": "string",
"enum": [
"CONSENT_UNKNOWN",
"SERVICE_BLOCKED",
"RESOURCE_UNKNOWN",
"RESOURCE_EXPIRED"
]
}
Message codes defined for AIS for HTTP Error code 404 (NOT FOUND).
{
"example": "RESOURCE_UNKNOWN",
"type": "string",
"enum": [
"RESOURCE_UNKNOWN"
]
}
Message codes defined for AIS for HTTP Error code 405 (METHOD NOT ALLOWED).
{
"example": "SERVICE_INVALID",
"type": "string",
"enum": [
"SERVICE_INVALID"
]
}
Message codes defined for AIS for HTTP Error code 406 (NOT ACCEPTABLE).
{
"example": "REQUESTED_FORMATS_INVALID",
"type": "string",
"enum": [
"REQUESTED_FORMATS_INVALID"
]
}
Message codes defined for AIS for HTTP Error code 408 (REQUEST TIMEOUT).
{
"example": "REQUEST_TIMEOUT",
"type": "string",
"enum": [
"REQUEST_TIMEOUT"
]
}
Message codes defined for AIS for HTTP Error code 409 (CONFLICT).
{
"example": "STATUS_INVALID",
"type": "string",
"enum": [
"STATUS_INVALID"
]
}
Message codes defined for AIS for HTTP Error code 415 (UNSUPPORTED MEDIA TYPE).
{
"example": "UNSUPPORTED_MEDIA_TYPE",
"type": "string",
"enum": [
"UNSUPPORTED_MEDIA_TYPE"
]
}
Message codes for HTTP Error code 429 (TOO MANY REQUESTS).
{
"example": "ACCESS_EXCEEDED",
"type": "string",
"enum": [
"ACCESS_EXCEEDED"
]
}
Message codes for HTTP Error code 503 (SERVICE UNAVAILABLE).
{
"example": "SERVICE_UNAVAILABLE",
"type": "string",
"enum": [
"SERVICE_UNAVAILABLE"
]
}
{
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"description": "Message codes for HTTP Error codes 2XX.",
"example": "WARNING",
"type": "string",
"default": "WARNING"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"$ref": "#\/definitions\/MessageCode400_AIS"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"$ref": "#\/definitions\/MessageCode401_AIS"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"$ref": "#\/definitions\/MessageCode403_AIS"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"description": "Message codes defined for AIS for HTTP Error code 404 (NOT FOUND).",
"example": "RESOURCE_UNKNOWN",
"type": "string",
"default": "RESOURCE_UNKNOWN"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"description": "Message codes defined for AIS for HTTP Error code 405 (METHOD NOT ALLOWED).",
"example": "SERVICE_INVALID",
"type": "string",
"default": "SERVICE_INVALID"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"description": "Message codes defined for AIS for HTTP Error code 406 (NOT ACCEPTABLE).",
"example": "REQUESTED_FORMATS_INVALID",
"type": "string",
"default": "REQUESTED_FORMATS_INVALID"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"$ref": "#\/definitions\/MessageCode408_AIS"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"description": "Message codes defined for AIS for HTTP Error code 409 (CONFLICT).",
"example": "STATUS_INVALID",
"type": "string",
"default": "STATUS_INVALID"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"$ref": "#\/definitions\/MessageCode415_AIS"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"description": "Message codes for HTTP Error code 429 (TOO MANY REQUESTS).",
"example": "ACCESS_EXCEEDED",
"type": "string",
"default": "ACCESS_EXCEEDED"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"$ref": "#\/definitions\/MessageCode503_AIS"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 400 for AIS.
{
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type.\nRemark For Future: These URI will be provided by NextGenPSD2 in future.",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error.\nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode400_AIS"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError1"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 401 for AIS.
{
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type.\nRemark For Future: These URI will be provided by NextGenPSD2 in future.",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error.\nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode401_AIS"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError5"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 403 for AIS.
{
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type.\nRemark For Future: These URI will be provided by NextGenPSD2 in future.",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error.\nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode403_AIS"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError9"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 404 for AIS.
{
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type.\nRemark For Future: These URI will be provided by NextGenPSD2 in future.",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error.\nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for AIS for HTTP Error code 404 (NOT FOUND).",
"example": "RESOURCE_UNKNOWN",
"type": "string",
"default": "RESOURCE_UNKNOWN"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError13"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 405 for AIS.
{
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type.\nRemark For Future: These URI will be provided by NextGenPSD2 in future.",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error.\nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for AIS for HTTP Error code 405 (METHOD NOT ALLOWED).",
"example": "SERVICE_INVALID",
"type": "string",
"default": "SERVICE_INVALID"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError18"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 406 for AIS.
{
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type.\nRemark For Future: These URI will be provided by NextGenPSD2 in future.",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error.\nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for AIS for HTTP Error code 406 (NOT ACCEPTABLE).",
"example": "REQUESTED_FORMATS_INVALID",
"type": "string",
"default": "REQUESTED_FORMATS_INVALID"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError21"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 409 for AIS.
{
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type.\nRemark For Future: These URI will be provided by NextGenPSD2 in future.",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error.\nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for AIS for HTTP Error code 409 (CONFLICT).",
"example": "STATUS_INVALID",
"type": "string",
"default": "STATUS_INVALID"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError23"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 429 for AIS.
{
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type.\nRemark For Future: These URI will be provided by NextGenPSD2 in future.",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error.\nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes for HTTP Error code 429 (TOO MANY REQUESTS).",
"example": "ACCESS_EXCEEDED",
"type": "string",
"default": "ACCESS_EXCEEDED"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError26"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
},
"required": [
"type",
"code"
]
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 400.
{
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage400_AIS"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401.
{
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage401_AIS"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 403.
{
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage403_AIS"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 404.
{
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage404_AIS"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401.
{
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage405_AIS"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 406.
{
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage406_AIS"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 408.
{
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage408_AIS"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 409.
{
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage409_AIS"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 415.
{
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage415_AIS"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 429.
{
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage429_AIS"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 503.
{
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage503_AIS"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
}
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error.\nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode400_AIS"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error.\nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode401_AIS"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error.\nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode403_AIS"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error.\nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for AIS for HTTP Error code 404 (NOT FOUND).",
"example": "RESOURCE_UNKNOWN",
"type": "string",
"default": "RESOURCE_UNKNOWN"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error.\nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for AIS for HTTP Error code 405 (METHOD NOT ALLOWED).",
"example": "SERVICE_INVALID",
"type": "string",
"default": "SERVICE_INVALID"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error.\nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for AIS for HTTP Error code 406 (NOT ACCEPTABLE).",
"example": "REQUESTED_FORMATS_INVALID",
"type": "string",
"default": "REQUESTED_FORMATS_INVALID"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error.\nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for AIS for HTTP Error code 409 (CONFLICT).",
"example": "STATUS_INVALID",
"type": "string",
"default": "STATUS_INVALID"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807] in case of a HTTP error code 429 for.
{
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error.\nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes for HTTP Error code 429 (TOO MANY REQUESTS).",
"example": "ACCESS_EXCEEDED",
"default": "ACCESS_EXCEEDED",
"$ref": "#\/definitions\/MessageCode429_AIS"
}
},
"required": [
"code"
]
}
Optional if supported by API provider. Only the value "allAccounts" is accepted.
{
"example": "allAccounts",
"type": "string",
"enum": [
"allAccounts"
]
}
Optional if supported by API provider. Only the values "allAccounts" or "allAccountsWithBalances" is accepted.
{
"example": "allAccounts",
"type": "string",
"enum": [
"allAccounts",
"allAccountsWithBalances"
]
}
Booking status. Valid values:
- 'booked'
- 'pending'
- 'both'
{
"example": "booked",
"type": "string",
"enum": [
"booked",
"pending",
"both"
]
}
The format type of the OTP to be typed in. The admitted values are "characters" or "integer".
{
"example": "characters",
"type": "string",
"enum": [
"characters",
"integer"
]
}
Specifies the usage of the account. Valid values:
- 'PRIV': private personal account
- 'ORGA': professional account
{
"example": "PRIV",
"type": "string",
"enum": [
"PRIV",
"ORGA"
]
}
Content of the body of a Select PSU Authentication Method Request
{
"type": "object",
"properties": {
"authenticationMethodId": {
"description": "An identification provided by the ASPSP for the later identification of the authentication method selection.",
"example": "myAuthenticationID",
"type": "string",
"maxLength": 35
}
},
"required": [
"authenticationMethodId"
]
}