12. Withdrawal (Alias)

Information must be sent through this service to initiate a withdrawal from an account using the specified Alias and to process the withdrawn amount.

Deposit with Wallet 'Alias' Information

POST {{WalletUrl}}/api/v1/wallet/withdraw/by/alias

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 are as follows:

Parameter	Type	Compulsory	Description
apikeypublic	string	Yes	It is the general key information used to verify API access.
apiclientpublic	string	Yes	It is the key information that identifies the client and provides authentication during the service call.

Service Reguest - JSON

{
  "Alias": "2816220769",
  "Amount": 0.1,
  "Description": "{{$randomJobDescriptor}}",
  "ExternalReference": "{{$guid}}"
}

Service Request

Parameter	Type	Description
Amount	decimal	The amount to be withdrawn.
Description	string	The description of the relevant transaction.
Alias	string	The account number assigned to the Wallet (1234567890).
ExternalReference	string	The transaction tracking number. You can use this information to track the transaction.

Service Reguest - JSON

{
    "IsSuccess": true,
    "IsFailure": false,
    "Value": {
        "Id": "86d1ed9e-9e61-4c8e-96db-4f06030ea19d",
        "Alias": "2816220769",
        "WalletId": "7883fb19-2359-4a9b-b917-f08a259898ed",
        "TransactionType": "Withdrawal",
        "Amount": 0.1,
        "GiftAmount": null,
        "Description": "Regional",
        "ExternalReference": "0f84e841-847f-426a-b02f-20cc93e2d667",
        "CreatedAt": "2025-08-20T10:13:13.9375891Z",
        "UpdatedAt": null,
        "BalanceAfterTransaction": 2.90,
        "GiftBalanceId": null,
        "UniqueCode": "23fea619-eaae-4a5a-8740-458d989edd47",
        "CashbackAmount": 0
    }
}

Service Response

Parameter	Type	Description
IsFailure	bool	Indicates whether an error occurred during the transaction.
IsSuccess	bool	Indicates that the service has been successfully completed.
Errors	Array	A list containing the error details encountered during the transaction.
Value	Array<Items>	Contains the main data set returned from the service.

Service Response (Value)

Parameter	Type	Description
Id	Guid	It is the unique identifier generated by the system for the record.
WalletOwnerId	Guid	It is the unique identifier of the relevant wallet owner.
Name	string	It is the name information of the wallet owner.
Alias	string	It is the alias information representing the wallet.
RegionId	string	It is the code of the region where the wallet owner is located.
CurrencyCode	string	It is the currency code used by the wallet for transactions.
Balance	decimal	It is the total balance amount in the wallet.
AvailableBalance	decimal	It is the available, spendable balance information.
TotalGiftBalance	decimal	It shows the total gift balance amount in the wallet.
BlockedBalance	decimal	It is the blocked, unusable balance amount.
FrozenUntil	DateTime	It is the end date until which the wallet will remain frozen.
IsFrozen	bool	It indicates whether the wallet is frozen or not.
IsDeleted	bool	It indicates whether the record has been deleted.
CreatedAt	DateTime	It is the timestamp of record creation.
UpdatedAt	DateTime	It is the timestamp of the last update made on the record.
TransactionId	Guid	It is the unique identifier number of the transaction.