Accounts

Accounts Service Description

Get information about bank accounts.

API Profile

Attribute

Value

Name Accounts
Version V1
Synopsis Accounts
Description Gets customer bank account information.
Pre-Conditions HTTP GET method is allowed.
Authentication OAuth 2.0 with Authorization Code

Before your application can access the API, it must obtain a new an access token for each request. The access token can be used only one time.

Endpoint Definition

Account API’s development live and mock environments routing data

EndPoint SERVICE

URI /accounts/v1
Base URL https://apis.garantibbva.ro:443


Technology

Technology Stack / DESIGN TIME

Property Value
HTTP Call Method GET
Response Content Type application/json; charset=utf-8


APIS


Reads a list of bank accounts, with balances where required.


Query Parameters

Attribute

Type

Condition

Description

withBalance Boolean Optional 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.

Request Header

Attribute

Type

Condition

Description

X-Request-ID UUID Mandatory ID of the request, unique to the call, as determined by the initiating party.
Consent-ID String Mandatory Shall be contained since "Establish Consent Transaction" was performed via this API before.
Authorization String Conditional Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.
Client-ID String Mandatory TPP's Client ID, returned from Dynamic Registration.
Client-Secret String Mandatory TPP's Client Secret, returned from Dynamic Registration.
apikey String Mandatory API Key value obtained from Dashboard/Applications page in API Store, for SANDBOX/PRODUCTION plan.

Response Header

Attribute

Type

Condition

Description

X-Request-ID UUID Mandatory ID of the request, unique to the call, as determined by the initiating party.

Response Body

Attribute

Type

Condition

Description

accounts Array of Account Details Mandatory  


