Create recurring payment

Charges the client's card saved in a recurring profile, without the client.

The profile is created by the first payment: pass pg_recurring_start = 1 and pg_recurring_lifetime in Create payment. Recurring payments are available after Freedom Pay enables them for the merchant: contact your account manager.

The amount can be different every time. The currency and the payment method are taken from the first payment.

Every request creates a new payment. If the response is lost, check the payment with Get payment status by pg_order_id before repeating the request.

The payment result is also sent to pg_result_url.

If the payment is declined, the response contains only the error: the declined payment is not returned in it.

Test cards: see Merchant API Overview.

Recurring payment flow

Result

`pg_status`	Meaning	Next step
`ok`	The payment is successful.	To return the money, call Refund payment.
`error`	The request is rejected or the payment is declined.	See «Errors» below.

Errors

The HTTP status is always 200; the error is returned in pg_error_code and pg_error_description. Error responses are not signed.

`pg_error_code`	When	What to do
`94031`	A parameter is missing or invalid, or a recurring profile with this ID does not exist.	Fix the request.
`11005`	`pg_amount` is missing, is not a number, is less than 0.01 or more than 99999999.	Fix the amount.
`1100`	The signature is missing or invalid.	Check the signature: see Merchant API Overview.
`340`	The recurring profile belongs to another merchant.	Check `pg_recurring_profile` and `pg_merchant_id`.
`10000`	The recurring profile has expired, or a temporary error occurred.	If `pg_recurring_profile_expiry_date` has passed, create a new profile with the next payment through Create payment. Otherwise repeat the request later.
`91011`	The first payment of the profile is refunded in full.	Create a new profile with the next payment through Create payment.
Other codes	The payment system declined the payment.	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/json

Upon success, the user is redirected to the payment page.
If parameters are missing (system, phone, etc.), the system requests them from the user.

Bodyapplication/json

Example

<?xml version="1.0" encoding="utf-8"?>
<response>
    <pg_status>ok</pg_status>
    <pg_payment_id>1023122203674</pg_payment_id>
    <pg_amount>50</pg_amount>
    <pg_currency>KZT</pg_currency>
    <pg_recurring_profile>58</pg_recurring_profile>
    <pg_recurring_profile_expiry_date>2027-10-23 00:00:00</pg_recurring_profile_expiry_date>
    <pg_salt>FgdkQAjIzET88Kt1</pg_salt>
    <pg_sig>333e0a6182010aa7cae9b0a431191047</pg_sig>
</response>

🟢200Error

Create recurring payment

Recurring payment flow#

Result#

Errors#

Request example#

Request

Responses

Recurring payment flow

Result

Errors

Request example