1. Invoice
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
        POST
      • Get invoice status
        POST
      • Get invoice details
        POST
      • Cancel invoice
        POST
      • Refund invoice
        POST
    • 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
        • Application status notification
        • Change application status
      • Get partners
      • Create application
    • 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. Invoice

Cancel invoice

KZ
https://api.freedompay.kz
KZ
https://api.freedompay.kz
POST
https://api.freedompay.kz
/v5/merchant/invoice/cancel
Cancels an unpaid invoice: the client can no longer pay it.
Only an invoice in status new or process can be cancelled.
A paid invoice cannot be cancelled: use Refund invoice.
If state_callback was passed, a notification with status = canceled is sent.

Cancel flow#

Result#

HTTPMeaningNext step
200The invoice is cancelled: status = canceled.—
400, 401, 422, 500The request is rejected.See «Errors» below.

Errors#

The error is returned in error_description; error_code is returned for 401, 422 and for the 400 errors that have a code below.
HTTPerror_codeWhenWhat to do
4003001The invoice is not found.Check id.
4003003The invoice is already cancelled.Do not repeat the request.
4003004The invoice is paid or expired.Check the status with Get invoice status. To return a payment, use Refund invoice.
4019998The signature is invalid.Check the signature: see Overview.
4229403The X-JWS-Signature header is missing.Pass the signature.
500—A field is missing or invalid. error_description names the field.Fix the request.

Request

Header Params

Body Params application/jsonRequired

Example
{
    "id": "019d0652-4e2f-7f54-a179-007c80c48cef",
    "description": "Order cancelled by the client"
}

Responses

🟢200OK
application/json
Headers

Bodyapplication/json

Example
{
    "status": "canceled",
    "created_at": "2026-10-29T16:24:47+05:00"
}
🟠400Bad Request
🟠401Unauthorized
🟠422Unprocessable Entity
🔴500Internal Server Error
Previous
Get invoice details
Next
Refund invoice