Cancel payment

Cancels a two-step payment (pg_auto_clearing = 0) before the clearing: the blocked amount is released and the client is not charged. The result is returned in the same response.

Only the full amount is cancelled, once per payment.

A captured payment (after the clearing, or a one-step payment) cannot be cancelled: return the money with refund.

Test cards: see Gateway API Overview.

Result

`pg_status`	Meaning	Next step
`ok`	The cancel is accepted: see `pg_revoke_status`.	`success`: nothing else is needed. `process`: request the status with `status_v2` until it is final.
`error`	The request is rejected or the payment system declined the cancel.	See «Errors» below.

Cancel flow

The cancel is a separate operation with its own ID: pg_payment_revoke_id in the response.

Errors

The HTTP status is always 200; the error is returned in pg_error_code and pg_error_description.

`pg_error_code`	When	What to do
`9403`	A parameter is missing or has an invalid value, or a payment with this `pg_payment_id` does not exist.	Fix the request.
`1100`	The signature is missing or invalid.	Check the signature: see Sync API Overview.
`1101`	`pg_merchant_id` is not found. The response is not signed.	Check the merchant ID.
`1202`	The payment belongs to another merchant.	Check `pg_payment_id` and `pg_merchant_id`.
`9014`	The amount has already been captured: the clearing was done, or the payment is one-step.	Return the money with `refund`.
`10033`	The payment has already been cancelled.	Do not repeat the call.
`900811`	The payment has already been cancelled or refunded.	Do not repeat the call; get the payment status with `status_v2`.
`90131`	The payment is not successful: it was declined, or 3DS authentication is not completed.	There is nothing to cancel.
`91031`	A cancel request for this payment is already being processed.	Wait for the response to the first request or get the payment status with `status_v2`.
`9994`	Cancelling is disabled in the merchant settings.	Contact Freedom Pay.
`10000`	The cancel could not be performed.	Repeat the request later.
Other codes	The payment system declined the cancel.	See Error codes.

Request example

Required fields only. pg_sig is calculated with the secret key test_secret_key.
Line breaks in the body are added for readability: send the body as one line.

Responses

🟢200Success

application/xml

Bodyapplication/xml

Example

<?xml version="1.0" encoding="utf-8"?>
<response>
    <pg_payment_id>1015054203205</pg_payment_id>
    <pg_payment_revoke_id>1015054203208</pg_payment_revoke_id>
    <pg_status>ok</pg_status>
    <pg_revoke_status>success</pg_revoke_status>
    <pg_datetime>2026-10-15T10:45:36+00:00</pg_datetime>
    <pg_salt>TteidTJ8kB6x9UJN</pg_salt>
    <pg_sig>8cd2e7ff9da52f4f6f6d3c59f666d9bb</pg_sig>
</response>

🟢200Error

Result#

Cancel flow#

Errors#

Request example#

Request

Responses

Result

Cancel flow

Errors

Request example