Pay by recurring profile

Charges the card saved in a recurring profile without the client: no card data and no 3DS. The result is returned in the same response.

The profile is created by the first payment with pg_recurring_start = 1 in Pay by card: its ID is returned in pg_recurring_profile. Recurring payments are available after Freedom Pay enables them for the merchant: contact your account manager.

Charge the profile only after the first payment is successful.

The payment is made in the currency of the first payment; the amount can differ. The amount is captured right away: clearing is not needed, to return the money call refund.

Test cards: see Gateway API Overview.

Result

`pg_status`	Meaning	Next step
`ok`	The payment is made: `pg_payment_id` is the ID of the new payment.	To return the money, call `refund`.
`error`	The request is rejected or the payment is declined.	See «Errors» below.

Recurring payment flow

Each charge is a separate payment with its own pg_payment_id and pg_order_id.

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 the profile `pg_recurring_profile` does not exist.	Fix the request.
`1370`	`pg_amount` is missing, is not a number, or is outside the range 0.01–99999999.	Fix the amount.
`1380`	The amount is too small: the commission is greater than the amount. The payment is not made and stays in the `waiting` status, `pg_payment_id` is returned.	Increase the amount or contact Freedom Pay.
`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.
`9011`	Invalid recurring profile ID: the profile cannot be used by this merchant.	Check `pg_recurring_profile` and `pg_merchant_id`.
`9101`	The first payment of the profile is fully refunded.	Create a new profile with a new first payment.
`110891`	The merchant has no payment system for recurring payments by this card. The payment is not made and stays in the `waiting` status, `pg_payment_id` is returned.	Contact Freedom Pay.
`10000`	The payment could not be performed.	Repeat the request later.
Other codes	The payment is declined by the issuer or the payment system. `pg_payment_id` is returned.	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>1015054204363</pg_payment_id>
    <pg_status>ok</pg_status>
    <pg_recurring_profile>64</pg_recurring_profile>
    <pg_datetime>2026-10-15T12:58:07+00:00</pg_datetime>
    <pg_salt>6MYsRrZ52JiSiomy</pg_salt>
    <pg_sig>1172fe9c0d275f84652a287562e47919</pg_sig>
</response>

🟢200Error

Pay by recurring profile

Result#

Recurring payment flow#

Errors#

Request example#

Request

Responses

Result

Recurring payment flow

Errors

Request example