9. Deposit (Alias)

Information must be sent through this service using the specified alias to deposit money into an account and enable the deposited amount to be processed.

Deposit Money with Wallet 'Alias' Information

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

Note: In order to use this service, the apikeypublic and apiclientpublic parameters must be included in the Header section.

WalletAPI Address

The parameters that must be sent to the service are as follows:

Parameter	Type	Required	Description
apikeypublic	string	Yes	It is the public key used for authentication in API calls.
apiclientpublic	string	Yes	It is the public key representing the client's system-defined identity.

Service Request - JSON

{
  "Amount": 1,
  "Description": "description",
  "Alias": "{{alias}}",
  "ExternalReference": "123321-123321-123321-123321"
}

Service Request

Parameter	Type	Description
Amount	decimal	The amount to be deposited.
Description	string	The description of the related transaction.
Alias	string	The account number assigned to the wallet (e.g., 1234567890).
ExternalReference	string	The transaction tracking number. You can track the transaction with this information.

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": 2.00,
        "AvailableBalance": 2.00,
        "TotalGiftBalance": 0,
        "BlockedBalance": 0,
        "FrozenUntil": null,
        "IsFrozen": false,
        "IsDeleted": false,
        "CreatedAt": "2025-04-24T09:05:47.980805Z",
        "UpdatedAt": "2025-04-26T11:09:08.9994783Z",
        "TransactionId": "a2aace46-aa50-4ddb-b499-915e4b8c4e89"
    },
    "Errors": [],
    "IsSuccess": true,
    "IsFailure": false
}

Service Response

Parameter	Type	Description
IsFailure	bool	It is the status flag that indicates whether the service call resulted in an error.
IsSuccess	bool	It is the confirmation that indicates the operation was successfully completed.
Errors	Array	It is the list structure that contains the error details that may occur during the operation.
Value	Array<Items>	It is the array that collects the data objects returned in the case of a successful operation.

Service Response (Value)

Parameter	Type	Description
Id	Guid	It is the unique identifier of the entity registered in the system.
WalletOwnerId	Guid	It is the unique system identification number of the wallet owner.
Name	string	It is the name or title of the wallet user or corporate account.
Alias	string	It is the alias or alternative identifier name assigned to the wallet.
MerchantId	Guid	It is the unique identifier that represents the related merchant.
RegionId	string	It is the code representing the region to which the wallet owner is associated.
CurrencyCode	string	It is the code of the currency in which transactions in the wallet are conducted (e.g., TRY, USD).
Balance	decimal	It shows the total monetary value available in the wallet.
AvailableBalance	decimal	It is the currently available free balance.
TotalGiftBalance	decimal	It is the total gift balance value in the wallet.
BlockedBalance	decimal	It is the amount of balance subject to transaction restriction.
FrozenUntil	DateTime	It is the date information when the wallet is frozen and will be reactivated.
IsFrozen	bool	It is the information indicating whether the wallet is in a frozen status.
IsDeleted	bool	It indicates whether the relevant record is in a deleted status on the system.
CreatedAt	DateTime	It is the date and time information when the record was first created.
UpdatedAt	DateTime	It indicates the last update time of the record on the system.
TransactionId	Guid	It is the unique identifier of the performed transaction.