Account Balance Inquiry

URL

Endpoint and http method information that query the sum of balances in the user's accounts are given.

If there is one or more of them within the Account Balance Query end point, how much balance is in the sum of the balances in the accounts is shown.

HTTP Method URL
POST /v1/Account/AccountBalanceInquiry

Request Params

Params Type Mandatory
account_number string Yes

Response Params

Params Type
status int
code string
message string
payload object
account_number string
currencies Object[]
type string
available_cash_balance decimal
available_payment_balance decimal
unavailable_cash_balance decimal
unavailable_payment_balance decimal
total_balance decimal
loyality Object[]
type string
available_cash_balance decimal
available_payment_balance decimal
unavailable_cash_balance decimal
unavailable_payment_balance decimal
total_balance decimal

REQUEST (POST) :

{
  "account_number": "51111134567",
}

SUCCESS RESPONSE :

{
    "status": 0,
    "code": null,
    "message": null,
    "payload": {
        "account_number": "51111134567",
        "currencies": [
            {
                "type": "TRY",
                "available_cash_balance": 100.0000,
                "available_payment_balance": 0.0000,
                "unavailable_cash_balance": 0.0000,
                "unavailable_payment_balance": 0.0000,
                "total_balance": 100.0000
            },
            {
                "type": "USD",
                "available_cash_balance": 100.0000,
                "available_payment_balance":100.0000,
                "unavailable_cash_balance": 0.0000,
                "unavailable_payment_balance": 0.0000,
                "total_balance": 200.0000
            }

        ],
        "loyality": [
            {
                "type": "TRY",
                "available_cash_balance": 0.0000,
                "available_payment_balance": 900.0000,
                "unavailable_cash_balance": 0.0000,
                "unavailable_payment_balance": 0.0000,
                "total_balance": 900.0000
            }
        ]
    }
}

Fail Response:

{
    "status": 2,
    "code": "300",
    "message": "The wallet for the number you entered could not be found. Please check and try again.",
    "payload": null
}