2. Create (Alias)

You can use this service to assign gift balances to wallets.

Create Gift Balance with Wallet 'Alias'

POST{{WalletUrl}}/api/v1/balance/gift/by/wallet/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	Compolsory	Description
apikeypublic	string	Yes	It is the shared key information that provides general access to the API services.
apiclientpublic	string	Yes	It is the public client key information that identifies the client application.

Service Reguest - JSON

{
    "Alias": "2816220769",
    "Amount": 100.00,
    "ExternalReference": "{{$guid}}",
    "ExpirationDate": null,
    "Description": "External Gift Balance"
}

Service Request

Parameter	Type	Description
Alias	string	The wallet number where the gift balance will be assigned.
Amount	decimal	The gift balance to be assigned.
ExpirationDate	DateTime?	If you want the gift balance to be valid until a specific date, you can define a date. If a date is provided, the amount will automatically become inactive if not spent by that date. If no date is provided, the amount will remain in the wallet until it is used.
Description	string	The description of the given gift balance. Example: "Birthday"
ExternalReference	string	Tracking number used by your system to track the transaction

Service Reguest - JSON

{
    "IsSuccess": true,
    "IsFailure": false,
    "Value": {
        "Id": "47c4ec69-58d2-415c-841e-c1144542181b",
        "WalletId": "7883fb19-2359-4a9b-b917-f08a259898ed",
        "Amount": 100.00,
        "RemainingAmount": 100.00,
        "ExpirationDate": null,
        "IsUnlimited": true,
        "Description": "External Gift Balance",
        "LastTransactionId": null,
        "CreatedAt": "2025-08-20T14:33:15.741943Z",
        "UpdatedAt": null
    }
}

Service Response

Parameter	Type	Description
IsFailure	bool	It returns false if the transaction failed, and true if it was successful.
IsSuccess	bool	It returns true if the transaction was successful, and false if it failed.
Errors	Array	It is an array structure containing the error details that occurred.
Value	Array	It contains a list of items that hold the result data.

Service Response (Value)

Parameter	Type	Description
Id	Guid	It is the ID assigned by the system specifically for this record.
WalletId	Guid	It is the identity number that shows which wallet it is associated with.
Amount	string	It is the total amount assigned to the user (e.g., "100.00").
RemainingAmount	decimal	It is the current balance that the user can spend.
ExpirationDate	decimal	The last date this amount is valid.
IsUnlimited	string	It indicates whether the amount is valid indefinitely.
Description	string	The purpose or explanatory note of this amount.
IsUsed	DateTime	The time when the first spending transaction took place.
IsFullyUsed	DateTime	The time when the user has used the entire amount.
IsPartiallyUsed	decimal	The amount of the used portion (e.g., 25.50).
LastTransactionId	Guid	The unique ID number associated with the last transaction.
CreatedAt	Guid	The date when this record was created (should include the date information).
UpdatedAt	int	It specifies the time when the information was last updated.