inter-API Account Services
Introduction
It aims to share the detailed information about Account Service products via Inter-API with the customers who use the product, thereby facilitating their accounting integration. Requested information about the product will be transmitted through web service functions.
Methods:
GetCorparateAccountTransactionList
GetAccountList
GetAccountDetail
How to Get Started
Step 1 - Sign Up & Register: To start building with our APIs, you'll need to sign up for account. Read our documentation on how to use the Inter-API services and secure your connection with the right electronic certificate
Step 2 - Get Subscription Key: To get your Subscription Key, you'll first need to Subscribe for a package on Products page.
Step 3 - Activate: Get your subscription key under profile menu. You can also add your applications here.
Step 4 - Test API Methods: Include your access token and the information needed for that API. From there, use the response for your application and you’re all set. Now you can start building applications with our API.
Step 5 - For Production: You 're now up and running on inter-API Portal. Submit for production When you’re finished testing, you may want to submit your app for production. If it seems like we’d be a good fit, we’ll look into it and do some testing together. Then, we’ll talk about next steps to move to production.
GetCorporateAccountTransactionList
Returns account transactions according to the entered Customer No, Account No, Branch No and Date range.
Request:
{
"Header": {
"Channel": "****",
"AppKey": "****",
"ChannelSessionId": "331eb5f529c74df2b800926b5f34b87412",
"ChannelRequestId": "4dsf55daadf23sdfds564gh564gf56jh"
},
"Parameters": [
{
"CustomerNo": "3374562",
"AccountBranchCode": 9142,
"AccountSuffix": 355,
"AssociationCode": " ",
"IBANNumber": "",
"QueryDate": "2020-07-05T00:01:00.000+03:00",
"EndDate": "2020-07-05T23:59:00.000+03:00"
}
]
}Response:
{
"$type": "ServiceResponseMessage",
"Data": {
"$type": "OnlineAccountTransactionsQueryMessage",
"Accounts": [
{
"$type": "OnlineAccount",
"MaturityDate": "2020-04-22T00:00:00",
"AvailableBalanceWithCredit": 99700491.88,
"CreditLimit": 50000,
"AvailableBalance": 99650491.88,
"BlockageAmount": 349000,
"AccountNumber": 3487796,
"AccountBranchName": "ZİNCİRLİKUYU",
"AccountBranchCode": 9142,
"AccountCurrencyCode": "TRY",
"AccountName": "SONER KURU",
"AccountType": "VDSZMVD",
"AccountSuffix": 351,
"IBANNumber": "TR160013400092815536900351",
"Transactions": [
{
"$type": "OnlineAccountTransactionDetail",
"Valor": "2020-04-21T00:00:00",
"ReceiptNumber": "9300202004210000000051",
"DestinationAccount": "1841498",
"DestinationAccountIdendityNumber": "24775184772",
"DestinationAccountTitle": "TR160013400092815536900351",
"ReferecenceNumber": "51",
"TransactionName": "Giden havale - Hesaptan Havale",
"TransactionDetail1": "29019247138",
"TransactionDetail2": "TR660013400094643937400351@@@9142-1841498-351",
"TransactionDetail3": "",
"TransactionDetail4": "BELLADONNA TOOK THAYERİA",
"TransactionDetail5": "SUMBRAS LOBOTİDAE",
"BankDescription": "Havale TEST",
"TransactionCode": "TRF",
"TransactionCode": "TRF",
"Description": "CurrentAccounts - CHVLH",
"Channel": "API",
"BalanceBeforeTransaction": 99999989,
"BalanceAfterTransaction": 99999982,
"Amount": -7,
"OrderNumber": 1,
"Time": "20:43:51",
"Date": "2020-04-21T20:43:51",
"CustomerNo": 3487796,
"IslemDurumu": "A",
"DebitCreditType": "B"
}
]
}
]
}
}Data Structures
Detailed information about the data structures used in the function is given in Figure 1, Figure 2 and Figure 3.
Fiqure 1
Figure 2
Figure 3
FAST Money Transfer Transaction Example:
"TransactionCode": "MSC",
"SubTransactionCode": "MSC",
"TransactionName": "Fast Para Transferi Gelen - Fast Para Transferi Gelen",
"BankDescription": "Fast - EFSTR",
"DestinationAccount": SENDER_BANK + '-' + SENDER_ACCOUNT_BRANCH_CODE + '-' + SENDER_ACCOUNT_NUMBER + '-' + SENDER_ACCOUNT_SUFFIX + '@@@' + SENDER_IBAN
"DestinationAccountIdendityNumber": SENDER_IDENTITY_NUMBER
"DestinationAccountTitle": "",
"TransactionDetail1": RECEIVER_ACCOUNT_BRANCH_CODE + '-' + RECEIVER _ACCOUNT_NUMBER + '-' + RECEIVER _ACCOUNT_SUFFIX + '@@@' + RECEIVER _IBAN
"TransactionDetail2": RECEIVER_IDENTITY_NUMBER
"TransactionDetail3": RECEIVER_NAME
"TransactionDetail4": SENDER_BANK
"TransactionDetail5": REFERENCE_NUMBER + '@@@' + QUERY_NUMBER
GetAccountList
Its brings up the account list.
Request
{
"Header": {
"AppKey": "***",
"Channel": "API",
"ChannelSessionId": "test",
"ChannelRequestId": "5252012362481156055"
},
"Parameters": [
{
"CustomerNo": "123"
}
]
}Response
{
"$type": "Account",
"AccountSuffix": 353,
"BranchCode": 9190,
"BranchName": "ALSANCAK",
"CustomerNo": 123,
"ProductCode": "10202000",
"OriginalProductCode": "ISKONTO",
"ProjectCode": "RFGRTI",
"CurrencyCode": "TRY",
"AccountName": "Test Test",
"IBANNo": "TR170013400090811641900353",
}GetAccountDetail
Returns the account detail information.
Request
{
"Header": {
"AppKey": "***",
"Channel": "API",
"ChannelSessionId": "331eb5f529c74df2b800926b5f34b874",
"ChannelRequestId": "5252012362481156055"
},
"Parameters": [
{
"AccountInfo": {
"AccountSuffix": 0,
"BranchCode": 0,
"CustomerNo": 0
},
"IBANNo": "TR320013400098980493800351"
}
]
}Response
{
"$type": "ServiceResponseMessage",
"Data": {
"$type": "AccountDetailsMessage",
"AccountInfo": {
"$type": "Account",
"AccountSuffix": 351,
"BranchCode": 4420,
"CustomerNo": 12695687,
"CurrencyCode": "TRY",
"AccountName": "NECMİ EKER ",
"IBANNo": "TR320013400098980493800351"
}
}
}