1. Oluştur (Wallet)
Cüzdanlara hediye bakiye tanımlamak için bu servisi kullanabilirsiniz
Cüzdan 'Id' ile Hediye Bakiye Oluştur
POST{{WalletUrl}}/api/v1/balance/gift
Not: Bu servisin kullanılabilmesi için apikeypublic ve apiclientpublic parametrelerinin Header alanına eklenmiş olması zorunludur.
Gerekli header ve istek parametreleri:
Zorunlu header 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.
İstek gövdesi parametreleri
WalletId
Guid
Evet
Hediye bakiyenin tanımlanacağı cüzdan kimlik bilgisi
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.
İş Kuralları
ExternalReferenceaynı Merchant kapsamında benzersiz olmalıdır.Bir cüzdana en fazla 100 adet hediye bakiye tanımlanabilir. Bu limit aşıldığında yeni kayıt oluşturulamaz.
Son kullanma tarihi belirtilmeden oluşturulan hediye bakiyeler süresiz kabul edilir. Dönüş modelinde
ExpirationDatealanı boş,IsUnlimitedalanıtrueolarak döner.Hediye bakiye başarıyla oluşturulduğunda sistem tarafından otomatik olarak
GiftBalanceAddedtipinde bir işlem kaydı oluşturulur veExternalReferencebu kayıtla ilişkilendirilir.
Servise gönderilecek örnek bir JSON dosyası şu şekildedir :
Servisten dönen parametreler şu şekildedir:
Parametreler ve açıklamaları
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
Kaydın oluşturulma tarihidir (muhtemelen veri tipi DateTime olmalıdır).
UpdatedAt
int
Kaydın en son ne zaman güncellendiğini gösteren UNIX zaman damgasıdır.
Last updated