Account Transactions

Service Description

Account Transactions service of Electronic Bank Statement is used to get transactions with enriched information of given accounts in between specified time interval.

 

This API is in the cash management category.

API Profile

Attribute

Value

Name Account Transactions
Version V1
Synopsis Account Transactions Service
Description Returns Account Transactions of Specified Accounts
Pre-Conditions HTTP POST method is allowed only in Account Transactions 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 Transactions API’s development live and mock environments routing data.

EndPoint DEVELOPMENT SANDBOX SERVICE

URI /balancesandmovements/accountinformation/transaction/v1/gettransactions
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 Transactions service.

Arguments

The list of arguments by the Account Transactions 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
startDate  Timestamp Start date of time interval that requested transactions take place Mandatory
endDate Timestamp End date of time interval that requested transactions take place Mandatory
transactionId String Category code of transaction Optional

Sample request

{
  "consentId": "1daac6c2-9fd1-55c6-a926-c3f2247405ab",
  "unitNum": "295",
  "accountNum": "6291296",
  "IBAN": "TR620006200029500006291296",
  "startDate": "2020-11-26T17:53:07.867",
  "endDate": "2020-11-26T18:53:07.867",
  "transactionId": ""
}

Response

Account Transactions service returns details of account transactions that are related with given consent ID.

Sample Response

{
   "result":    {
      "returnCode": 200,
      "reasonCode": 1,
      "messageText": "Başarılı”
   },
   "transactions": [   {
      "customerNum": 45245447,
      "customerName": "DURU LTD ",
      "VKN": 1194136989,
      "TCKN": null,
      "productId": "9d5de526-e32c-5cc7-81ce-545b93ade759",
      "unitNum": 295,
      "accountNum": 6291296,
      "currencyCode": null,
      "IBAN": "TR620006200029500006291296",
      "activityDate": "2020-11-26",
      "valueDate": "2020-11-26",
      "txnCreditDebitIndicator": "B",
      "amount": 225.75,
      "balanceAfterTransaction": 9995559.34,
      "explanation": "Deneme",
      "transactionId": "ELMP",
      "clasificationCode": "NTHE",
      "corrCustomerNum": 45263209,
      "transactionReferenceId": "2020-11-26T18:08:45.955302",
      "transactionInstanceId": "2020-11-26T18:08:46.005522",
      "enrichmentInformation":       [
                  {
            "enrichmentCode": "CORRACNT",
            "enrichmentValue":             {
               "moduleName": "CORRACNT",
               "productType": "Account",
               "corrAccountNum": "6289158",
               "corrUnitNum": "295",
               "corrIBAN": "TR730006200029500006289158"
            }
         },
                  {
            "enrichmentCode": "HES",
            "enrichmentValue":             {
               "moduleName": "HES",
               "accountMainType": "M",
               "accSubType": "S",
               "accType": "A",
               "productCode": "VDSTDUI",
               "subProductCode": ""
            }
         },
                  {
            "enrichmentCode": "MUS",
            "enrichmentValue":             {
               "moduleName": "MUS",
               "nameSurnameText": "DURU LTD ",
               "corrNameSurnameText": "DURU LTD "
            }
         }
      ]
   }
]
}
 

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."
  }
}
400
{
  "result": {
    "returnCode": 400,
    "reasonCode": 15,
    "messageText": "Transactionid bilgisi hatalıdır. Lütfen kontrol ediniz."
  }
}
400
{
  "result": {
    "returnCode": 400,
    "reasonCode": 18,
    "messageText": "Başlangıç-Bitiş tarih aralığı 30 günden fazla olamaz."
  }
}
400
{
  "result": {
    "returnCode": 400,
    "reasonCode": 19,
    "messageText": " Tarih bilgisi hatalıdır. Lütfen kontrol ediniz."
  }
}
400
{
  "result": {
    "returnCode": 400,
    "reasonCode": 21,
    "messageText": "Tarih bilgileri formatı hatalıdır. 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."
  }
}