2. Oluştur (Alias)
Cüzdanlara hediye bakiye tanımlamak için bu servisi kullanabilirsiniz
Last updated
Cüzdanlara hediye bakiye tanımlamak için bu servisi kullanabilirsiniz
POST{{WalletUrl}}/api/v1/balance/gift/by/wallet/alias
Not: Bu servisin kullanılabilmesi için apikeypublic ve apiclientpublic parametrelerinin Header alanına eklenmiş olması zorunludur.
Gerekli header ve istek parametreleri:
apikeypublic
string
Evet
API servislerine genel erişimi sağlayan ortak anahtar bilgisidir.
apiclientpublic
string
Evet
İstemci uygulamayı tanımlayan açık istemci anahtar bilgisidir.
Alias
string
Evet
Hediye bakiyenin ekleneceği cüzdanın alias'ı.
Amount
decimal
Evet
Tanımlanacak hediye bakiye
ExternalReference
string
Evet
İşlemin sisteminiz tarafından takip edilebilmesi için takip numarası
ExpirationDate
DateTime?
Hayır
Eğer ilgili hediye bakiye belirli bir tarihe kadar geçerli olsun istiyorsanız. Tarih tanımı yapabilirsiniz. Eğer tarih verirseniz, ilgili tutar o tarihe kadar harcanmazsa otomatik olarak kullanım dışı kalır. Eğer tarih verilmezse, ilgili tutar kullanılana kadar cüzdanda tanımlı kalır
Description
string
Hayır
Verilen hediye bakiyenin açıklaması Örnek: "Doğum günü"
ExternalTransactionTypeId
integer
Hayır
Kendi sisteminizdeki bir işlem tipini bizim sistemimize ekledikten sonra size verdiğimiz id.
ExternalTransactionTypeEnum
integer
Hayır
Kendi sisteminizdeki bir işlem tipini bizim sistemimize eklerken verdiğiniz unique değer.
Servise gönderilecek örnek bir JSON dosyası şu şekildedir :
{
"Alias": "2816220769",
"Amount": 100.00,
"ExternalReference": "{{$guid}}",
"ExpirationDate": null,
"Description": "External Gift Balance",
"ExternalTransactionTypeId" :null,
"ExternalTransactionTypeEnum" :: null
}Servisten dönen parametreler şu şekildedir:
IsFailure
bool
İşlem başarısızsa false, değilse true döner.
IsSuccess
bool
İşlem başarılıysa true, aksi halde false döner.
Errors
Array
Oluşan hata detaylarını içeren dizi yapısıdır.
Value
Array
Sonuç verilerini içeren öğe listesini barındırır.
Id
Guid
Sistemde bu varlığı benzersiz şekilde tanımlayan kimliktir.
WalletId
Guid
Kaydın bağlı olduğu cüzdanın eşsiz ID bilgisidir.
Amount
string
Tanımlanan toplam bakiye bilgisini metinsel olarak tutar.
RemainingAmount
decimal
Mevcut bakiye içerisinden harcanmamış kalan kısmı ifade eder.
ExpirationDate
decimal
Bakiyenin sona ereceği tarihi timestamp formatında temsil eder.
IsUnlimited
string
Hediye bakiyenin süresiz olup olmadığını belirtir. ExpirationDate değeri null ise true döner ve hediye bakiyenin son kullanma tarihi olmadığını ifade eder.
Description
string
Bakiye veya işlemin açıklamasıdır, kullanıcıya bilgi verir.
LastTransactionId
Guid
Bu bakiyeyi kullanan son işlemin kimliğidir.
CreatedAt
Guid
Hediye bakiyenin oluşturulma tarihi
UpdatedAt
int
Hediye bakiyenin güncellenme tarihi
Last updated
{
"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
}
}