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
          POST
        • 3DSecure
          POST
        • Cancel
          POST
        • Clearing
          POST
        • Refund
          POST
        • Status
          POST
      • 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
      • 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. Pay

Introduction

Payment with card#

 This section outlines the methods available for card 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.

Card#

This method is used for processing payments using a card.
At this stage, the payer provides card details to execute the transaction.
The payment can follow two scenarios: with 3D Secure (3DS) or without it.

Interaction diagram for non3ds payment#

Status: success/error/pending
error Payment non3DS.drawio.png

Interaction diagram for 3ds payment#

Status: success/error
error Payment  3DS.drawio.png
Status: pending
G2G_API_V3-pending Payment  3DS. case 2.drawio.png

3DSecure#

When using this method, 3ds is required, therefore it is necessary to make a request to the ACS server of the card issuer bank.
3D Secure (3DS) is an authentication technology to protect against unauthorized use of cards. It allows for verifying the cardholder’s identity before the payment is processed.
The authentication process works as follows: after entering the card details, the issuer’s website opens, prompting the cardholder to enter a password or secret code. The code is usually sent via SMS. If the code is entered correctly, the payment is authorized; if not, the transaction is declined.
3D Secure is available only for cards issued by banks that support this technology. Payments without 3D Secure are considered less secure.

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
image.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
G2G_API_V3-Clearing.drawio.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
G2G_API_V3-Refund of deducted payment.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
Card