Premium Accounts API V3

/v1/consents

Show/Hide
List Operations
Expand Operations

This method create a consent resource, defining access rights to dedicated accounts of a given PSU-ID. **Side Effects** if it exists already a former consent for recurring access on account information for the addressed PSU, then the former consent automatically expires as soon as the new consent request is authorised by the PSU. In case of TPP creating resource consent for user is mandatory, otherwise for FAC the resource is created implicitly.

Parameters

Parameter	Value	Description
PSU-ID		PSU-ID Client ID of the PSU in the ASPSP client interface.
PSU-Corporate-ID		PSU-Corporate-ID Might be mandated in the ASPSP's documentation. Only used in a corporate context.
PSU-Corporate-ID-Type		PSU-Corporate-ID-Type Might be mandated in the ASPSP's documentation. Only used in a corporate context.
X-Request-ID		X-Request-ID ID of the request, unique to the call, as determined by the initiating party.
PSU-IP-Address		PSU-IP-Address 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.
PSU-Application		PSU-Application The Application name, if available.

Response Messages

HTTP Status Code	Reason	Response Model
201	Created
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not found
405	Method Not Allowed
406	Not Acceptable
408	Request Timeout
409	Conflict
415	Unsupported Media Type
429	Too Many Requests
500	Internal Server Error
503	Service Unavailable

GET /v1/consents/{consentId}

getConsentInformation

Implementation Notes

Returns the content of an account information consent object.

Parameters

Parameter	Value	Description
consentId		consentId ID of the corresponding consent object as returned by an account information consent request.
X-Request-ID		X-Request-ID ID of the request, unique to the call, as determined by the initiating party.
PSU-IP-Address		PSU-IP-Address 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.
PSU-Application		PSU-Application The Application name, if available.

Response Messages

HTTP Status Code	Reason	Response Model
200	OK
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not found
405	Method Not Allowed
406	Not Acceptable
408	Request Timeout
409	Conflict
415	Unsupported Media Type
429	Too Many Requests
500	Internal Server Error
503	Service Unavailable

DELETE /v1/consents/{consentId}

deleteConsent

Implementation Notes

The TPP can delete an account information consent object if needed.

Parameters

Parameter	Value	Description
consentId		consentId ID of the corresponding consent object as returned by an account information consent request.
X-Request-ID		X-Request-ID ID of the request, unique to the call, as determined by the initiating party.
PSU-IP-Address		PSU-IP-Address 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.
PSU-Application		PSU-Application The Application name, if available.

Response Messages

HTTP Status Code	Reason	Response Model
204	No Content
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not found
405	Method Not Allowed
406	Not Acceptable
408	Request Timeout
409	Conflict
415	Unsupported Media Type
429	Too Many Requests
500	Internal Server Error
503	Service Unavailable

GET /v3/accounts

getAccountList

Implementation Notes

Read the identifiers of the available payment account together with booking balance information, depending on the consent granted. It is assumed that a consent of the PSU to this access is already given and stored on the ASPSP system. The addressed list of accounts depends then on OAuth2 access token.

Parameters

Parameter	Value	Description
withBalance		withBalance 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.
X-Request-ID		X-Request-ID ID of the request, unique to the call, as determined by the initiating party.
PSU-IP-Address		PSU-IP-Address 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.
PSU-Application		PSU-Application The Application name, if available.

Response Messages

HTTP Status Code	Reason	Response Model
200	OK
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not found
405	Method Not Allowed
406	Not Acceptable
408	Request Timeout
409	Conflict
415	Unsupported Media Type
429	Too Many Requests
500	Internal Server Error
503	Service Unavailable

GET /v3/accounts/{account-id}

readAccountDetails

Implementation Notes

Reads details about an account, with balances where required. The addressed details of this account depends then on the OAuth2 access token. **NOTE:** The account-id can represent a multicurrency account. In this case the currency code is set to "XXX". Give detailed information about the addressed account. Give detailed information about the addressed account together with balance information

Parameters

Parameter	Value	Description
account-id		account-id 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.
withBalance		withBalance 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.
X-Request-ID		X-Request-ID ID of the request, unique to the call, as determined by the initiating party.
PSU-IP-Address		PSU-IP-Address 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.
PSU-Application		PSU-Application The Application name, if available.

Response Messages

HTTP Status Code	Reason	Response Model
200	OK
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not found
405	Method Not Allowed
406	Not Acceptable
408	Request Timeout
409	Conflict
415	Unsupported Media Type
429	Too Many Requests
500	Internal Server Error
503	Service Unavailable

GET /v3/accounts/{account-id}/transactions

getTransactionList

Implementation Notes

Read transaction reports or transaction lists of a given account ddressed by "account-id", depending on the steering parameter "bookingStatus" together with balances. For a given account, additional parameters are e.g. the attributes "dateFrom" and "dateTo". The ASPSP might add balance information, if transaction lists without balances are not supported. Only booked transaction are available

