Freedom Pay
  1. Mobile balance
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
      • Clearing
      • Refund
      • Status
    • Payout
      • Introduction
      • IBAN
      • Balance
      • Status by order_id
      • Status by Payment ID
      • Status by Payment ID V2
    • Mobile balance
      • Introduction
      • Init
        POST
      • Pay
        POST
      • Approve
        POST
      • Resend code
        POST
      • Status
        POST
    • 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. Mobile balance

Status

POST
https://api.freedompay.uz/get_status3.php

Request

Body Params multipart/form-data
pg_merchant_id
integer 
required
Merchant ID in {{project}}. Issued upon connection.
pg_payment_id
integer 
required
Internal payment identifier in the system FreedomPay if sent along with the pg_order_id field, the pg_order_id field will be ignored.
Example:
12345
pg_order_id
string 
optional
Payment ID in the merchant system. Be careful, when requesting by order_id, the merchant must independently monitor the uniqueness of this parameter, otherwise information will be returned for the last payment with the given order_id for this merchant.
Example:
00102
pg_salt
string 
required
Random string.
Example:
some random string
pg_sig
string 
required
Request signature.

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.freedompay.uz/get_status3.php' \
--form 'pg_merchant_id=""' \
--form 'pg_payment_id="12345"' \
--form 'pg_order_id="00102"' \
--form 'pg_salt="some random string"' \
--form 'pg_sig=""'

Responses

🟢200Success
application/xml
Body
pg_status
string 
required
Shows the result of the query
Status Description
ok — Request was successful,
error — Request was successful
pg_payment_id
integer 
required
Unique identifier of the payment transaction in {{project}}; serves as the key for all further work with the transaction.
pg_order_id
string 
required
Order ID in the shop system.
pg_currency
string 
required
The currency in which the amount is specified.
pg_amount
integer 
required
Payment amount.
pg_salt
string 
required
Random string.
pg_sig
string 
required
Request signature.
pg_can_reject
boolean 
optional
Indicates whether the payment can be cancelled (0 or 1). The value 1 is possible only if the payment status is ok and the payment system allows cancellations.
pg_payment_method
string 
optional
Payment method
Example: mobile_commerce
pg_payment_status
string 
optional
Payment status.
pg_clearing_amount
integer 
optional
Amount written off during payment clearing.
pg_revoke_amount
integer 
optional
Revoked amount.
pg_user_email
string 
optional
Customer's email.
pg_card_name
string 
optional
Cardholder name.
pg_card_pan
string 
optional
Masked card number.
Example: 5483-18XX-XXXX-0293
pg_card_token
string 
optional
The token of a previously saved card. Passed only if the card was successfully saved.
pg_user_phone
string 
optional
Customer's phone number.
pg_payment_date
string <date-time>
optional
Date and time of the payment in YYYY-MM-DD HH:MM:SS format.
pg_revoked_payments
array[string]
optional
List of revokes for this payment.
pg_refund_payments
array[string]
optional
List of refunds for this payment.
pg_reference
integer 
optional
A unique bank transaction identifier assigned by the bank (RRN).
pg_failure_code
integer 
optional
Error code.
pg_failure_description
string 
optional
Description of the error.
pg_captured
boolean 
optional
Indicates whether clearing was performed at the time of authorization. Value is 0 or 1.
pg_auth_code
integer 
optional
Bank payment authorization code.
Example
<?xml version="1.0" encoding="utf-8"?>
<response>
    <pg_status>ok</pg_status>
    <pg_payment_id>123456789</pg_payment_id>
    <pg_can_reject>1</pg_can_reject>
    <pg_payment_method>bankcard</pg_payment_method>
    <pg_amount>10</pg_amount>
    <pg_currency>KZT</pg_currency>
    <pg_payment_status>success</pg_payment_status>
    <pg_clearing_amount>10</pg_clearing_amount>
    <pg_reference>123456789</pg_reference>
    <pg_card_name>Card Holder</pg_card_name>
    <pg_card_pan>5483-18XX-XXXX-0293</pg_card_pan>
    <pg_card_token>ef741cfc-f85e-41a0-84e6-2ba964912182</pg_card_token>
    <pg_refund_payments>
        <pg_refund_payment>
            <pg_payment_id>123456789</pg_payment_id>
            <pg_payment_status>success</pg_payment_status>
            <pg_amount>-10</pg_amount>
            <pg_payment_date>2023-05-31 16:26:36</pg_payment_date>
            <pg_reference>123456789</pg_reference>
        </pg_refund_payment>
    </pg_refund_payments>
    <pg_refund_amount>-10</pg_refund_amount>
    <pg_captured>1</pg_captured>
    <pg_create_date>2023-05-31 16:24:20</pg_create_date>
    <pg_salt>some random string</pg_salt>
    <pg_sig>your_signature</pg_sig>
</response>
Previous
Resend code
Next
Introduction