Account Information
Service Description
Account Information service of Electronic Bank Statement is used to get account details of given accounts.
This API is in the balance and movements category.
API Profile |
|
---|---|
Attribute |
Value |
Name | Account Information |
Version | V1 |
Synopsis | Account Information Service |
Description | Returns Account Information of Specified Accounts |
Pre-Conditions | HTTP POST method is allowed only in Account Information Service. |
Authentication |
OAuth 2.0 with Client Credentials |
Before your application can access the API, it must obtain a new access token for each request. The access token can be used only one time.
Endpoint Definition
Account Information API’s development live and mock environments routing data.
EndPoint / DEVELOPMENT SANDBOX SERVICE |
|
---|---|
URI | /balancesandmovements/accountinformation/account/v1/getaccountinformation |
Base URL | https://apis.garantibbva.com.tr:443 |
Technology
Technology Stack / DESIGN TIME |
|
---|---|
Property | Value |
HTTP Call Method | POST |
Response Content Type | application/json |
Request
HTTP POST method is allowed only in Account Information service.
Arguments
The list of arguments by the Account Information service to be invoked.
Request Fields | Type | Description | Obligation |
---|---|---|---|
consentId | String | Consent ID that is get after enrollment process. | Mandatory |
unitNum | Integer | Branch number of account number | Optional |
accountNum | Integer | Number of the account which details are requested | Optional |
IBAN | String | IBAN of the account number | Optional |
Sample request
Response
Account Information service returns details of accounts that are related with given consent ID.
Sample Response
Return Codes & Error Handling
Code |
Description |
Type |
---|---|---|
200 | OK | SUCCESS |
400 | Invalid Request | MISSING PARAMETERS |
401 | Invalid Credentials | UNAUTHORIZED |
405 | {http.method} Method Not Allowed | CALL METHOD ERROR |
429 | API plan limit exceeded | RATE LIMITING |
500 | Internal Server Error | SYSTEM ERROR |
Return Messages
CODE |
RETURN RESPONSE |
---|---|
400 |
{
"result": {
"returnCode": 400,
"reasonCode": 0,
"messageText": "Invalid Request"
}
}
|
401 |
{
"result": {
"returnCode": 401,
"reasonCode": 0,
"messageText": "Invalid Credentials"
}
}
|
405 |
{
"result": {
"returnCode": 405,
"reasonCode": 0,
"messageText": "POST Method Not Allowed"
}
}
|
429 |
{
"result": {
"returnCode": 429,
"reasonCode": 0,
"messageText": "API plan limit exceeded"
}
}
|
500 |
{
"result": {
"returnCode": 500,
"reasonCode": 0,
"messageText": "Internal Server Error"
}
}
|
Response Messages
CODE |
RETURN RESPONSE |
---|---|
400 |
{
"result": {
"returnCode": 400,
"reasonCode": 2,
"messageText": "Consent id bilgisi zorunludur."
}
}
|
400 |
{
"result": {
"returnCode": 400,
"reasonCode": 3,
"messageText": "Consent id bilgisi zorunludur."
}
}
|
400 |
{
"result": {
"returnCode": 400,
"reasonCode": 5,
"messageText": "Şube ve Hesap numaraları birlikte gönderilmelidir. Lütfen kontrol ediniz."
}
}
|
400 |
{
"result": {
"returnCode": 400,
"reasonCode": 13,
"messageText": "Hesap bilgisi ile İban bilgisi uyumsuzdur. Lütfen kontrol ediniz."
}
}
|
404 |
{
"result": {
"returnCode": 404,
"reasonCode": 4,
"messageText": "Vermiş olduğunuz clientId-consentId bilgileri hatalıdır. Lütfen kontrol ediniz."
}
}
|
404 |
{
"result": {
"returnCode": 404,
"reasonCode": 6,
"messageText": "Hesap bilgisi hatalıdır. Lütfen kontrol ediniz."
}
}
|
-
API URL : https://apis.garantibbva.com.tr
-
-
-