6. Cancel Provision

You can cancel pre-authorized transactions made through APM using this service.

Cancel Provision

POST {{Base Adres}}/api/paywall/apm/provision/cancel

Important: To use the APM Payment Cancel Provision service, you must include the apikeypublic and apiclientpublic parameters in the Header section. PaymentAPI Address

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

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

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

Parameter	Type	Compulsory	Description
UniqueCode	string	Yes	This is the UniqueCode parameter related to the APM payment. It is included in the response returned by the API at the time of creation.

The parameters returned by the service are as follows:

Parameter	Type	Description
ErrorCode	int	Error code. Returns a value of '0' if the operation is successful.
Result	bool	Returns a value of true or false. If the operation is successful, it returns true.
Message	string	If the operation fails, this is the error message provided. It supports language localization based on the locale parameter.
Body	object	If the operation fails, this is the detailed object describing the error.

{
    "ErrorCodeType": 1,
    "ErrorMessage": null,
    "ErrorCode": 0,
    "Result": true,
    "Message": "",
    "Body": {
        "ApmKey": "Masterpass_IFrame",
        "ApmConnectionId": 2003,
        "ApmTransactionId": 14211,
        "UniqueCode": "487f16f4-c678-40de-9b53-bd34855863e2",
        "MerchantUniqueCode": "7250512c-cbb4-41a4-9fea-374d11081075",
        "Amount": 8.00,
        "ProviderDummyResponse": {
            "ErrorCode": 0,
            "Body": {
                "acquirerRetrievalNumber": null,
                "authCode": "24564913",
                "orderId": "487f16f4c67840de9b53bd34855863e2",
                "icaNumber": null,
                "terminalGroupId": "78516638760698041272198",
                "terminalGroupName": null,
                "amount": null,
                "currencyCode": "TRY",
                "accountKey": "905437845114",
                "transactionDate": null,
                "retrievalReferenceNumber": "200007756435",
                "paymentRetrievalReferenceNumber": "200007756433",
                "pointRefundResponse": null,
                "responseCode": "00",
                "description": null,
                "ResponseDescription": null,
                "OrderStatus": null,
                "OrderDate": null
            },
            "HttpCode": 200
        }
    }
}