4. Toplu İptal

Toplu iptal servisi, yine toplu olarak başlatılan tüm ödemelerin iptali için kullanılır. Bu servis ile başlattığınız toplu ödeme kapsamındaki tüm ödeleri iptal edebilirsiniz.

Toplu İptal Servisi

POST {{Base Adres}}/api/paywall/payment/bulk/payment/cancel

Önemli: Toplu iptal servisini kullanabilmeniz için Header alanında apikeypublic ve apiclientpublic parametrelerini göndermeniz gerekmektedir.

PaymentAPI Adresi

İptal işlemleri, ödemelerin gerçekleştiği aynı gün içerisinde gönderilmesi gereken işlemlerdir. Gün sonu alındıktan sonra ilgili işlemlerin kredi kartlarına sorunsuz geri gönderilebilmesi için iptal değil iade servislerinin kullanılması endüstriyel standarttır

Toplu ödemeler kapsamında gerçekleşen işlemleri, tek tek iptal edebilirsiniz. Bunun için iptal servisini kullanmalısınız.

Servise gönderilmesi gereken parametreler şu şekildedir:

Parametre
Tip
Zorunlu
Açıklama

apikeypublic

string

Evet

Üye işyeri panelinden temin etmiş olduğunuz Public Key.

apiclientpublic

string

Evet

Üye işyeri panelinden temin etmiş olduğunuz Public Client.

İptal Detayları:

Parametre
Tip
Zorunlu
Açıklama

Date

DateTime

Evet

İptal etmek istediğiniz toplu ödemenin gerçekleştirildiği tarih bilgisi

MerchantUniqueCode

string

Evet

Toplu ödeme anında verdiğiniz takip numaranız

Servise gönderilecek örnek JSON ve örnek kodlar aşağıdaki gibidir:

{
    "Date": "2024-12-12",
    "MerchantUniqueCode": "8279c96e-2775-4ecf-b594-3cb8fb265f88"
}

Servisten Dönen Parametreler

Parametre
Tip
Açıklama

ErrorCode

int

Hata kodu. İşlem başarılı ise '0' değerini döner.

Result

bool

İşlem başarılı ise true, hatalı ise false döner.

Message

string

İşlemle ilgili bilgi veya hata mesajını içerir.

Body > Result

bool

İşlemin başarıyla teslim alınıp alınamadığını ifade eder. True olması durumda Paywall talebi başarıyla almış ve kuyruk mekanizmasına konumlandırmış demektir. Sonuçlar geri bildirim olarak iletilecektir

Body > TotalPaymentCount

int

Toplam işlem

Servisten Dönen Örnek JSON

{
    "ErrorCodeType": 1,
    "ErrorMessage": null,
    "ErrorCode": 0,
    "Result": true,
    "Message": "Bulk payment created and enqueued",
    "Body": {
        "Result": true,
        "BulkPaymentId": 389,
        "TotalPaymentCount": 6
    }
}

Last updated