Freedom Pay
    Freedom Pay
    • Overview
    • Gateway API
      • Overview
      • Sync API
        • Overview
        • Purchase
          • Overview
          • Create payment
          • Any amount
          • Card
          • 3DSecure
          • Cancel
          • Clearing
          • Refund
          • Status
        • Payout
          • Overview
          • Card
          • IBAN
          • Balance
          • Status
        • Transfer
          • Overview
          • Card
          • 3DSecure
          • Rates
          • Status
        • Card
          • Overview
          • Add
          • 3DSecure
          • List
          • Remove
          • Status
        • Token
          • Overview
          • Token Pay
          • Apple Pay
          • Google Pay
          • Token Payout
          • Status
      • Async API
        • Overview
        • create
          • create payment
          • create payment recurrent
        • read
          • read payment
          • read request
        • edit
          • edit payment.refund
          • edit payment.reverse
          • edit payment.clearing
        • delete
    • Merchant API
      • Overview
      • Purchase
        • Overview
        • Checkout
        • Card token
          • Overview
          • Tokenize card
          • Delete token
          • Card token list
          • Create payment (with CVC)
          • Confirm payment (with CVC)
          • Create payment
          • Confirm payment
        • Create payment
        • Any amount
        • Cancel payment
        • Clearing
        • Refund payment
        • Status
      • Payout
        • Overview
        • Card token
          • Tokenize card
          • Delete token
          • Card token list
          • Create payment
        • Create payment
        • IBAN
        • Balance status
        • Status by order_id
        • Status by Payment ID
        • Status
      • Mobile balance
        • Overview
        • Init
        • Pay
        • Approve
        • Resend code
        • Status
      • Invoice
        • Overview
        • Init
        • Info
        • Pay
        • Status
      • SDK
        • JS SDK
        • Google Pay
        • Freedom QR
          • Reader SDK (Android)
          • Provider SDK (Android)
        • Payment SDK
          • iOS
          • Android
      • CMS
        • Overview
        • Get Merchant ID and key
        • WordPress
          • Overview
          • Installation
          • Configuration
          • Test
          • Live payments
          • Update
        • Tilda
          • Overview
          • Installation
          • Configuration
          • Test
          • Live payments
        • InSales
          • Overview
          • Installation
          • Configuration
          • Test
          • Live payments
        • Ecwid
          • Overview
          • Installation
          • Configuration
          • Test
          • Live payments
        • Bitrix
          • Overview
          • Installation
          • Configuration
          • Test
          • Live payments
        • PrestaShop
          • Overview
          • Installation
          • Configuration
          • Test
          • Live payments
        • OpenCart
          • Overview
          • Installation
          • Configuration
          • Test
          • Live payments
      • Redirect back
        POST
      • Result notify
        POST
      • Payout notify
        POST
      • Check request
        POST
    • Card API
      • Overview
      • Payment Cards
        • Overview
        • Dictionaries
        • Bulk issue
        • Issue card
        • Issue plastic card
        • Activate card
        • Block card
        • Unblock card
        • Set PIN
        • Reset PIN counter
        • Close card
        • Update client
        • Card info
        • Balance
        • Secret data
        • Secret data (version 2)
        • Statement
        • Statement extended
        • Create client
        • Edit client
        • Сards' list
        • Request' status
        • Create transaction
        • Clearing transaction
        • Refund transaction
        • Transaction request' status
        • Transaction info
      • Gift Cards
        • Overview
        • List
        • Issue
        • Confirm
        • Resend
        • Resend code
        • Status
    • Partner API
      • Rates
        • Overview
        • Rates
      • Products
        • Overview
        • Dictionaries
        • Add client with product
        • Request status
      • E-Money
        • Overview
        • Add
        • Owner identification
        • Info
        • Close
        • Block
        • Balance
        • Statement
        • Request Status
      • Freedom ID
        • Overview
        • Design
        • iOS SDK
        • Android SDK
        • OAuth2
          • Authorization link
          • Token exchange
          • Token refresh
          • User info
          • Request profile
          • Get profile status
          • Create user
          • Update user
        • OIDC
          • Authorization endpoint
          • Token exchange
          • Userinfo
        • Error codes
        • Examples
          • Keycloak
      • Transfer
        • Overview
        • Get token
        • Refresh token
        • Get agents
        • Fees
        • Create person
        • Create business
        • Create transfer
        • Print application
        • Confirm
        • Search
        • Payout
        • Payout confirm
        • Cancel
        • Get person info
        • Get business info
        • Status
        • Info
      • Device ID
        • Android SDK
        • iOS SDK

    Overview

    General information#

    Please review the text below — it contains useful information

    Recommendations for Using HTTP Protocols#

     To ensure optimal performance and reliability when interacting with our services, we recommend using the HTTP/3 protocol (based on QUIC).
    Benefits of HTTP/3:
    Faster connection establishment due to the use of UDP instead of TCP
    Improved performance in unstable networks (e.g., mobile connections)
    Reduced latency through built-in multiplexing without head-of-line blocking
    Enhanced security with always-encrypted connections (similar to HTTPS)
    Compatibility
     HTTP/3 is supported by most modern browsers and servers. While HTTP/1.1 and HTTP/2 remain supported for backward compatibility, HTTP/3 is the preferred protocol
    Recommendation
     When configuring client solutions and integrations, ensure that your technology stack supports HTTP/3 (e.g., curl with QUIC support, modern versions of Chrome, Firefox, nginx, etc.)

    System Monitoring#

     For real-time updates on our system performance and availability, please refer to our monitoring page: https://status.freedompay.kz/

    Healthcheck#

    To monitor the availability of our API services, you can send HTTP/2 requests to the following healthcheck endpoint:
    https://api.freedompay.kz/status/healthcheck
    The endpoint returns a JSON response with the current status of the service. Example format:
    {"status": "ok","time": "1970-01-01T00:00:00+00:00"}
    Explanation of response parameters:
    propertytypedescription
    statusstringIndicates the health or operational state of the service.
    timestring, ISO 8601 formatThe UTC timestamp representing the moment the health check response was generated
    Next
    Overview