10. Withdrawal (Wallet)

Information must be sent through this service to withdraw money from an account using the specified alias and to process the withdrawn amount.

Withdraw Money with Wallet 'Id' Information

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

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

WalletAPI Address

Parameters required to be sent to the service are as follows:

Parameter	Type	Required	Description
apikeypublic	string	Yes	The general key information required to provide access to the API.
apiclientpublic	string	Yes	The general key information used to represent the client identity in API requests.

Service Request - JSON

{
  "Id": "{{walletId}}",
  "Amount": 1,
  "Description": "description",
  "ExternalReference": "{{$randomFullName}}"
}

Service Request

Parameter	Type	Description
Id	Guid	The identity information of the wallet from which the withdrawal is requested.
Amount	decimal	The amount to be deposited.
Description	string	The description of the relevant transaction.
ExternalReference	string	The transaction tracking number. You can use this information to track the transaction.

Service Request - JSON

{
    "Value": {
        "Id": "30bac1c0-ad6b-4c50-a52e-1b34f9b487a7",
        "WalletOwnerId": "b5708099-be62-4d34-af06-27132082eb78",
        "Name": "juzdan1",
        "Alias": "8203287943",
        "MerchantId": 2071,
        "RegionId": 1,
        "CurrencyCode": "TRY",
        "Balance": 1.00,
        "AvailableBalance": 1.00,
        "TotalGiftBalance": 0,
        "BlockedBalance": 0,
        "FrozenUntil": null,
        "IsFrozen": false,
        "IsDeleted": false,
        "CreatedAt": "2025-04-24T09:05:47.980805Z",
        "UpdatedAt": "2025-04-26T11:43:06.8473455Z",
        "TransactionId": "f08830f2-ad38-41fd-8b43-b4a8036def44"
    },
    "Errors": [],
    "IsSuccess": true,
    "IsFailure": false
}

Service Response

Parameter	Type	Description
IsFailure	bool	It is the status information indicating whether the service has encountered an error.
IsSuccess	bool	It indicates whether the service has completed successfully.
Errors	Array	The list of error messages returned by the service.
Value	Array<Items>	The data set resulting from the request.

Service Response (Value)

Parameter	Type	Description
Id	Guid	It is the unique identifier of the recorded transaction.
WalletOwnerId	Guid	It is the system ID number of the wallet owner related to the transaction.
Name	string	It is the registered name information of the user or business.
Alias	string	It is the alternative nickname defined for the wallet.
MerchantId	Guid	It is the unique ID of the member business that performed the transaction.
RegionId	string	It is the region information associated with the transaction or user.
CurrencyCode	string	It is the code information of the currency used (e.g., TRY, USD).
Balance	decimal	It is the total balance information available in the wallet.
AvailableBalance	decimal	It is the amount of balance available for transactions.
TotalGiftBalance	decimal	It is the total balance including the gift balance.
BlockedBalance	decimal	It is the balance amount restricted for use.
FrozenUntil	DateTime	It is the date information indicating when the wallet is frozen and when it will be reactivated.
IsFrozen	bool	It indicates whether the wallet is active or frozen.
IsDeleted	bool	It shows whether the relevant record has been deleted from the system.
CreatedAt	DateTime	It is the date and time information when the record was created.
UpdatedAt	DateTime	It is the date information when the last update of the record was performed.
TransactionId	Guid	It is the unique transaction identifier related to the performed transaction.