8. Deposit (Wallet)

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

Deposit Money with Wallet 'Id' Information

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

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 to grant access permission in API requests.
apiclientpublic	string	Yes	It is the public identity key sent with each request to authenticate the client's identity.

Service Request - JSON

{
  "Id": "{{walletId}}",
  "Amount": 1,
  "Description": "description",
  "ExternalReference": "123321-123321-123321-123321"
}

Service Request

Parameter	Type	Description
Id	Guid	The identity information of the wallet to which the money is to be deposited.
Amount	decimal	The amount to be deposited.
Description	string	The description of the related transaction.
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": "Wilson",
        "Alias": "8203287943",
        "MerchantId": 2071,
        "RegionId": 1,
        "CurrencyCode": "TRY",
        "Balance": 1.00,
        "AvailableBalance": 1.00,
        "TotalGiftBalance": 0,
        "BlockedBalance": 0,
        "FrozenUntil": "0001-01-01T00:00:00",
        "IsFrozen": false,
        "IsDeleted": false,
        "CreatedAt": "2025-04-24T09:05:47.980805Z",
        "UpdatedAt": "2025-04-24T09:06:47.2169324Z",
        "TransactionId": "a7b97d5c-d4ed-447b-ac01-1192839e3124"
    },
    "Errors": [],
    "IsSuccess": true,
    "IsFailure": false
}

Service Response

Parameter	Type	Description
IsFailure	bool	It is the control field that determines whether the performed operation resulted in an error or not.
IsSuccess	bool	It is the flag field that indicates whether the relevant service was successfully completed.
Errors	Array	It is the data list containing the error details encountered during the request.
Value	Array<Items>	It refers to the area where the data objects returned by the service are collectively stored.

Service Response (Value)

Parameter	Type	Description
Id	Guid	It is the unique identifier automatically generated for each record in the system.
WalletOwnerId	Guid	It is the unique identification number assigned to the wallet owner within the system.
Name	string	It is the textual expression representing the wallet owner's name or the organization’s name.
Alias	string	It is the alternative name or short description assigned to the wallet.
MerchantId	Guid	It is the unique identifier number that represents the merchant.
RegionId	string	It is the code representing the geographic region where the wallet owner is registered.
CurrencyCode	string	It is the short code of the currency used in transactions (e.g., TRY, USD).
Balance	decimal	It is the total monetary balance held by the wallet.
AvailableBalance	decimal	It is the amount of available free balance for immediate use.
TotalGiftBalance	decimal	It shows the total gift balance accumulated in the wallet.
BlockedBalance	decimal	It is the blocked balance information that is restricted from use.
FrozenUntil	DateTime	It shows the date when the wallet is suspended and when it will be reopened.
IsFrozen	bool	It indicates whether the wallet is in a frozen (inactive) state.
IsDeleted	bool	It is the field that indicates whether the related record has been marked as deleted in the system.
CreatedAt	DateTime	It is the date when the record was first created in the system.
UpdatedAt	DateTime	It contains the date and time when the record was last edited.
TransactionId	Guid	It is the unique identifier of the related transaction movement.