2. İptal (Liste)

Toplu iptal servisi, liste halinde iletilen ödemelerinizi tek bir API çağrısıyla teslim alır ve sonucu size tek bir seferde geri bildirim (callback) ile döner.

İptal (Liste) Servisi

POST {{Base Adres}}/api/paywall/payment/bulk/batch/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
Payments	Array<Payment>	Evet	İptal edilecek ödemelerin bilgisinin yer aldığı liste
CallbackUrl	string	Evet	Toplu iptal işlemi sonrasında bilgi gönderilecek API adresinizin bilgisi

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

JSON

{
    "Payments": [
        {
            "MerchantUniqueCode": "PWL-010101010101",
            "Date": "2025-01-01"
        },
        {
            "MerchantUniqueCode": "PWL-010101010102",
            "Date": "2025-01-01"
        },
        {
            "MerchantUniqueCode": "PWL-010101010103",
            "Date": "2025-01-01"
        },
        {
            "MerchantUniqueCode": "PWL-010101010104",
            "Date": "2025-01-01"
        },
        {
            "MerchantUniqueCode": "PWL-010101010105",
            "Date": "2025-01-01"
        },
        {
            "MerchantUniqueCode": "PWL-010101010106",
            "Date": "2025-01-01"
        },
        {
            "MerchantUniqueCode": "PWL-010101010107",
            "Date": "2025-01-01"
        },
        {
            "MerchantUniqueCode": "PWL-010101010108",
            "Date": "2025-01-01"
        },
        {
            "MerchantUniqueCode": "PWL-010101010109",
            "Date": "2025-01-01"
        },
        {
            "MerchantUniqueCode": "PWL-010101010110",
            "Date": "2025-01-01"
        },
        {
            "MerchantUniqueCode": "PWL-010101010111",
            "Date": "2025-01-01"
        },
        {
            "MerchantUniqueCode": "PWL-010101010112",
            "Date": "2025-01-01"
        },
        {
            "MerchantUniqueCode": "PWL-010101010113",
            "Date": "2025-01-01"
        },
        {
            "MerchantUniqueCode": "PWL-010101010114",
            "Date": "2025-01-01"
        },
        {
            "MerchantUniqueCode": "PWL-010101010115",
            "Date": "2025-01-01"
        },
        {
            "MerchantUniqueCode": "PWL-010101010116",
            "Date": "2025-01-01"
        },
        {
            "MerchantUniqueCode": "PWL-010101010117",
            "Date": "2025-01-01"
        },
        {
            "MerchantUniqueCode": "PWL-010101010118",
            "Date": "2025-01-01"
        },
        {
            "MerchantUniqueCode": "PWL-010101010119",
            "Date": "2025-01-01"
        },
    ],
    "CallbackUrl": "https://yourwebsite.com/paywall/callback"
}

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

JSON

{
    "ErrorCodeType": 1,
    "ErrorMessage": null,
    "ErrorCode": 0,
    "Result": true,
    "Message": "Batch cancel created and enqueued",
    "Body": {
        "Result": true,
        "PaymentResults": [
            {
                "MerchantUniqueCode": "MCB1M36H3VLUO717FN7Y2ZE3EBN313DXG4OLXSLLDED7T",
                "Status": 1,
                "Message": "Added to normal bulk cancel process",
                "BulkPaymentId": 2683,
                "ErrorMessage": null,
                "BulkPaymentJobId": 0
            },
            {
                "MerchantUniqueCode": "MCB1M36H3VLUO717FN7Y2ZE3E2O5EFKX7L2ZG5WA52HB7",
                "Status": 1,
                "Message": "Added to normal bulk cancel process",
                "BulkPaymentId": 2683,
                "ErrorMessage": null,
                "BulkPaymentJobId": 0
            },
            {
                "MerchantUniqueCode": "MCB1M36H3VLUO717FN7Y2ZE3ETRUS2O6UQ9F5YPU2BDSA",
                "Status": 1,
                "Message": "Added to normal bulk cancel process",
                "BulkPaymentId": 2683,
                "ErrorMessage": null,
                "BulkPaymentJobId": 0
            },
            {
                "MerchantUniqueCode": "MCB1M36H3VLUO717FN7Y2ZE3E32PUM7BB2FCTH1B13C3G",
                "Status": 1,
                "Message": "Added to normal bulk cancel process",
                "BulkPaymentId": 2683,
                "ErrorMessage": null,
                "BulkPaymentJobId": 0
            }
        ]
    }
}