8. Dondur
Bir kaydı geçici olarak dondurmak ve işlem yapılmasını engellemek amacıyla bu servis aracılığıyla bilgi gönderilmelidir.
Last updated
Bir kaydı geçici olarak dondurmak ve işlem yapılmasını engellemek amacıyla bu servis aracılığıyla bilgi gönderilmelidir.
POST {{WalletUrl}}/api/v1/wallet/freeze
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 üzerinden yapılan her istekte kullanılan doğrulama anahtarıdır.
apiclientpublic
string
Evet
API'yi kullanan istemcinin kimliğini doğrulamak için gönderilen açık anahtardır.
Id
Guid
Evet
Dondurulacak cüzdanın benzersiz tanımlayıcısı (
FrozenUntil
Date
Hayır
Cüzdanın hangi tarihe kadar dondurulacağını belirtir. null gönderilirse cüzdan süresiz olarak dondurulur.
Servise gönderilecek örnek bir JSON dosyası şu şekildedir :
{
"Id": "{{walletId}}",
"FrozenUntil": null
}Servisten dönen parametreler şu şekildedir:
IsFailure
bool
Servis çağrısının başarısız olup olmadığını belirten boolean türünde veri alanıdır.
IsSuccess
bool
İşlemin başarılı şekilde tamamlanıp tamamlanmadığını gösteren değerdir.
Errors
Array
Serviste oluşan hata kayıtlarının detaylı olarak listelendiği dizi yapısıdır.
Value
Array<Items>
İstek sonucunda dönen veri nesnelerinin bir arada bulunduğu liste alanıdır.
Id
Guid
Sistemdeki varlıkların benzersiz kimlik numarasını temsil eder.
Alias
string
Cüzdana verilen alternatif tanımlayıcı kısa isimdir.
Last updated
{
"IsSuccess": true,
"IsFailure": false,
"Value": {
"Id": "e75df134-185a-4b2b-b501-719dba2129c4",
"Alias": "5746347646"
}
}