1. Create (Wallet)

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

Create Gift Balance with Wallet 'Id'

POST{{WalletUrl}}/api/v1/balance/gift

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 defines the client application.

Service Reguest - JSON

{
    "WalletId": "92858707-7718-435c-9ba3-3d702a3bea9b",
    "Amount": 100.00,
    "ExternalReference": "{{$guid}}",
    "ExpirationDate": "2025-11-11",
    "Description": "External Gift Balance"
}

Service Request

Parameter	Type	Description
WalletId	Guid	The identity information of the wallet 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 specify 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"

Service Reguest - JSON

{
    "IsSuccess": true,
    "IsFailure": false,
    "Value": {
        "Id": "29bddd16-16d1-4b16-bca9-906f9ef80725",
        "WalletId": "7883fb19-2359-4a9b-b917-f08a259898ed",
        "Amount": 100.00,
        "RemainingAmount": 100.00,
        "ExpirationDate": "2025-11-10T21:00:00Z",
        "IsUnlimited": false,
        "Description": "External Gift Balance",
        "LastTransactionId": null,
        "CreatedAt": "2025-08-20T14:32:16.468416Z",
        "UpdatedAt": null
    }
}

Service Response

Parameter	Type	Description
IsFailure	bool	Returns true if the operation is successful, false otherwise.
IsSuccess	bool	Returns true if the operation is successful, false otherwise.
Errors	Array	It is an array structure containing the details of the encountered errors.
Value	Array	Contains a list of items with the result data.

Service Response (Value)

Parameter	Type	Description
Id	Guid	The unique identifier that represents this entity in the system
WalletId	Guid	The unique ID of the wallet to which the record is associated
Amount	string	Stores the defined total amount as text
RemainingAmount	decimal	Represents the unused portion of the current balance
ExpirationDate	decimal	Represents the expiration date of the amount in timestamp format
IsUnlimited	string	Indicates whether the balance has unlimited validity (true/false)
Description	string	Description of the amount or transaction, providing information to the user
LastTransactionId	Guid	The ID of the last transaction that used this balance
CreatedAt	Guid	The creation date of the record (likely in DateTime format)
UpdatedAt	int	The UNIX timestamp indicating when the record was last updated