Artha API
  1. Card Operations
  • Introduction
  • Authentication
  • KYC/KYB Requirements
  • API Setup Guide
  • Customers
    • Create Customer
      POST
    • List Customers
      GET
    • Get Customer
      GET
    • Update Customer
      PATCH
  • Cards
    • Submit KYC/KYB Applicant
      POST
    • Issue Card
      POST
    • Cards List
      GET
    • Get Card
      GET
    • Get Sensitive Card Details
      GET
  • Card Operations
    • Activate Card
      POST
    • Freeze Card
      POST
    • Unfreeze Card
      POST
    • Cancel Card
      POST
    • Replace Card
      POST
    • Set / Reset Card PIN
      POST
    • Get Card Limits
      GET
    • Update Card Limits
      POST
  • Funding
    • Top Up Card
      POST
    • Get Card Balance
      GET
    • List Top-Up History
      GET
  • Transactions
    • List All Transactions
      GET
    • List Card Transactions
      GET
    • List Customer Transactions
      GET
    • Get Transaction
      GET
  • Products
    • List Products
    • Get Product
  • Utilities
    • Upload Documents
  • Webhook's
    • Webhooks
  1. Card Operations

Cancel Card

POST
{{baseUrl}}/api/v1/cards/{cardId}/cancel
Permanently cancels a card. This action is irreversible. A reason must be provided.
Common reasons: lost, stolen, fraud, customer_request, account_closure
Cancellation fees may apply depending on the product configuration. Any remaining balance should be handled separately.

📋 Request Body Fields#

⚠️ Required Fields
FieldTypeDescriptionConstraints
reasonstringReason for cancellation (max 500 chars). E.g., lost, stolen, customer_request. Example: Customer reported card as lost.Max length: 500

📤 Response Fields#

FieldTypeDescriptionNotes
card_idstring (uuid)--
customer_idstring (uuid)--
product_idstring-nullable
card_typestring-nullable
actionstringThe operation performed: activate, freeze, unfreeze, cancel, replace, set_pin. Example: activate-
statusstringNew card status after the operation. Example: active-
messagestring-nullable
task_idstringAsync task ID for operations processed in the background.nullable
performed_atstring (date-time)--

Request

Path Params

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200
application/json
Card cancelled permanently.
Body

🟠401
🟠404
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request POST '{{baseUrl}}/api/v1/cards/a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11/cancel' \
--header 'X-API-Key;' \
--header 'X-Signature;' \
--header 'X-Timestamp;' \
--header 'X-Nonce;' \
--header 'X-Body-Hash;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "reason": "Customer reported card as lost."
}'
Response Response Example
200 - Example 1
{}
Modified at 2026-02-18 13:24:04
Previous
Unfreeze Card
Next
Replace Card
Built with