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
pageIndex Integer Page index number Optional
pageSize Integer Number of transactions returned in each page Optional

The list of arguments to be returned within Enrichment Information array by the Account Transactions service.

Enrichment Code Enrichment Value Type Description
CORRACNT moduleName String Name of the module
productType String Type of the product
corrAccountNum Integer Corresponding account number
corrUnitNum Integer Corresponding unit number
corrIBAN String Corresponding IBAN
MUS moduleName String Name of the module
nameSurnameText String Name of the owner 
corrNameSurnameText String Name of the corresponding account owner
HES moduleName String Name of the module
accountMainType String

Main type of the account

M: Deposit

K: Credit

H: Treasury

accSubType String

Sub type of the account

V: Savings account

S: Current account
accType String

Type of the account

K: FCY Current Account

V: Vostro

N: Nostro

Z: FCY No Overdraft

Y: FCY/LCY With Overdraft

X: LCY No Overdraft

A: LCY Commercial Deposit Account

C: LCY Savings Account

E: LCY Time Deposit Account

M: FCY Time Deposit Account

Q: Cheque Account
productCode String Product code of the account 
subProductCode String Sub product code of the account
DTS moduleName String Name of the module
firmOriginalText String Explanation text of firm
relatedInvText1 String Related invoice text
DEK moduleName String Name of the module
detailText String Explanation text
MAAS moduleName String Name of the module
firmOriginalText1 String Explanation text of firm
txnId String Firm’s txnId (Garanti Connect field)
ustrId String

Unstructured id

(Garanti Connect field)
THE moduleName String Name of the module
firmOriginalText1 String Explanation text of firm
txnId String Firm’s txnId (Garanti Connect field)
ustrId String

Unstructured id

(Garanti Connect field)
DIM moduleName String Name of the module
firmOriginalText1 String Explanation text of firm
ustrId String

Unstructured id

(Garanti Connect field)
DOV moduleName String Name of the module
processRate Decimal Exchange rate of the transaction 
EFT moduleName String Name of the module
corrBankNum Integer Corresponding bank EFT code
corrUnitNum Integer Corresponding unit number
corrBankCityNum Integer Corresponding bank city number
referenceNum Integer EFT reference number
rejectedMsgReferenceNum Integer EFT reference number of rejected message
valueDate Date Value date of the process
msgType String

Process type of the message

KRED: Payment to account

NORM: Payment to name

KRED-KART: Credit card payment

IADE: Refund of the payment
senderIBANEFT String IBAN of the sender
receiverIBANEFT String IBAN of the receiver
senderName String Name of the sender
receiverName String Name of the receiver
remark String Explanation text
senderVKN Integer Tax or identity number of the sender
corrAccountNum String Owner account
corrGoAddress String Corresponding address
rejectedDate Date

Rejected date if applicable

(YYYYMMDD)
rejectedCode String

Rejected code if applicable

01: Receiver information is missing or incorrect.

02: Account number and receiver name do not match.

03: Account is closed.

04: Account number is incorrect (i.e. IBAN has an error)

05: Account is not suitable for EFT. (i.e. FX account)

06: Refund based on refund request message

07: Identity/Tax Number in the message is different from the number in participants record.

08: Sender information is missing or incorrect.

09: Receiver branch number is incorrect (in payments without IBAN).

10: Account is only open for payments with refund message.

11: Receiver information and account number are not existed at the bank.

99: Other reasons (reject reason is mentioned in the explanation field)

Sample request

