1.Cancellation (Batch)

The batch cancellation service is used to cancel all payments initiated as a batch. With this service, you can cancel all payments within the batch payment you started.

Batch Cancellation Service

POST {{Base Adres}}/api/paywall/payment/bulk/payment/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
Date	DateTime	Yes	The date on which the batch payment you want to cancel was made.
MerchantUniqueCode	string	Yes	The tracking number you provided at the time of the batch payment.

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

JSON

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

Parameters Returned from the Service

Parameter	Type	Description
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": "Bulk payment created and enqueued",
    "Body": {
        "Result": true,
        "BulkPaymentId": 389,
        "TotalPaymentCount": 6
    }
}