17. Check Balance (Alias)

You can query the balance of a specific wallet using this service.

Check Balance with Wallet 'Alias'

GET{{WalletUrl}}/api/v1/wallet/balances/by/alias?alias=1234567890

Note: To use this service, it is mandatory to include the apikeypublic and apiclientpublic parameters in the Header field.

WalletAPI Address

The parameters that need to be sent to the service (Headers) are as follows:

Parameter	Type	Compulsory	Description
apikeypublic	string	Yes	The general key used for API calls.
apiclientpublic	string	Yes	The general key that defines the API client information.

Service Reguest - JSON

{
    "IsSuccess": true,
    "IsFailure": false,
    "Value": {
        "Id": "2ea244d1-6ed2-4eca-a84b-273c62f64606",
        "Name": "External Test Wallet",
        "Alias": "8460440228",
        "WalletBalance": 2.00,
        "GiftBalances": [],
        "TotalGiftBalance": 0,
        "BlockedBalance": 0,
        "TotalBalance": 2.00,
        "AvailableBalance": 2.00,
        "AllowOverdraft": false,
        "OverdraftLimit": 0
    }
}

Service Response

Parameter	Type	Desciption
IsFailure	bool	Indicates whether there was an error in the transaction (true/false).
IsSuccess	bool	Indicates whether the transaction was successful (true/false).
Errors	Array	Contains the error details encountered during the transaction.
Value	Array<Items>	Contains the main data list returned as a result of the transaction.

Service Response (Value)

Parameter	Type	Desciption
Id	Guid	It is the unique identifier of the wallet.
Name	String	It is the name information of the wallet owner.
Alias	String	It is the alias information defined for the wallet.
WalletBalance	Decimal	It returns the total balance in the wallet. * Does not include GiftBalance.
GiftBalances	List	It returns the list of gift balances assigned to the wallet.
TotalGiftBalance	Decimal	It returns the total gift balance in the wallet.
BlockedBalance	Decimal	It returns the unavailable (blocked) balance.
TotalBalance	Decimal	Total balance in the wallet Formula: WalletBalance + TotalGiftBalance
AvailableBalance	Decimal	The available balance in the wallet. This balance includes gift balances. Additionally, if there is a blocked balance, the available balance is reduced by the blocked balance amount. Formula: (WalletBalance + TotalGiftBalance) - BlockedBalance