Freedom Pay
  1. Page
Freedom Pay
  • Gateway API
    • Introduction
    • Reference
      • Test cards
      • Error codes
    • Sync API
      • Introduction
      • Page
        • Introduction
        • Page
        • Page with amount control
        • Status
      • Pay
        • Introduction
        • Card
        • 3DSecure
        • Cancel
        • Clearing
        • Refund
        • Status
      • Payout
        • Introduction
        • Card
        • IBAN
        • Balance
        • Status
        • StatusV2
      • Transfer
        • Introduction
        • Card
        • 3DSecure
        • Rates
        • Status
      • Card
        • Introduction
        • Add
        • 3DSecure
        • List
        • Remove
        • Status
      • Token
        • Introduction
        • Token Pay
        • Apple Pay
        • Google Pay
        • Samsung Pay
        • Token Payout
        • Status
    • Async API
      • Introduction
      • create
        • create payment
        • create payment recurrent
      • read
        • read payment
        • read request
      • edit
        • edit payment.refund
        • edit payment.reverse
        • edit payment.clearing
      • delete
  • Merchant API
    • Introduction
    • Reference
      • Test cards
      • Test phone numbers
      • Error codes
    • Page
      • Introduction
      • Page
        POST
      • Page with amount control
        POST
      • Payout page
        POST
      • Frame
        POST
      • Widget
        POST
      • Status
        POST
    • Pay
      • Introduction
      • Cancel
      • Clearing
      • Refund
      • Status
    • Payout
      • Introduction
      • IBAN
      • Balance
      • Status by order_id
      • Status by Payment ID
      • Status by Payment ID V2
    • Mobile balance
      • Introduction
      • Init
      • Pay
      • Approve
      • Resend code
      • Status
    • Card
      • Introduction
      • Add
      • Add for payout
      • Remove
      • List
      • Status
    • Token
      • Introduction
      • Saved card with CVC input (Init)
      • Saved card with CVC input (Pay)
      • Non-acceptance payments
      • Non-acceptance payments (Pay)
      • Token payout
      • Status
    • Invoice
      • Introduction
      • Init
      • Info
      • Pay
      • Status
    • Additional
      • Introduction
      • Check request
      • Result notify
      • Payout notify
      • Redirect back
  • Card API
    • Introduction
    • Payment Cards
      • Reference
        • Request Status
        • Client product
        • Card product
        • Card status
        • Card block
        • Transaction
        • Error codes
      • Card issue
        • Bulk
        • Single
        • Physical
      • Card control
        • Activate
        • Block
        • Unblock
        • Set PIN
        • Reset PIN counter
        • Close
        • Identification
        • Info
        • Balance
        • Secret data
        • Statement
      • Client
        • Create
        • Edit
        • Card list
      • Additional
        • Request status
    • Gift Cards
      • Introduction
      • Reference
        • Request status
        • Card status
      • List
      • Issue
      • Confirm
      • Resend
      • Resend code
      • Status
  • Partner API
    • Rates
      • Introduction
      • Rates
    • Products
      • Introduction
      • Reference
        • Request
        • Product
        • Freedom POS
        • Freedom ECOM
        • Freedom BOX
        • Limits
      • Add user
      • Add product
      • Add user with product
      • Grant user
      • Send auth data
      • Request status
    • E-Money
      • Introduction
      • Reference
        • Request
        • Operation
        • Error codes
      • Add
      • Owner identification
      • Info
      • Close
      • Block
      • Balance
      • Statement
      • Request Status
    • Freedom ID
      • Introduction
      • Android SDK
      • iOS SDK
      • Reference
        • Error codes
      • Link
      • Token
      • Token refresh
      • Info
      • Profile
      • Request
  • Mobile SDK
    • Payment SDK
      • iOS
      • Android
    • Freedom QR
      • Reader SDK (Android)
      • Provider SDK (Android)
  • CMS
    • Introduction
    • Get Merchant ID and key
    • WordPress
      • Introduction
      • Installation
      • Configuration
      • Test
      • Live payments
      • Update
    • Tilda
      • Introduction
      • Installation
      • Configuration
      • Test
      • Live payments
    • InSales
      • Introduction
      • Installation
      • Configuration
      • Test
      • Live payments
    • Ecwid
      • Introduction
      • Installation
      • Configuration
      • Test
      • Live payments
    • Bitrix
      • Introduction
      • Installation
      • Configuration
      • Test
      • Live payments
    • PrestaShop
      • Introduction
      • Installation
      • Configuration
      • Test
      • Live payments
    • OpenCart
      • Introduction
      • Installation
      • Configuration
      • Test
      • Live payments
  1. Page

Introduction

Payment page#

There are two options for using the method:
direct data transfer from the merchant to FreedomPay
data transfer via the user's browser to FreedomPay
 When directly transferring data from the merchant to FreedomPay, the merchant must send data to init_payment.php.
 When transferring data via the user's browser to FreedomPay, the merchant must redirect the user with the data to payment.php.
 You can transfer arbitrary additional parameters whose names do not begin with pg_. All these parameters will be transferred to pg_check_url and pg_result_url.
The names of additional merchant parameters must be unique.
 After receiving the pg_redirect_url parameter, the user is redirected to the payment page, where the payer completes the payment.
 If successful, the user will be redirected to the payment page.
 If the merchant has not transferred all the parameters necessary to create a payment transaction (payment system, user's phone number and parameters necessary for the selected payment system), they are requested from the user on the freedompay.kg website.

Page#

A ready-made web interface for online payments.
The payment page is used for the payer to enter the necessary details to complete the payment.

Interaction diagram#

Status: success/error/pending
Merchant_API_V3-Payment page.drawio.png

Page with amount control#

If you want the payer to enter the payment amount himself, you must use this method.
When making a payment, the payer first gets to the form where he enters the amount of the payment.
Then it is redirected to the payment page where the payment takes place.

Interaction diagram#

Status success/error/pending
Merchant_API_V3-Any amount method.drawio.png

Payout page#

A ready-made web interface for payout.
The payout page is used for the payer to enter the necessary details to complete the payout.

Interaction diagram#

Status: success/error/pending
Merchant_API_V3-Payout page.drawio.png

Frame#

This is an embeddable HTML element that loads page content from the Freedom Pay Gateway. It is used to display the payment form (e.g., fields for entering the card number and CVV code) directly on the merchant's page.
To invoke the Frame method, the parameter pg_payment_route = frame must be included in the request to the Freedom Pay Gateway.
To use this method, you should contact your manager.

Interaction diagram#

Status success/error/pending
Merchant_API_V3-frame.drawio.png

Widget#

It is a graphical interface (component) embedded on a website or in an application, allowing users to make payments.
It is used to display the payment form (e.g., fields for entering the card number and CVV code) directly on the merchant's page.
It is embedded on the merchant's page using a ready-made script code in the <head> section.
To use this method, you should contact your manager.
The buyer places an order on your website
The buyer clicks on the button to buy the product
Your site initializes the checkout
{{project}} calls a pop-up window where the payment process takes place
In case of successful payment or error, your site receives a notification

Interaction diagram#

Status: success/error/pending
Merchant_API_V3-widget.drawio.png

Status#

This method is used to get information about the current status of a payment, such as whether it was successful, an error occurred, or is pending etc.

Support#

If you found an inaccuracy or need help, feel free to reach out! 👋
Email: support@freedompay.kg
Previous
Error codes
Next
Page