Create payment

Creates a payment and returns the link to the Freedom Pay payment page: pg_redirect_url. Redirect the client to it: the client chooses the payment method and pays on the page.

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_.

To open the payment on a payment page made by a template, see Create payment with a payment page template. If your account manager enabled a template for the merchant, the payment opens on it even without pg_template.

To embed the bank card form in your page, see Create payment in a payment frame.

The same parameters can be sent from the client's browser to /payment.php with GET or POST: the client goes to the payment page at once. Sign such a request with the script name payment.php; errors are shown to the client as a page.

Test cards: see Merchant API Overview.

Payment page flow

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>1022123803884</pg_payment_id>
    <pg_redirect_url>https://customer.freedompay.kz/pay.html?customer=01a164ba-258a-73d8-a674-dbca94c7f165</pg_redirect_url>
    <pg_redirect_url_type>need data</pg_redirect_url_type>
    <pg_salt>30mVYG1WPelmyIT6</pg_salt>
    <pg_sig>31ead9b4469cd81d377685be79fb6e66</pg_sig>
</response>

🟢200Error

Payment page flow#

Recurring payments#

Result#

Errors#

Request example#