Freedom Pay
  1. Payment Cards
Freedom Pay
  • Overview
  • Gateway API
    • Overview
    • Sync API
      • Overview
      • Purchase
        • Overview
        • Create payment
        • Any amount
        • Card
        • 3DSecure
        • 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
        • create payment recurrent
      • read
        • read payment
        • read request
      • edit
        • edit payment.refund
        • edit payment.reverse
        • edit payment.clearing
      • delete
  • 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
    • Result notify
    • Payout notify
    • Check request
  • Card API
    • Overview
    • Payment Cards
      • Overview
      • Dictionaries
      • Bulk issue
        POST
      • Issue card
        POST
      • Issue plastic card
        POST
      • Activate card
        POST
      • Block card
        POST
      • Unblock card
        POST
      • Set PIN
        POST
      • Reset PIN counter
        POST
      • Close card
        POST
      • Update client
        POST
      • Card info
        POST
      • Balance
        POST
      • Secret data
        POST
      • Secret data (version 2)
        POST
      • Statement
        POST
      • Statement extended
        POST
      • Create client
        POST
      • Edit client
        POST
      • Сards' list
        POST
      • Request' status
        POST
      • Create transaction
        POST
      • Clearing transaction
        POST
      • Refund transaction
        POST
      • Transaction request' status
        POST
      • Transaction info
        POST
    • 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
  1. Payment Cards

Close card

POST
https://api.freedompay.kz/v5/card-api/card/close
The card closure method is designed to terminate the use of a payment card and deactivate it within the system. This process is necessary in cases where the card is no longer needed, has expired, is being reissued, or at the request of the cardholder.
Once the operation is successfully completed, the card becomes unavailable for any transactions, including payments, cash withdrawals, and top-ups. Card closure is an irreversible operation.

Request

Body Params application/json
request_id
string 
required
Unique request ID in the partner system (UUID).
card_id
string 
required
Identifier of the card in Freedom Processing.
description
string 
required
Reason (test description from the client).
Example
{
  "request_id": "string",
  "card_id": "string",
  "description": "string"
}

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 --request POST 'https://api.freedompay.kz/v5/card-api/card/close' \
--header 'Content-Type: application/json' \
--data-raw '{
    "request_id": "string",
    "card_id": "string",
    "description": "string"
}'

Responses

🟢200Success
application/json
Body
status
string 
required
Status of the request. Possible values:
ok: Request completed successfully.
error: Request completed with an error.
request_status
string 
required
Execution status of the request. Refer to the documentation.
dt
string 
required
Date and time of the request (format: RFC 3339, YYYY-MM-DDThh:mm:ss+hh:mm).
Example
{
  "status": "string",
  "request_status": "string",
  "dt": "string"
}
Previous
Reset PIN counter
Next
Update client