5. Oluştur
Sisteme yeni bir veri eklemek için bu servis çağrılmalıdır.
Cüzdan Oluştur
POST {{WalletUrl}}/api/v1/wallet
Not: Servis çağrısından önce apikeypublic ve apiclientpublic bilgilerinin Header alanına eklenmiş olması şarttır.
Gerekli header ve istek parametreleri:
Zorunlu header parametreleri
apikeypublic
string
Evet
API isteklerinde kimlik doğrulaması için kullanılan genel erişim anahtarıdır.
apiclientpublic
string
Evet
API'yi çağıran istemcinin kimliğini belirten açık anahtar değeridir.
İstek gövdesi parametreleri
WalletOwnerId
Guid
Evet
Cüzdan sahibinin kimlik bilgisi
Name
string
Evet
Cüzdan hesabına verilecek olan isim
Alias
string
Hayır
Tekil cüzdan numarası
AllowOverdraft
bool
Hayır
Cüzdanın eksi bakiyeye düşmesine izin verilip verilmediğini belirtir.true ise bakiye sıfırın altına inebilir.
OverdraftLimit
decimal
Hayır
Cüzdanın düşebileceği maksimum eksi bakiye limitini belirtir.AllowOverdraft = true olduğunda geçerlidir.
İş Kuralları
WalletOwnerIdalanında belirtilen cüzdan sahibi, ilgili Merchant altında aktif olarak kayıtlı olmalıdır. Silinmiş veya pasif durumdaki bir cüzdan sahibi ile cüzdan oluşturulamaz.Aliasdeğeri aynı Merchant altında benzersiz olmalıdır. Başka bir cüzdanda kullanılmış bir alias ile yeni cüzdan oluşturulamaz.CurrencyCodealanında gönderilen para birimi kodu, sistemde tanımlı ve aktif olarak desteklenen bir para birimine karşılık gelmelidir.Aynı
WalletOwnerId,RegionIdveCurrencyCodekombinasyonu için en fazla 5 cüzdan oluşturulabilir. Bu limit aşıldığında yeni cüzdan oluşturulmasına izin verilmez.
Servise gönderilecek örnek bir JSON dosyası şu şekildedir :
Servisten dönen parametreler şu şekildedir:
Parametreler ve açıklamaları
IsFailure
bool
Yapılan işlemin başarısızlıkla sonuçlanıp sonuçlanmadığını belirten bilgi alanıdır.
IsSuccess
bool
API çağrısının başarılı tamamlanıp tamamlanmadığını ifade eder.
Errors
Array
Servis sırasında karşılaşılan hata kayıtlarının listelendiği veri alanıdır.
Value
Array<Items>
API yanıtı içerisinde dönen ana veri nesnesini temsil eder.
Value > Id
Guid
İlgili kaydın sistemdeki benzersiz kimlik numarasıdır.
Value > WalletOwnerId
Guid
Cüzdan sahibine ait olan eşsiz kimlik numarasıdır.
Value > Name
string
Cüzdan sahibinin ad veya unvan bilgisidir.
Value > Alias
string
Cüzdana tanımlanan takma ad veya kısa isim bilgisidir.
Value > RegionId
string
Cüzdan sahibinin ilişkilendirildiği coğrafi bölge kimlik numarasıdır.
Value > CurrencyCode
string
Cüzdanın bağlı olduğu para biriminin kod bilgisidir (örneğin: TRY, USD).
Value > Balance
decimal
Cüzdanın toplam bakiyesini gösteren finansal değerdir.
Value > AvailableBalance
decimal
İşlem yapmaya uygun olan kullanılabilir bakiye bilgisidir.
Value > TotalGiftBalance
decimal
Cüzdanda yer alan toplam hediye bakiyesi miktarıdır.
Value > BlockedBalance
decimal
Kullanımı kısıtlanmış olan bloke bakiye miktarıdır.
Value >CreatedAt
DateTime
Kaydın oluşturulduğu tarih ve zaman damgasıdır.
Value > AllowOverdraft
bool
Cüzdanın eksi bakiyeye düşmesine izin verilip verilmediğini belirtir.true ise bakiye sıfırın altına inebilir.
Value > OverdraftLimit
decimal
Cüzdanın düşebileceği maksimum eksi bakiye limitini belirtir.AllowOverdraft = true olduğunda geçerlidir.
Last updated