Sample Response


		
{"accounts": [ {"resourceId": "3dc3d5b3-7023-4848-9853-f5400a64e80f", "iban": "DE2310010010123456789", "currency": "EUR", "product": "Girokonto", "cashAccountType": "CurrentAccount", "name": "Main Account", "_links": { "balances": {"href": "/accounts/v1/3dc3d5b3-7023-4848-9853-f5400a64e80f/balances"}, "transactions": {"href": "/accounts/v1/3dc3d5b3-7023-4848-9853-f5400a64e80f/transactions" }, {"resourceId": "3dc3d5b3-7023-4848-9853-f5400a64e81g", "iban": "DE2310010010123456788", "currency": "USD", "product": "Fremdwährungskonto", "cashAccountType": "CurrentAccount", "name": "US Dollar Account", "_links": { "balances": {"href": "/accounts/v1/3dc3d5b3-7023-4848-9853-f5400a64e81g/balances" } ]}

 

Reads details about an account, with balances where required.


Path Parameters

Attribute

Type

Description

account-id string This identification is denoting the addressed account. The account-id is retrieved by using a "Read Account List" call. The account-id is the "resourceId" attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent.

Query Parameters

Attribute

Type

Condition

Description

withBalance Boolean Optional 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.

Request Header

Attribute

Type

Condition

Description

X-Request-ID UUID Mandatory ID of the request, unique to the call, as determined by the initiating party.
Consent-ID String Mandatory Shall be contained since "Establish Consent Transaction" was performed via this API before.
Authorization String Conditional Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.
Client-ID String Mandatory TPP's Client ID, returned from Dynamic Registration.
Client-Secret String Mandatory TPP's Client Secret, returned from Dynamic Registration.
apikey String Mandatory API Key value obtained from Dashboard/Applications page in API Store, for SANDBOX/PRODUCTION plan.

Response Header

Attribute

Type

Condition

Description

X-Request-ID UUID Mandatory ID of the request, unique to the call, as determined by the initiating party.

Response Body

Attribute

Type

Condition

Description

account Account Details Mandatory  


Sample Response


		
{"account": {"resourceId": "3dc3d5b3-7023-4848-9853-f5400a64e80f", "iban": "FR7612345987650123456789014", "currency": "EUR", "product": "Girokonto", "cashAccountType": "CurrentAccount", "name": "Main Account", "_links": { "balances": {"href": "/accounts/v1/3dc3d5b3-7023-4848-9853-f5400a64e80f/balances"}, "transactions": {"href": "/accounts/v1/3dc3d5b3-7023-4848-9853-f5400a64e80f/transactions" } }

 

Reads account data from a given account addressed by "account-id".


Path Parameters

Attribute

Type

Description

account-id String This identification is denoting the addressed account. The account-id is retrieved by using a "Read Account List" call. The account-id is the "resourceId" attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent.

Request Header

Attribute

Type

Condition

Description

X-Request-ID UUID Mandatory ID of the request, unique to the call, as determined by the initiating party.
Consent-ID String Mandatory Shall be contained since "Establish Consent Transaction" was performed via this API before.
Authorization String Conditional Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.
Client-ID String Mandatory TPP's Client ID, returned from Dynamic Registration.
Client-Secret String Mandatory TPP's Client Secret, returned from Dynamic Registration.
apikey String Mandatory API Key value obtained from Dashboard/Applications page in API Store, for SANDBOX/PRODUCTION plan.

Response Header

Attribute

Type

Condition

Description

X-Request-ID UUID Mandatory ID of the request, unique to the call, as determined by the initiating party.

Response Body

Attribute

Type

Condition

Description

account Account Reference Optional Identifier of the addressed account.
balances Array of Balances Mandatory A list of balances regarding this account, e.g. the current balance, the last booked balance.


Sample Response


		
{ "account": {"iban": "FR7612345987650123456789014"}, "balances": [{"balanceType": "closingBooked", "balanceAmount": {"currency": "EUR", "amount": "500.00"}, "referenceDate": "2017-10-25" }, {"balanceType": "expected", "balanceAmount": {"currency": "EUR","amount": "900.00"}, "lastChangeDateTime": "2017-10-25T15:30:35.035Z" }] }

 

Reads account data from a given account addressed by "account-id".


Path Parameters

Attribute

Type

Description

account-id String This identification is denoting the addressed account. The account-id is retrieved by using a "Read Account List" call. The account-id is the "resourceId" attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent.

Query Parameters

Attribute

Type

Condition

Description

dateFrom ISODate Optional Starting date (inclusive the date dateFrom) of the transaction list.
dateTo ISODate Optional End date (inclusive the data dateTo) of the transaction list, default is "now" if not given.
withBalance Boolean Optional 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.

Request Header

Attribute

Type

Condition

Description

X-Request-ID UUID Mandatory ID of the request, unique to the call, as determined by the initiating party.
Consent-ID String Mandatory Shall be contained since "Establish Consent Transaction" was performed via this API before.
Authorization String Conditional Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.
Client-ID String Mandatory TPP's Client ID, returned from Dynamic Registration.
Client-Secret String Mandatory TPP's Client Secret, returned from Dynamic Registration.
apikey String Mandatory API Key value obtained from Dashboard/Applications page in API Store, for SANDBOX/PRODUCTION plan.

Response Header

Attribute

Type

Condition

Description

Content-Type String Mandatory application/json
X-Request-ID UUID Mandatory ID of the request, unique to the call, as determined by the initiating party.

Response Body

Attribute

Type

Condition

Description

account Account Reference Optional Identifier of the addressed account. Remark for Future: It is recommended to use this data element. The condition might change to "mandatory" in a next version of the specification.
transactions Account Report Optional JSON based account report.
balances Balances Optional A list of balances regarding this account, e.g. the current balance, the last booked balance.


Sample Response


		
{“account”: {"iban":"DE2310010010123456788" }, "transactions": {"booked": [{ "transactionId": "1234567", "creditorName": "John Miles", "creditorAccount": {"iban": "DE67100100101306118605"}, "transactionAmount": {"currency": "EUR", "amount": "256.67"}, "bookingDate": "2017-10-25", "valueDate": "2017-10-26", "remittanceInformationUnstructured": "Example 1" },{ "transactionId": "1234568", "debtorName": "Paul Simpson", "debtorAccount": {"iban": "NL76RABO0359400371"}, "transactionAmount": {"currency": "EUR", "amount": "343.01"}, "bookingDate": "2017-10-25", "valueDate": "2017-10-26", "remittanceInformationUnstructured": "Example 2" }], "pending": [{ "transactionId": "1234569", "creditorName": "Claude Renault", "creditorAccount": {"iban": "FR7612345987650123456789014"}, "transactionAmount": {"currency": "EUR", "amount": "-100.03"}, "valueDate": "2017-10-26", "remittanceInformationUnstructured": "Example 3" }], "_links": {"account": {"href":"/accounts/v1/3dc3d5b3-7023-4848-9853-f5400a64e80f" } }

 

Reads transaction details from a given transaction addressed by “resourceId” on a given account addressed by "account-id".


Path Parameters

Attribute

Type

Description

account-id String This identification is denoting the addressed account. The account-id is retrieved by using a "Read Account List" call. The account-id is the "resourceId" attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent.
resourceId String This identification is given by the attribute resourceId of the corresponding entry of a transaction list.

Request Header

Attribute

Type

Condition

Description

X-Request-ID UUID Mandatory ID of the request, unique to the call, as determined by the initiating party.
Consent-ID String Mandatory Shall be contained since "Establish Consent Transaction" was performed via this API before.
Authorization String Conditional Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the related consent authorisation.
Client-ID String Mandatory TPP's Client ID, returned from Dynamic Registration.
Client-Secret String Mandatory TPP's Client Secret, returned from Dynamic Registration.
apikey String Mandatory API Key value obtained from Dashboard/Applications page in API Store, for SANDBOX/PRODUCTION plan.

Response Header

Attribute

Type

Condition

Description

Content-Type String Mandatory application/json
X-Request-ID UUID Mandatory ID of the request, unique to the call, as determined by the initiating party.

Response Body

Attribute

Type

Condition

Description

transactionsDetails Transactions Optional  


Sample Response


		
{"transactionsDetails": { "transactionId": "1234567", "creditorName": "John Miles", "creditorAccount": {"iban": "DE67100100101306118605"}, "mandateId": "Mandate-2018-04-20-1234", "transactionAmount": {"currency": "EUR", "amount": "-256.67"}, "bookingDate": "2017-10-25", "valueDate": "2017-10-26", "remittanceInformationUnstructured": "Example 1", "bankTransactionCode": "PMNT-RCVD-ESDD", }

 



Types


	

Account Details

Attribute

Type

Condition

Description

resourceId String Conditional  
iban IBAN Optional  
currency Currency Code (ISO 4217 Alpha 3 currency code) Mandatory Multicurrency accounts are not supported by Garanti BBVA Romania.
name Max35Text Optional Name of the account given by the bank or the PSU in Online-Banking
cashAccountType Cash Account Type (ExternalCashAccountType1Code) Optional "CACC" for current accounts which are not overdrafts and "ODFT" for overdrafts.
status String Optional Account status. The value is the following: - "enabled": account is available "deleted" and "blocked" accounts will not be listed. If this field is not used, than the account is available in the sense of this specification.
balances Array of Balances Conditional  
_links Links Optional 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.

Balance

Attribute

Type

Condition

Description

balanceAmount Amount Mandatory  
balanceType Balance Type Mandatory  
creditLimitIncluded Boolean Optional A flag indicating if the credit limit of the corresponding account is included in the calculation of the balance, where applicable.
lastChangeDateTime ISODateTime Optional This data element might be used to indicate e.g. with the expected or booked balance that no action is known on the account, which is not yet booked.
referenceDate ISODate Optional reference date of the balance
lastCommitted Transaction Max35Text Optional entryReference of the last commited transaction to support the TPP in identifying whether all PSU transactions are already known.

Amount

Attribute

Type

Condition

Description

currency Currency Code Mandatory ISO 4217 Alpha 3 currency code
amount String Mandatory The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. Negative amounts are signed by minus. The decimal separator is a dot. Example: Valid representations for EUR with up to two decimals are: * 1056 * 5768.2 * -1.50 * 5877.78

Balance Type

Attribute

Description

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.

Account Reference

Attribute

Type

Condition

Description

iban IBAN Conditional  

Account Report

Attribute

Type

Condition

Description

booked Array of Transactions Mandatory  
_links Links Mandatory Links to the account, which can be directly used for retrieving account information from this dedicated account.  

Transaction

Attribute

Type

Condition

Description

transactionId String Optional Can be used as access-ID in the API, where more details on an transaction is offered. If this data attribute is provided this shows that the AIS can get access on more details about this transaction using the GET Transaction Details Request as defined in Section 6.6.5
entryReference Max35Text Optional Is the identification of the transaction as used e.g. for reference for deltafunction on application level. The same identification as for example used within camt.05x messages.
bookingDate ISODate Optional The Date when an entry is posted to an account on the ASPSPs books.
valueDate ISODate Optional The Date at which assets become available to the account owner in case of a credit
transactionAmount Amount Mandatory The amount of the transaction as billed to the account.
creditorName Max70Text Optional Name of the creditor if a "Debited" transaction
creditorAccount Account Reference Conditional  
debtorName Max70Text Optional Name of the debtor if a "Credited" transaction
debtorAccount Account Reference Conditional  


Response Codes

Code

Description

Type

200 OK ACCEPTED SUCCESS
405 {http.method} Method Not Allowed CALL METHOD ERROR
400 Bad Request MISSING PARAMETERS
401 Invalid Credentials UNAUTHORIZED
404 Not Found NOT FOUND
500 Internal Server Error SYSTEM ERROR