{
  "consentId": "3e09da8a-ae9c-50bc-b34a-c61531729dbe",
  "unitNum": "295",
  "accountNum": "6291296",
  "IBAN": "TR620006200029500006291296",
  "startDate": "2020-12-25T12:53:07.867",
  "endDate": "2020-12-25T17:53:07.867",
  "transactionId": "",
  "pageIndex": 1,
  "pageSize": 100
}

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": "TL",
      "IBAN": "TR620006200029500006291296",
      "activityDate": "2020-12-25",
      "valueDate": "2020-12-28",
      "txnCreditDebitIndicator": "A",
      "amount": 1250.67,
      "balanceAfterTransaction": 9836180.2,
      "explanation": "00000",
      "transactionId": "WPDT",
      "clasificationCode": "NDTS",
      "corrVKN": "1518410029",
      "corrTCKN": null,
      "corrCustomerNum": 45271413,
      "transactionReferenceId": "2020-12-25T16:13:36.688516",
      "transactionInstanceId": "2020-12-25T16:13:36.862988",
      "enrichmentInformation": [
        {
          "enrichmentCode": "CORRACNT",
          "enrichmentValue": {
            "moduleName": "CORRACNT",
            "productType": "Account",
            "corrAccountNum": "6287369",
            "corrUnitNum": "295",
            "corrIBAN": "TR700006200029500006287369"
          }
        },
        {
          "enrichmentCode": "MUS",
          "enrichmentValue": {
            "moduleName": "MUS",
            "nameSurnameText": "DURU LTD ",
            "corrNameSurnameText": "DURU LTD "
          }
        },
        {
          "enrichmentCode": "HES",
          "enrichmentValue": {
            "moduleName": "HES",
            "accountMainType": "M",
            "accSubType": "S",
            "accType": "A",
            "productCode": "VDSTDUI",
            "subProductCode": ""
          }
        },
        {
          "enrichmentCode": "DTS",
          "enrichmentValue": {
            "moduleName": "DTS",
            "firmOriginalText": "",
            "relatedInvText1": ""
          }
        },
        {
          "enrichmentCode": "DEK",
          "enrichmentValue": {
            "moduleName": "DEK",
            "detailText": ""
          }
        }
      ]
    },
    {
      "customerNum": 45248653,
      "customerName": "DURU LTD ",
      "VKN": 1924326460,
      "TCKN": null,
      "productId": "9d5de526-e32c-5cc7-81ce-545b93ade759",
      "unitNum": 295,
      "accountNum": 6291335,
      "currencyCode": null,
      "IBAN": "TR760006200029500006291335",
      "activityDate": "2020-11-04",
      "valueDate": "2020-11-04",
      "txnCreditDebitIndicator": "B",
      "amount": 20,
      "balanceAfterTransaction": 1071.46,
      "explanation": "MAAŞ ÖDEMESİ",
      "transactionId": "ELMS",
      "clasificationCode": "MAAS",
      "corrVKN": "1194136989",
      "corrTCKN": null,
      "corrCustomerNum": 45245447,
      "transactionReferenceId": "2020-12-25T13:31:16.79895",
      "transactionInstanceId": "2020-12-25T13:44:38.453646",
      "enrichmentInformation": [
        {
          "enrichmentCode": "CORRACNT",
          "enrichmentValue": {
            "moduleName": "CORRACNT",
            "productType": "Account",
            "corrAccountNum": "6291296",
            "corrUnitNum": "295",
            "corrIBAN": "TR620006200029500006291296"
          }
        },
        {
          "enrichmentCode": "DEK",
          "enrichmentValue": {
            "moduleName": "DEK",
            "detailText": ""
          }
        },
        {
          "enrichmentCode": "HES",
          "enrichmentValue": {
            "moduleName": "HES",
            "accountMainType": "M",
            "accSubType": "S",
            "accType": "A",
            "productCode": "VDSTDUI",
            "subProductCode": ""
          }
        },
        {
          "enrichmentCode": "MAAS",
          "enrichmentValue": {
            "moduleName": "MAAS",
            "firmOriginalText1": "TR10200SCAN008033",
            "txnId": "",
            "ustrId": ""
          }
        },
        {
          "enrichmentCode": "MUS",
          "enrichmentValue": {
            "moduleName": "MUS",
            "nameSurnameText": "DURU LTD ",
            "corrNameSurnameText": "DURU LTD "
          }
        }
      ]
    },
    {
      "customerNum": 45245447,
      "customerName": "DURU LTD ",
      "VKN": 1194136989,
      "TCKN": null,
      "productId": "9d5de526-e32c-5cc7-81ce-545b93ade759",
      "unitNum": 295,
      "accountNum": 6291296,
      "currencyCode": "TL",
      "IBAN": "TR620006200029500006291296",
      "activityDate": "2020-12-25",
      "valueDate": "2020-12-25",
      "txnCreditDebitIndicator": "B",
      "amount": 38.55,
      "balanceAfterTransaction": 9835022.59,
      "explanation": "Para Transferi",
      "transactionId": "ELMP",
      "clasificationCode": "NTHE",
      "corrVKN": "1472052328",
      "corrTCKN": null,
      "corrCustomerNum": 45263420,
      "transactionReferenceId": "2020-12-25T14:17:12.094419",
      "transactionInstanceId": "2020-12-25T14:17:12.179689",
      "enrichmentInformation": [
        {
          "enrichmentCode": "CORRACNT",
          "enrichmentValue": {
            "moduleName": "CORRACNT",
            "productType": "Account",
            "corrAccountNum": "6288869",
            "corrUnitNum": "295",
            "corrIBAN": "TR190006200029500006288869"
          }
        },
        {
          "enrichmentCode": "THE",
          "enrichmentValue": {
            "moduleName": "THE",
            "firmOriginalText1": "202012300145504",
            "txnId": "",
            "ustrId": ""
          }
        },
        {
          "enrichmentCode": "MUS",
          "enrichmentValue": {
            "moduleName": "MUS",
            "nameSurnameText": "DURU LTD ",
            "corrNameSurnameText": "DURU LTD "
          }
        },
        {
          "enrichmentCode": "HES",
          "enrichmentValue": {
            "moduleName": "HES",
            "accountMainType": "M",
            "accSubType": "S",
            "accType": "A",
            "productCode": "VDSTDUI",
            "subProductCode": ""
          }
        },
        {
          "enrichmentCode": "DEK",
          "enrichmentValue": {
            "moduleName": "DEK",
            "detailText": ""
          }
        }
      ]
    },
    {
      "customerNum": 45195461,
      "customerName": "DURU LTD ",
      "VKN": 1981497602,
      "TCKN": null,
      "productId": "9d5de526-e32c-5cc7-81ce-545b93ade759",
      "unitNum": 295,
      "accountNum": 9805200,
      "currencyCode": null,
      "IBAN": "TR630006200029500009805200",
      "activityDate": "2020-10-27",
      "valueDate": "2020-10-27",
      "txnCreditDebitIndicator": "B",
      "amount": 179,
      "balanceAfterTransaction": 2221,
      "explanation": "0502956073357    Ref. HavaleCJ EUROPE GMBH",
      "transactionId": "XG05",
      "clasificationCode": "???",
      "corrVKN": null,
      "corrTCKN": null,
      "corrCustomerNum": null,
      "transactionReferenceId": "2020-12-25T15:21:16.76825",
      "transactionInstanceId": "2020-12-25T15:31:16.76825",
      "enrichmentInformation": [
        {
          "enrichmentCode": "CORRACNT",
          "enrichmentValue": {
            "moduleName": "CORRACNT",
            "productType": "Account",
            "corrAccountNum": null,
            "corrUnitNum": null,
            "corrIBAN": "TR240009200000000002014033"
          }
        },
        {
          "enrichmentCode": "MUS",
          "enrichmentValue": {
            "moduleName": "MUS",
            "nameSurnameText": "DURU LTD ",
            "corrNameSurnameText": null
          }
        },
        {
          "enrichmentCode": "HES",
          "enrichmentValue": {
            "moduleName": "HES",
            "accountMainType": "M",
            "accSubType": "S",
            "accType": "K",
            "productCode": "DTHSFTI",
            "subProductCode": ""
          }
        },
        {
          "enrichmentCode": "DIM",
          "enrichmentValue": {
            "moduleName": "DIM",
            "firmOriginalText1": "USD 200030009940601",
            "ustrId": "PAYR:00023111544/BENR:REF.BFO1//BARLAS EITIM DANMANLK BILG. HIZM. T"
          }
        }
      ]
    },
    {
      "customerNum": 45245447,
      "customerName": "DURU LTD ",
      "VKN": 1194136989,
      "TCKN": null,
      "productId": "9d5de526-e32c-5cc7-81ce-545b93ade759",
      "unitNum": 295,
      "accountNum": 6291296,
      "currencyCode": "TL",
      "IBAN": "TR620006200029500006291296",
      "activityDate": "2020-12-25",
      "valueDate": "2020-12-25",
      "txnCreditDebitIndicator": "B",
      "amount": 0.92,
      "balanceAfterTransaction": 9834929.53,
      "explanation": "KESİNTİ VE EKLERİ-DÖVİZ İŞLEMLERİ",
      "transactionId": "GCD1",
      "clasificationCode": "NCOM",
      "corrVKN": null,
      "corrTCKN": null,
      "corrCustomerNum": null,
      "transactionReferenceId": "2020-12-25T14:19:39.629065",
      "transactionInstanceId": "2020-12-25T14:19:40.56661",
      "enrichmentInformation": [
        {
          "enrichmentCode": "HES",
          "enrichmentValue": {
            "moduleName": "HES",
            "accountMainType": "M",
            "accSubType": "S",
            "accType": "A",
            "productCode": "VDSTDUI",
            "subProductCode": ""
          }
        },
        {
          "enrichmentCode": "MUS",
          "enrichmentValue": {
            "moduleName": "MUS",
            "nameSurnameText": "DURU LTD ",
            "corrNameSurnameText": null
          }
        }
      ]
    },
    {
      "customerNum": 45245447,
      "customerName": "DURU LTD ",
      "VKN": 1194136989,
      "TCKN": null,
      "productId": "9d5de526-e32c-5cc7-81ce-545b93ade759",
      "unitNum": 295,
      "accountNum": 6291296,
      "currencyCode": "TL",
      "IBAN": "TR620006200029500006291296",
      "activityDate": "2020-12-25",
      "valueDate": "2020-12-25",
      "txnCreditDebitIndicator": "B",
      "amount": 92.14,
      "balanceAfterTransaction": 9834930.45,
      "explanation": "INT DÖVİZ ALIŞ  6291296 - 6153564 EUR:9.21410",
      "transactionId": "GCD1",
      "clasificationCode": "??",
      "corrVKN": "1194136989",
      "corrTCKN": null,
      "corrCustomerNum": 45245447,
      "transactionReferenceId": "2020-12-25T14:19:39.629065",
      "transactionInstanceId": "2020-12-25T14:19:40.450429",
      "enrichmentInformation": [
        {
          "enrichmentCode": "MUS",
          "enrichmentValue": {
            "moduleName": "MUS",
            "nameSurnameText": "DURU LTD ",
            "corrNameSurnameText": "DURU LTD "
          }
        },
        {
          "enrichmentCode": "HES",
          "enrichmentValue": {
            "moduleName": "HES",
            "accountMainType": "M",
            "accSubType": "S",
            "accType": "A",
            "productCode": "VDSTDUI",
            "subProductCode": ""
          }
        },
        {
          "enrichmentCode": "DOV",
          "enrichmentValue": {
            "moduleName": "DOV",
            "processRate": "9.214100"
          }
        },
        {
          "enrichmentCode": "CORRACNT",
          "enrichmentValue": {
            "moduleName": "CORRACNT",
            "productType": "Account",
            "corrAccountNum": "6153564",
            "corrUnitNum": "295",
            "corrIBAN": "TR400006200029500006153564"
          }
        }
      ]
    },
    {
      "customerNum": 45245447,
      "customerName": "DURU LTD ",
      "VKN": 1194136989,
      "TCKN": null,
      "productId": "9d5de526-e32c-5cc7-81ce-545b93ade759",
      "unitNum": 295,
      "accountNum": 6291296,
      "currencyCode": "TL",
      "IBAN": "TR620006200029500006291296",
      "activityDate": "2020-12-25",
      "valueDate": "2020-12-25",
      "txnCreditDebitIndicator": "B",
      "amount": 560.7,
      "balanceAfterTransaction": 9835061.14,
      "explanation": "Para Transferi ELMP-EFT                             - 0140008",
      "transactionId": "ELMP",
      "clasificationCode": "NTHE",
      "corrVKN": null,
      "corrTCKN": null,
      "corrCustomerNum": null,
      "transactionReferenceId": "2020-12-25T14:15:14.008745",
      "transactionInstanceId": "2020-12-25T14:15:14.440521",
      "enrichmentInformation": [
        {
          "enrichmentCode": "CORRACNT",
          "enrichmentValue": {
            "moduleName": "CORRACNT",
            "productType": "Account",
            "corrAccountNum": null,
            "corrUnitNum": null,
            "corrIBAN": "TR470004600036888000060447"
          }
        },
        {
          "enrichmentCode": "THE",
          "enrichmentValue": {
            "moduleName": "THE",
            "firmOriginalText1": "202012061215036",
            "txnId": "",
            "ustrId": ""
          }
        },
        {
          "enrichmentCode": "MUS",
          "enrichmentValue": {
            "moduleName": "MUS",
            "nameSurnameText": "DURU LTD ",
            "corrNameSurnameText": "HAN LTD "
          }
        },
        {
          "enrichmentCode": "HES",
          "enrichmentValue": {
            "moduleName": "HES",
            "accountMainType": "M",
            "accSubType": "S",
            "accType": "A",
            "productCode": "VDSTDUI",
            "subProductCode": ""
          }
        },
        {
          "enrichmentCode": "EFT",
          "enrichmentValue": {
            "moduleName": "EFT",
            "corrBankNum": "46",
            "corrUnitNum": "90001",
            "corrBankCityNum": "999",
            "referenceNum": "140008",
            "valueDate": "20201225",
            "msgType": "KRED",
            "senderIBANEFT": "TR620006200029500006291296",
            "receiverIBANEFT": "TR470004600036888000060447",
            "senderName": "DURU LTD",
            "receiverName": " HAN LTD ",
            "remark": "TRANSFER ELMP-EFT",
            "senderVKN": "1194136989",
            "corrAccountNum": "TR620006200029500006291296",
            "corrGoAddress": "TR470004600036888000060447",
            "rejectedDate": null,
            "rejectedCode": null,
            "rejectedMsgReferenceNum": null
          }
        },
        {
          "enrichmentCode": "DEK",
          "enrichmentValue": {
            "moduleName": "DEK",
            "detailText": ""
          }
        }
      ]
    }
  ]
}

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."
  }
}
400
{
  "result": {
    "returnCode": 400,
    "reasonCode": 30,
    "messageText": "Page Size alanı 500 den büyük olamaz."
  }
}
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."
  }
}