Create payment with a payment page template

Creates a payment on a payment page made by a template and returns the link to it: pg_redirect_url. Redirect the client to it: the client pays by bank card, Apple Pay or Google Pay, as connected for the merchant.

The template is enabled for the merchant by your account manager or set in the request by pg_template. If the template is enabled for the merchant, pg_template can be omitted; a value passed in the request takes priority.

An unknown pg_template value is ignored: the template enabled for the merchant is used, or, if there is none, the payment opens on the standard payment page, see Create payment.

The result of the payment comes to pg_result_url, see Result notify. After the payment the client is returned to pg_success_url or pg_failure_url, see Redirect back.

If the payment result is not received, get it with Get payment status.

Parameters without the pg_ prefix are passed back to pg_check_url and pg_result_url unchanged. Give them unique names that do not start with pg_.

If the payment system declines the payment, the client can pay again on the same page: see «Repeated payment attempts» below.

pg_payment_method and pg_timeout_after_payment are not used with a template.

The template takes priority over the payment frame: with a template, pg_payment_route is ignored.

Test cards: see Merchant API Overview.

Payment page flow

Repeated payment attempts

If the payment system declines the payment, the payment is not closed. The client sees the error and can pay again on the same page, with the same or another card.

The number of attempts is limited only by pg_lifetime. All attempts belong to one payment with the same pg_payment_id.

Between attempts Get payment status returns pg_payment_status = waiting without the decline code of the attempt.

Only the final result comes to pg_result_url: pg_result = 1 after an approved attempt, or pg_result = 0 when pg_lifetime expires without one.

Recurring payments

Recurring payments are repeat payments where a recurring profile is created during the first payment. Subsequent payments are made according to this profile.

To create a profile, the following parameters are passed in init_payment: pg_recurring_start — profile creation, pg_recurring_lifetime — validity period. If pg_recurring_lifetime exceeds the card's expiration date, the profile remains active until the card expires.

The profile number (pg_recurring_profile_id) is passed in the Result URL. It is also supported for Apple Pay and Google Pay.

For connection, please contact the manager.

Result

`pg_status`	Meaning	Next step
`ok`	The payment is created.	Redirect the client to `pg_redirect_url` and wait for the result at `pg_result_url`.
`error`	The request is rejected.	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.
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

Examples

SuccessSuccess with QR code

<?xml version="1.0" encoding="utf-8"?>
<response>
    <pg_status>ok</pg_status>
    <pg_payment_id>1022123803917</pg_payment_id>
    <pg_redirect_url>https://customer.freedompay.kz/main/pay.html?customer=01a164ec-1fcd-7321-95c4-c3ba5c4fa0e2</pg_redirect_url>
    <pg_redirect_url_type>payment system</pg_redirect_url_type>
    <pg_salt>ijqWYTNu6P5q4HSb</pg_salt>
    <pg_sig>a33f72fe861d8c9b0d0b801f6ac17b09</pg_sig>
</response>

🟢200Error

Create payment with a payment page template

Payment page flow#

Repeated payment attempts#

Recurring payments#

Result#

Errors#

Request example#

Request