1. Status
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
        • Get request result
      • 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
    • Mobile balance
      • Overview
      • Create mobile balance payment
      • Charge mobile balance
      • Confirm payment with SMS code
      • Resend SMS code
      • Get mobile balance payment status
    • Invoice
      • 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
        • 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
    • Installment
      • Overview
      • Status
        • Get application status
          GET
        • Application status notification
          POST
        • Change application status
          POST
      • Get partners
        GET
      • Create application
        POST
    • Saved cards
      • Get saved cards
      • Save card
      • Save card for payouts
      • Delete saved card
      • Save card without a charge
    • Redirect back
      POST
    • Result notify
      POST
    • Payout notify
      POST
    • Check request
      POST
  • Partner API
    • 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. Status

Change application status

Developing
KZ
https://api.freedompay.kz
KZ
https://api.freedompay.kz
POST
https://api.freedompay.kz
/v5/installment/applications/status
Sets the status of an application: canceled, delivered or refund.
Find the application by id or by external_id: pass one of them, not both.
A repeated request with the status the application already has returns 200 and does not change the application.

Change status flow#

Allowed transitions#

New statusFrom
cancelednew, consent_signed, pre_scoring_approved, bank_selected, scoring_rejected
deliveredsigned
refundsigned, delivered

Result#

HTTPMeaningNext step
200The status is set.—
400, 401, 404, 409, 422, 500The request is rejected.See «Errors» below.

Errors#

The body of an error: error_code and error_description. The texts of validation errors are in Russian.
HTTPerror_codeWhenWhat to do
4001001X-Request-Id is missing or is not a UUID.Pass a new UUID.
4013001The signature is invalid.Check the signature: see Invoice Overview.
4013002X-JWS-Signature is missing.Pass the signature.
4044001The application is not found.Check id or external_id.
4092001The transition is not allowed from the current status.Check the status with Get application status.
4092002The application is in a final status: pre_scoring_rejected, canceled, canceled_customer, expired or refunded.Do not repeat the request.
4221001Both id and external_id are passed, none of them, or status is not canceled, delivered or refund.Fix the request.
500, 5035000Internal error.Repeat the request later with a new X-Request-Id.

Request

Header Params

Body Params application/jsonRequired

Example
{
    "id": "0190c3e2-7f3a-7c1b-9e4d-2a6f8b1c4d55",
    "status": "delivered"
}

Responses

🟢200Success
application/json
Headers

Bodyapplication/json

Example
{
    "id": "0190c3e2-7f3a-7c1b-9e4d-2a6f8b1c4d55",
    "status": "delivered",
    "updated_at": "2026-10-31T16:00:00+05:00"
}
🟠400Bad Request
🟠401Unauthorized
🟠404Not Found
🟠409Conflict
🟠422Unprocessable Entity
🔴503Service Unavailable
Previous
Application status notification
Next
Get partners