16. Check Balance (Wallet)

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

Check Balance with Wallet 'Id'

GET{{WalletUrl}}/api/v1/wallet/balances?Id=0000-0000-0000-0000-0000

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	It is the general key information used for API access.
apiclientpublic	string	Yes	It is the information that identifies the client connecting to the API.

Service Reguest - JSON

{
    "IsSuccess": true,
    "IsFailure": false,
    "Value": {
        "Id": "7883fb19-2359-4a9b-b917-f08a259898ed",
        "Name": "External Test Wallet",
        "Alias": "2816220769",
        "WalletBalance": 0.80,
        "GiftBalances": [],
        "TotalGiftBalance": 0,
        "BlockedBalance": 0,
        "TotalBalance": 0.80,
        "AvailableBalance": 0.80,
        "AllowOverdraft": false,
        "OverdraftLimit": 0
    }
}

Service Response

Parameter	Type	Description
IsFailure	bool	Indicates whether the transaction has failed.
IsSuccess	bool	Indicates whether the transaction was successful.
Errors	Array	Lists the error information that occurred during the transaction.
Value	Array<Items>	It is the list of data returned as a result of the transaction.

Service Response (Value)

Parameter	Type	Description
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