Freedom Pay
  1. Settlement
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
      • Reccuring payment
      • 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
      • Merchant SDK
        • 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
      • Create terminal
    • E-Money
      • Overview
      • Add
      • Owner identification
      • Info
      • Close
      • Block
      • Balance
      • Statement
      • Request Status
    • Device ID
      • Android SDK
      • iOS SDK
    • Implement SuperApp
      • Overview
      • Pay
      • Refund
    • Account
      • Settlement
        • Overview
        • Create payment
          POST
        • Payment status
          GET
        • Batch statuses
          GET
    • Invoice
      GET
  1. Settlement

Batch statuses

Developing
GET
https://api.freedompay.kz/v5/partner/settlement-partitions/{OrgnlMsgId}/batch-statuses
XML TagTypeRequiredDescriptionConstraints
OrgnlMsgIdString+Identifier of the original message from pain.0011–35 characters, alphanumeric, may include hyphen (-) and underscore (_)

Request

Path Params

Request Code 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 GET 'https://api.freedompay.kz/v5/partner/settlement-partitions//batch-statuses'

Responses

🟢200Success
application/xml

Response Parameters:

TagNameDescription
GrpHdr
MsgIdMessage IDUnique message identifier
CreDtTmCreation Date TimeReport creation date and time
OrgnlGrpInfAndSts
OrgnlMsgIdOriginal Message IDUnique ID of the original request message (pain.001)
OrgnlMsgNmIdOriginal Message Name IDIndicates the type of the original message (e.g., pain.001.001.14)
GrpStsGroup StatusStatus of the batch (e.g., ACCP, RJCT, PART, PDNG)
OrgnlPmtInfAndSts
OrgnlPmtInfIdOriginal Payment Info IDID of the payment information section from pain.001
TxInfAndSts/EndToEndIdEnd-to-End IDUnique identifier of the individual payment instruction
TxInfAndSts/TxStsTransaction StatusPayment processing status (e.g., ACCP, RJCT, PDNG)
TxInfAndSts/AcctSvcrRefAccount Servicer ReferenceInternal identifier assigned by the servicing bank to the transaction
Body

Example
{
"status": "success",
"error_code": 0,
"error_description": "",
"document_type": "iso20022",
"document_body": "
<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n
<Document xmlns=\"urn:iso:std:iso:20022:tech:xsd:pain.002.001.14\">\n  
    <CstmrPmtStsRpt>\n    
        <GrpHdr>\n      
            <MsgId>k221YIoYrWbIbAnP133a07B5wmpEcJSOQ6X</MsgId>\n
            <CreDtTm>2025-11-05T10:40:24+00:00</CreDtTm>\n
        </GrpHdr>\n
        <OrgnlGrpInfAndSts>\n      
            <OrgnlMsgId>batch-payment-002</OrgnlMsgId>\n
            <OrgnlMsgNmId>pain.001.001.14</OrgnlMsgNmId>\n
            <GrpSts>PART</GrpSts>\n
        </OrgnlGrpInfAndSts>\n
        <OrgnlPmtInfAndSts>\n      
            <OrgnlPmtInfId>PMT-001</OrgnlPmtInfId>\n
            <TxInfAndSts>\n        
                <OrgnlEndToEndId>EXT-493723559479911</OrgnlEndToEndId>\n
                <OrgnlInstrId/>\n
                <TxSts>PDNG</TxSts>\n
                <AcctSvcrRef>176232737137</AcctSvcrRef>\n
            </TxInfAndSts>\n
            <TxInfAndSts>\n        
                <OrgnlEndToEndId>EXT-780273386982009</OrgnlEndToEndId>\n
                <OrgnlInstrId/>\n
                <TxSts>PDNG</TxSts>\n
                <AcctSvcrRef>176232737138</AcctSvcrRef>\n
            </TxInfAndSts>\n
            <TxInfAndSts>\n        
                <OrgnlEndToEndId>EXT-872174653393565</OrgnlEndToEndId>\n
                <OrgnlInstrId/>\n
                <TxSts>PDNG</TxSts>\n
                <AcctSvcrRef>176232737139</AcctSvcrRef>\n
            </TxInfAndSts>\n
        </OrgnlPmtInfAndSts>\n
    </CstmrPmtStsRpt>\n
</Document>\n",
    "dt": "2025-11-05T10:40:24+00:00"
}
Modified at 2025-11-11 10:18:26
Previous
Payment status
Next
Invoice