Freedom Pay
  1. Pay
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
      • Page with amount control
      • Payout page
      • Frame
      • Widget
      • Status
    • Pay
      • Introduction
      • Cancel
        POST
      • Clearing
        POST
      • Refund
        POST
      • Status
        POST
    • 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. Pay

Introduction

Payment#

 This section outlines the methods available for payments.
Depending on the selected transaction type (one-step or two-step payment), the set of available methods varies.
 A one-step payment is executed with a single request that simultaneously initiates authorization and funds withdrawal.
To send a request for processing a one-step payment in the Freedom Pay Gateway, you must specify pg_auto_clearing = 1 in the request parameters.
 A two-step payment is performed in two stages: first, authorization is carried out, during which the amount is blocked on the payer's account, and then a second request is sent for clearing (operation confirmation), which results in the actual withdrawal of funds.
 To send a request for processing a two-step payment in the Freedom Pay Gateway, you must specify pg_auto_clearing = 0 in the request parameters.

Cancel Payment#

Cancel payment before the actual fund withdrawal is available only for a two-step payment process.
Payment cancellation is made before funds are debited, at the stage of holding the amount on the payer's card.

Interaction diagram#

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

Clearing#

This method involves sending a request to withdraw the payment amount that was previously held on the payer's card.
If Freedom Pay Gateway does not receive a clearing or cancellation request within 5 days, the payment will be automatically cleared.
The method is available only for two-step payments.

Interaction diagram#

Status: success/error/pending
image.png

Refund#

Refund is a method used to return funds to the payer for a previously processed payment.
It is applicable only in cases where the funds have already been withdrawn from the payer's card.
This method is available for one-step payments and already cleared two-step payments but cannot be used for two-step payments that have not been cleared.

Interaction diagram#

Status: success/error/pending
Merchant_API_V3-Refund.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.uz
Previous
Status
Next
Cancel