2. Cancellation (List)

The batch cancellation service receives your payments sent as a list with a single API call and returns the result to you in a single callback notification.

Cancellation (List) Service

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

Important: To use the batch cancellation service, you must include the parameters apikeypublic and apiclientpublic in the Header section.

PaymentAPI Address

Cancellation requests must be sent on the same day the payments occur. After the end of the day, to ensure smooth refunds to credit cards, it is industry standard to use refund services instead of cancellation services.

You can cancel individual transactions within batch payments one by one. To do this, you should use the cancellation service.

The parameters that must be sent to the service are as follows:

Parameter	Type	Compolsory	Description
apikeypublic	string	Yes	The Public Key you obtained from the merchant panel.
apiclientpublic	string	Yes	The Public Client you obtained from the merchant panel.

Cancellation Details:

Parameter	Type	Compolsory	Description
Payments	Array<Payment>	Yes	The list containing the details of the payments to be canceled.
CallbackUrl	string	Yes	The API endpoint where information will be sent after the batch cancellation process.

The sample JSON and example codes to be sent to the service are as follows:

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"
}

Parameters Returned from the Service

Parameter	Type	Compolsory
ErrorCode	int	Error code. Returns '0' if the operation is successful.
Result	bool	Returns true if the operation is successful, and false if it fails.
Message	string	Contains information or an error message related to the operation.
Body > Result	bool	Indicates whether the operation was successfully received. If true, it means Paywall has successfully received the request and placed it into the queue mechanism. Results will be delivered via callback notifications.
Body > TotalPaymentCount	int	Total transactions

Example JSON Returned from the Service

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
            }
        ]
    }
}