Create payment page

Creates a payment and returns the link to the Freedom Pay payment page: pg_redirect_url. Redirect the client to it: the client enters the card data 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.

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

Test cards: see Gateway API Overview.

Payment page flow

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

Example

<?xml version="1.0" encoding="utf-8"?>
<response>
    <pg_status>ok</pg_status>
    <pg_payment_id>1016061000044</pg_payment_id>
    <pg_redirect_url>https://customer-regress.freedom-pay.dev/pay.html?customer=01a14480-861a-73e4-baf2-a0c7a3caeaa3</pg_redirect_url>
    <pg_redirect_url_type>need data</pg_redirect_url_type>
    <pg_salt>ZIyyuDcEsR0Q9RYc</pg_salt>
    <pg_sig>5cf946c8305481fe69995341993e0b9d</pg_sig>
</response>

🟢200Error

Payment page flow#

Errors#

Request example#

Request

Responses

Payment page flow

Errors

Request example