22. Transaction Check (Alias)

You can use this service to check if the relevant wallet is suitable for the transaction you want to perform. This service performs balance checks and determines whether the wallet is eligible for the

Transaction Check with Wallet 'Alias'

GET{{WalletUrl}}/api/v1/wallet/check-payment-availability/by/alias?Alias=1234567890&Amount=980

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	Required	Description
apikeypublic	string	Yes	It is the public key sent to the service to identify the user.
apiclientpublic	string	Yes	It is the general client key used to identify the service client.

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

Parameter	Description
Alias	The wallet number for which the sales eligibility check will be performed.
Amount	The amount planned for the sale.

Service Reguest - JSON

{
    "Value": {
        "IsAvailable": true,
        "ReasonIfUnavailable": null,
        "MaxAvailableAmount": 6993.00,
        "WalletBalance": 6993.00,
        "GiftBalance": 0,
        "BlockedBalance": 0,
        "AvailableBalance": 6993.00
    },
    "Errors": [],
    "IsSuccess": true,
    "IsFailure": false
}

Service Response

Parameter	Type	Description
IsFailure	bool	It returns true if the transaction failed, and false if it was successful.
IsSuccess	bool	It returns true if the transaction was successful, and false if it failed.
Errors	Array	It is the list of error messages encountered during the service call.
Value	Array<Items>	It is the main data set returned as a result of the transaction (it will be populated in a successful response).

Service Response (Value)

Parameter	Type	Description
IsAvailable	Boolean	It is a boolean value that indicates whether the transaction is active or not.
ReasonIfUnavailable	String	It is the text information explaining the reason if the transaction is inactive.
MaxAvailableAmount	String	It returns the maximum amount that can be used in the transaction as a string.
WalletBalance	Decimal	The total balance in the wallet, used directly in financial calculations.
GiftBalance	Decimal	It is the available gift (bonus) balance information.
BlockedBalance	String	It is the blocked amount, stored in string format for the transaction.
AvailableBalance	String	The instant available balance should be converted into a numerical value before the transaction.