1. Read
Freedom Pay
  • Overview
  • Gateway API
    • Overview
    • Sync API
      • Overview
      • Card data encryption
      • Payments
        • Overview
        • Pay by card
        • Pay by card: complete 3DS
        • Pay with Apple Pay
        • Pay with Google Pay
        • Pay by recurring profile
        • Create payment page
        • Create payment page with any amount
        • Capture payment (clearing)
        • Cancel payment
        • Refund payment
        • Get payment status
      • Payouts
        • Overview
        • Pay out to card
        • Pay out to IBAN
        • Get payout balance
        • Get payout status
      • Transfers
        • Overview
        • Transfer from card to card
        • Transfer from card to card: complete 3DS
        • Get exchange rates
        • Get transfer status
      • Saved cards
        • Overview
        • Save card
        • Save card: complete 3DS
        • List saved cards
        • Remove saved card
        • Pay by card token
        • Pay out to card token
        • Get payment status
    • Async API
      • Overview
      • Create
        • Create payment
        • Save card without a charge
      • Read
        • Get payment status
          POST
        • Get request result
          POST
      • Edit
        • Capture payment (clearing)
        • Cancel payment (reverse)
        • Refund payment
  • Merchant API
    • Overview
    • Payments
      • Overview
      • Checkout
      • Pay by saved card
        • Overview
        • Create payment
        • Confirm payment with CVC
        • Confirm payment without the client
      • Create payment
      • Create payment with a payment page template
      • Create payment in a payment frame
      • Create payment with any amount
      • Create recurring payment
      • Capture payment (clearing)
      • Cancel payment
      • Refund payment
      • Get payment status
    • Payouts
      • Overview
      • Create payout page
      • Pay out to saved card
      • Pay out to IBAN
      • Get payout status
      • Get payout balance
    • Saved cards
      • Get saved cards
      • Save card
      • Save card for payouts
      • Delete saved card
      • Save card without a charge
    • Mobile balance
      • Overview
      • Create mobile balance payment
      • Charge mobile balance
      • Get mobile balance payment status
      • Confirm payment with SMS code
      • Resend SMS code
    • Invoices
      • Overview
      • Recurring payments
        • Overview
        • Create recurring profile
        • Get recurring profile
        • Charge by recurring profile
        • Cancel recurring profile
        • Recurring profile notification
      • Tips
        • Overview
        • Create
      • Create invoice
      • Get invoice status
      • Get invoice details
      • Cancel invoice
      • Refund invoice
    • SDK
      • JS SDK
      • Merchant SDK
        • Android
        • iOS
        • Migration guide
    • 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
      • CS-Cart
        • Overview
        • Installation
        • Configuration
        • Test
        • Live payments
    • Installment
      • Overview
      • Status
        • Get application status
        • Application status notification
        • Change application status
      • Get partners
      • Create application
    • Callbacks
      • Overview
      • Result notify
      • Check request
      • Payout notify
      • Redirect back
  • Partner API
    • Overview
    • Rates
      • Overview
      • Rates
    • Products
      • Overview
      • Dictionaries
      • Add client with product
      • Client request status
      • Create terminal
      • Update terminal limits
      • Product request status
    • E-Money
      • Overview
      • Add
      • Owner identification
      • Info
      • Close
      • Block
      • Balance
      • Statement
      • Request Status
    • Device ID
      • Android SDK
      • iOS SDK
    • Implement SuperApp
      • Overview
      • Pay
      • Refund
      • Status
    • Account
      • Overview
      • Create payment
      • Payment status
      • Batch statuses
      • Statement
      • Statement status
      • Balance
      • Balance status
    • Invoices
      • Info
  1. Read

Get payment status

KZ
https://api.freedompay.kz
KZ
https://api.freedompay.kz
POST
https://api.freedompay.kz
/v5/g2g/read
Returns the current state of a payment by its ID (id) or by the merchant's order number (order_id).
The X-Action header must be gateway.payment.status.
Sign the request with X-JWS-Signature: see Async API Overview.
Child payments (refunds and reversals) can be requested by their own ID.

Payment status flow#

Statuses are the values of status in the response.
StatusMeaning
processThe payment is being processed.
waiting_3dsWaiting for 3DS authentication: redirect the client to 3ds.acs_url.
process_3ds3DS authentication result is being processed.
approvedFunds are held (two-step payment): clear or reverse the payment.
process_clearingClearing is being processed.
reversedThe hold is cancelled, funds are released.
successThe payment is completed, funds are debited.
errorThe payment failed: see error.
LabelMeaning
createThe method gateway.payment.create.
3DSThe client must pass 3DS authentication at 3ds.acs_url.
3DS doneThe client has passed 3DS authentication.
one-stepauto_clearing = true.
two-stepauto_clearing = false.
declinedThe payment is declined.
clearingThe method gateway.payment.clearing.
reverseThe method gateway.payment.reverse.
refundThe method gateway.payment.refund: the status stays success, refunds are listed in refund_payments.
A partial clearing reverses the rest automatically: it is listed in reverse_payments.

Result#

ResponseMeaningNext step
The paymentThe current state of the payment in status.See «Payment status flow» above.
{}, X-Request-Status: processThe payment data is being prepared.Repeat the request in a few seconds.

Errors#

A declined payment is not an error of this request: it is returned with HTTP 200, status error and the error object.
The error is returned in error.code and error.description.
HTTPerror.codeWhenWhat to do
4009400The body is not valid JSON.Fix the request.
4019998The signature is invalid.Check the signature: see Async API Overview.
4229403Neither id nor order_id is passed, id is not a UUID, or a required header is missing. The reason is in error.description.Fix the request.
5009999Internal error at the gateway entry point.Repeat the request later.
50010000Internal error in payment processing.Repeat the request later.

Request

Header Params

Body Params application/json

Examples
{
  "id": "01a1304b-4b7e-7ef7-8bd6-3cab7702d22e"
}

Responses

🟢200OK
application/json
Headers

Bodyapplication/json

Examples
Since the API operates asynchronously, whenever the payment status is returned as process, you must continuously query the payment status until you receive a final status such as approved or success.
{
  "id": "01a1304b-4b7e-7ef7-8bd6-3cab7702d22e",
  "status": "approved",
  "amount": 100,
  "created_at": "2026-10-12T13:26:43.326981454Z",
  "order_id": "order_1001",
  "clearing": {
    "cleared": false,
    "amount": 0
  },
  "from": {
    "card": {
      "token": "af6ada05-5599-41aa-9b8c-227233e58f2e",
      "brand": "UNIONPAY"
    }
  },
  "additional": {
    "approval_code": "432914",
    "reference": "420101893936",
    "intreference": "5DF022F3C632F404"
  },
  "3ds": {
    "acs_url": "",
    "flow_type": "F"
  }
}
🟠422Unprocessable Entity
🟠400Bad Request
🟠401Unauthorized
🔴500Internal Server Error
Previous
Save card without a charge
Next
Get request result