6. Dondur

Bir kaydı geçici olarak dondurmak ve işlem yapılmasını engellemek amacıyla bu servis aracılığıyla bilgi gönderilmelidir.

Kayıt Üzerinde Dondurma İşlemi Uygulamak için Bilgi Gönder

POST {{WalletUrl}}/api/v1/wallet/freeze

Not: Bu servisin kullanılabilmesi için apikeypublic ve apiclientpublic parametrelerinin Header alanına eklenmiş olması zorunludur.

WalletAPI Adresi

Servise gönderilmesi gereken parametreler şu şekildedir:

Parametre
Tip
Zorunlu
Açıklama

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": "{{walletId}}",
  "FrozenUntil": null
}

Servis İstek

Parametre
Tip
Açıklama

Id

Guid

Dondurulacak cüzdan hesabının kimlik bilgisi

FrozenUntil

DateTime?

Boş geçildiğinde, ilgili hesabın dondurulması sizin tarafınızdan kaldırılana kadar hesap kullanılamaz. Eğer spesifik bir tarih verilirse de ilgili hesap verilen tarih/saate bilgisine kadar donuk kalır, sonrasında otomatik kullanılabilir hale gelir

{
    "Value": {
        "Id": "30bac1c0-ad6b-4c50-a52e-1b34f9b487a7",
        "WalletOwnerId": "b5708099-be62-4d34-af06-27132082eb78",
        "Name": "juzdan1",
        "Alias": "8203287943",
        "MerchantId": 2071,
        "RegionId": 1,
        "CurrencyCode": "TRY",
        "Balance": 1.00,
        "AvailableBalance": 1.00,
        "TotalGiftBalance": 0,
        "BlockedBalance": 0,
        "FrozenUntil": "2026-03-24T20:26:25.426Z",
        "IsFrozen": true,
        "IsDeleted": false,
        "CreatedAt": "2025-04-24T09:05:47.980805Z",
        "UpdatedAt": "2025-04-25T12:20:29.7070288Z",
        "TransactionId": null
    },
    "Errors": [],
    "IsSuccess": true,
    "IsFailure": false
}

Servis Cevap

Parametre
Tip
Açıklama

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.

Servis Cevap (Value)

Parametre
Tip
Açıklama

Id

Guid

Sistemdeki varlıkların benzersiz kimlik numarasını temsil eder.

WalletOwnerId

Guid

Cüzdan sahibine özel atanmış benzersiz kimlik değeridir.

Name

string

Cüzdan sahibinin adı veya kayıtlı şirket ismini ifade eder.

Alias

string

Cüzdana verilen alternatif tanımlayıcı kısa isimdir.

MerchantId

Guid

Cüzdan sahibinin bağlı bulunduğu üye iş yerinin kimliğidir.

RegionId

string

Cüzdan sahibinin kayıtlı olduğu bölgenin temsil kodudur.

CurrencyCode

string

Cüzdan işlemlerinde kullanılan para biriminin ISO kodudur.

Balance

decimal

Cüzdanda mevcut bulunan toplam bakiye miktarıdır.

AvailableBalance

decimal

Anlık olarak harcamaya uygun serbest bakiye bilgisidir.

TotalGiftBalance

decimal

Cüzdanda yer alan toplam hediye bakiyesi miktarını belirtir.

BlockedBalance

decimal

Kullanımı kısıtlanmış, bloke altında tutulan bakiye miktarıdır.

FrozenUntil

DateTime

Cüzdanın kullanımına izin verilmeyen tarihe kadar geçerli dondurma süresi bilgisidir.

IsFrozen

bool

Cüzdanın dondurulmuş (geçici olarak kullanılamaz) durumda olup olmadığını gösterir.

IsDeleted

bool

Cüzdan kaydının sistemden silinmiş olup olmadığını belirten kontrol alanıdır.

CreatedAt

DateTime

Kaydın ilk oluşturulduğu tarih ve zaman damgasıdır.

UpdatedAt

DateTime

Kaydın sistem üzerinde en son güncellendiği zaman bilgisidir.

TransactionId

Guid

İşlem kaydının sistemdeki benzersiz kimlik numarasıdır.

Last updated