Freedom Pay
  1. Partner API
Freedom Pay
  • Overview
  • Gateway API
    • Overview
    • Sync API
      • Overview
      • Purchase
        • Overview
        • Create payment
        • Any amount
        • Card
        • 3DSecure
        • Recurrent
        • 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
      • read
        • read payment
        • read request
      • edit
        • edit payment.refund
        • edit payment.reverse
        • edit payment.clearing
  • 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)
      • Operations' list
      • Statement extended
      • Create client
      • Edit client
      • Сards' list
      • Request' status
      • Create transaction
      • Clearing transaction
      • Refund transaction
      • Transaction info
      • Cardholder validation
      • Set limits
      • Limits list
    • 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
    • Implement SuperApp
      • Overview
      • Pay
      • Refund
    • Account
      • Settlement
        • Overview
        • Create payment
        • Payment status
    • Invoice
      GET
    • Create terminal
      POST
  1. Partner API

Invoice

Developing
GET
https://api.freedompay.kzhttps://api.freedompay.kz/v5/partner/invoice/info
A new group of methods Invoice has been added to the Partner API. This group is intended for retrieving information about a payment document.

Request

Query Params
payment_id
string 
required
Unique payment ID in the Aggregator system
Example:
{ "payment_id": 1234567890}

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 -g --request GET 'https://api.freedompay.kz/v5/partner/invoice/info?payment_id={    "payment_id": 1234567890}'

Responses

🟢200Success
application/json
Body
paymentStatus
string 
required
Document status (success, error, process, waiting, incomplete)
amount
number  | null 
required
Payment amount
>= 0.01<= 9999999999
currency
string 
required
Payment currency (alpha-3 format)
fee
number  | null 
optional
Customer fee (if specified, deducted along with amount)
>= 0.01<= 9999999999
discount
number  | null 
optional
Discount (informational only, already included in amount)
>= 0.01<= 9999999999
freedomId
string 
optional
User ID in the Freedom loyalty system
orderId
string 
required
Order ID
merchantId
string 
required
Unique seller ID
merchantName
string 
required
Merchant or seller name
description
string 
required
Order description
lifetime
string <date-time>
required
Payment lifetime (UTC)
facilitatorIBAN
string 
required
Aggregator's transit account number
mcc
string 
optional
Merchant Category Code (MCC)
Example
 {
        "paymentStatus": "success",
        "amount": 5000,
        "currency": "KZT",
        "fee": 0,
        "discount": 0,
        "freedomId": "FID123456987ID",
        "orderId": "payment_123",
        "merchantId": 555555,
        "merchantName": "Merchant name",
        "description": "Ticket",
        "lifetime": 86400,
        "facilitatorIBAN": ""KZ505518729251417KZT",
        "mcc": "5599",
        "dt": "2025-07-11T11:19:49+00:00"
    }
Modified at 2025-07-18 11:55:03
Previous
Payment status
Next
Create terminal