Freedom Pay
  1. Account
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
      • Merchant SDK
        • Google Pay
        • Android
        • IOS
    • 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
    • Client
      • Create client
      • Edit client
      • Update client
      • Verify client
      • Client info
    • Transactions
      • Create transaction
      • Clearing transaction
      • Refund transaction
      • Transaction info
      • Transaction status
    • Activate card
      POST
    • Block card
      POST
    • Balance
      POST
    • Bulk issue
      POST
    • Card info
      POST
    • Сards' list
      POST
    • Card tokenization
      POST
    • Cardholder validation
      POST
    • Close card
      POST
    • Issue card
      POST
    • Issue plastic card
      POST
    • Limits list
      POST
    • Operations' list
      POST
    • Reset PIN counter
      POST
    • Request' status
      POST
    • Secret data
      POST
    • Set limits
      POST
    • Set PIN
      POST
    • Statement extended
      POST
    • Unblock card
      POST
    • Find card
      POST
  • 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
      • Overview
      • Create payment
        POST
      • Payment status
        GET
      • Batch statuses
        GET
    • Invoice
      GET
  1. Account

Batch statuses

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

Request

Path Params

Responses

🟢200Success
application/xml
TagNameDescription
GrpHdr
<MsgId>Message IDUnique message identifier
<CreDtTm>Creation Date TimeReport creation date and time
OrgnlGrpInfAndSts
<OrgnlMsgId>Original Message IDUnique ID of the original request message (pain.001)
<OrgnlMsgNmId>Original Message Name IDIndicates the type of the original message (e.g., pain.001.001.14)
<GrpSts>Group StatusStatus of the batch (e.g., ACCP, RJCT, PART, PDNG)
OrgnlPmtInfAndSts
<OrgnlPmtInfId>Original Payment Info IDID of the payment information section from pain.001
<TxInfAndSts>/<EndToEndId>End-to-End IDUnique identifier of the individual payment instruction
<TxInfAndSts>/<TxSts>Transaction StatusPayment processing status (e.g., ACCP, RJCT, PDNG)
<TxInfAndSts>/<AcctSvcrRef>Account 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"
}
Previous
Payment status
Next
Invoice