Get Account List

It is the API that returns the list of accounts authorized by the customer.

 

Parameters

No input parameter required.

 

Name Type Description

-

- OAuth 2.0 is authenticated, request data is received through the login session

Data Returned

Data is returned as JSON as specified by the dataFormat parameter.

Regardless of format, the data contains the following fields:

Name Type Description

returnCode

string Return code of API call .

returnMessage

string Return message of authorization API call.

data

string Data contains the information below.

Accounts

Array Accounts list

Id

string The id information of the relevant account to be used in subsequent transactions.

BankName

string Bank name

BranchCode

string Code of the branch in the bank

BranchName

string Name of the branch in the bank

AccountNo

string Account number

Iban

string Iban information

Currency

string Currency short name

Balance

Decimal Available balance

BalanceAvaliable

Decimal Available credit balance

FormattedBalance

string Formatted available balance

FormattedBalanceAvaliable

string Formatted available credit balance

AccountType

string It can be used to filter accounts by type. Possible values: Deposit, TimeDeposit, GroupFirmAccount.

AccountTypeName

string Account type name. Possible values: “Vadeli”, “Vadesiz”, ...

GroupFirmName

string Company name

AccountName

string Account name

Examples

Request:

 
{   
}
  

Response:

            

{
   "returnCode":"API-00000",
   "returnMessage":"İşlem başarıyla gerçekleşmiştir.",
    "data": {
    "Accounts": [
        {
            "Id": "7147831853602399846",
            "BankName": "AKBANK",
            "BankCode": "00046",
            "BranchCode": "0883",
            "BranchName": "MERTER TICARI",
            "AccountNo": "0421608",
            "Iban": "TR960004600883888000421608",
            "Currency": "TRY",
            "Balance": 966.75,
            "BalanceAvailable": 966.75,
            "FormattedBalance": "966,75",
            "FormattedAvailableBalance": "966,75",
            "AccountType": "Deposit",
            "AccountTypeName": "Vadesiz",
            "GroupFirmName": "",
            "AccountName": ""
        },
        {
            "Id": "7075209326144926262",
            "BankName": "AKBANK",
            "BankCode": "00046",
            "BranchCode": "0883",
            "BranchName": "MERTER TICARI",
            "AccountNo": "0421611",
            "Iban": "TR630004600883001000421611",
            "Currency": "USD",
            "Balance": 2733.5,
            "BalanceAvailable": 2733.5,
            "FormattedBalance": "2.733,50",
            "FormattedAvailableBalance": "2.733,50",
            "AccountType": "GroupFirmAccount",
            "AccountTypeName": "Vadesiz",
            "GroupFirmName": "TEDARİKÇİ 4 YP BTS KARMA",
            "AccountName": ""
        },
        {
            "Id": "7306076887031702372",
            "BankName": "AKBANK",
            "BankCode": "00046",
            "BranchCode": "0883",
            "BranchName": "MERTER TICARI",
            "AccountNo": "0479453",
            "Iban": "TR290004600883001000479453",
            "Currency": "USD",
            "Balance": 0,
            "BalanceAvailable": 0,
            "FormattedBalance": "0,00",
            "FormattedAvailableBalance": "0,00",
            "AccountType": "GroupFirmAccount",
            "AccountTypeName": "Vadesiz",
            "GroupFirmName": "TEDARİKÇİ 4 YP BTS KARMA",
            "AccountName": ""
        },
        {
            "Id": "3991940123522708581",
            "BankName": "AKBANK",
            "BankCode": "00046",
            "BranchCode": "0883",
            "BranchName": "MERTER TICARI",
            "AccountNo": "0479456",
            "Iban": "TR450004600883001000479456",
            "Currency": "USD",
            "Balance": 0,
            "BalanceAvailable": 0,
            "FormattedBalance": "0,00",
            "FormattedAvailableBalance": "0,00",
            "AccountType": "GroupFirmAccount",
            "AccountTypeName": "Vadesiz",
            "GroupFirmName": "TEDARİKÇİ 4 YP BTS KARMA",
            "AccountName": ""
        }
    ],
    "IsProhibited": false,
    "ErrorCode": null,
    "DialogBoxes": [],
    "IsConfirmationRequired": false
 }
}