Parameters

Parameter	Value	Description
account-id		account-id 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.
dateFrom		dateFrom Conditional: Starting date (inclusive the date dateFrom) of the transaction list, mandated if no delta access is required and if bookingStatus does not equal "information. 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.
dateTo		dateTo 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.
variableSymbol		variableSymbol Variable symbol filter. It is available only for TB accounts
constantSymbol		constantSymbol Constant symbol filter. It is available only for TB accounts
specificSymbol		specificSymbol Specific symbol filter. It is available only for TB accounts
e2ereference		e2ereference EndToEnd reference filter. It is available only for TB accounts
amountFrom		amountFrom return transaction with amount bigger than amountFrom. It is available only for TB accounts
amountTo		amountTo return transaction with amount lower than amountTo. It is available only for TB accounts
bookingStatus		*bookingStatus "booked", * "pending", and * "both"**
transactionDirection		transactionDirection CRDT,DBT. It is available only for TB accounts
transactionIdFrom		transactionIdFrom This data attribute is indicating that the AISP is in favour to get all transactions after the transaction with identification transactionId alternatively to the above defined period. This is a implementation of a delta access. This attribute's value will be provided in "next" link as a part of response of GET/ transaction method. Do not custom this value
transactionDateFrom		transactionDateFrom This data attribute is indicating that the AISP is in favour to get all transactions after the transaction with identification transactionId 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 This attribute's value will be provided in "next" link as a part of response of GET/ transaction method. Do not custom this value
transactionCompleteFlag		transactionCompleteFlag ONLY for TB accounts. This flag attribute indicates that requestor require 'transactionComplete' flag in response. If 'transactionCompleteFlag' is set to true 'transactionComplete' attribute will be present in response. If 'transactionComplete' attribute in response is false that means these attributes value's: * "DebtorName", * "DebtorAgent", * "CreditorName" * "CreditorAgent" * "ExchangeRate" * "TradingPartyIdentification" * "TradingPartyName" * "TradingPartyMerchantCode" could be empty and transaction could be incomplete. In other case, if 'transactionComplete' is true and it is not card transaction, its quarantee that transaction detail is complete.
page		page The page number. This attribute's value will be provided in "next" link as a part of response of GET/ transaction method. Do not custom this value. Its avalable only for non TB accounts
pageSize		pageSize Size of returned list of transactions
X-Request-ID		X-Request-ID ID of the request, unique to the call, as determined by the initiating party.
PSU-IP-Address		PSU-IP-Address 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.
PSU-Application		PSU-Application The Application name, if available.

Response Messages

HTTP Status Code	Reason	Response Model
200	OK
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not found
405	Method Not Allowed
406	Not Acceptable
408	Request Timeout
409	Conflict
415	Unsupported Media Type
429	Too Many Requests
500	Internal Server Error
503	Service Unavailable

/v2/refresh

Show/Hide
List Operations
Expand Operations

PUT /v2/refresh

refresh

Implementation Notes

This method initializes refresh accounts and transactions in case of accounts from anthother banks are added/authorized. This method return TaskId - identifier of asynch job. After refreshing data webhook will be sent to registered wehbhookURL.

Parameters

Parameter	Value	Description
PSU-ID		PSU-ID Client ID of the PSU in the ASPSP client interface.
PSU-Corporate-ID		PSU-Corporate-ID Might be mandated in the ASPSP's documentation. Only used in a corporate context.
PSU-Corporate-ID-Type		PSU-Corporate-ID-Type Might be mandated in the ASPSP's documentation. Only used in a corporate context.
X-Request-ID		X-Request-ID ID of the request, unique to the call, as determined by the initiating party.
PSU-IP-Address		PSU-IP-Address 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.
PSU-Application		PSU-Application The Application name, if available.

Response Messages

HTTP Status Code	Reason	Response Model
201	OK. Data refresh initialized.
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not found
405	Method Not Allowed
406	Not Acceptable
408	Request Timeout
409	Conflict
415	Unsupported Media Type
429	Too Many Requests
500	Internal Server Error
503	Service Unavailable

Tatra banka a.s.Developer Portal

Premium Accounts API V3

/v1/consents

POST /v1/consents

Implementation Notes

Parameters

Response Messages

GET /v1/consents/{consentId}

Implementation Notes

Parameters

Response Messages

DELETE /v1/consents/{consentId}

Implementation Notes

Parameters

Response Messages

/v3/accounts

GET /v3/accounts

Implementation Notes

Parameters

Response Messages

GET /v3/accounts/{account-id}

Implementation Notes

Parameters

Response Messages

GET /v3/accounts/{account-id}/transactions

Implementation Notes

Parameters

Response Messages

/v2/refresh

PUT /v2/refresh

Implementation Notes

Parameters

Response Messages

Tatra banka APIs

Raiffeisen bank APIs

Other Links

Contacts