m2pfintech
API LibraryCard Lifecycle

Manage All Cards

Manages all cards associated with a mobile number or entity ID in a single operation. Supports BLOCK, LOCK, and UNLOCK operations across all cards. This is useful for scenarios like lost phone where all cards need to be blocked at once, or for bulk operations triggered by customer service. Either mobileNo or entityId must be provided to identify the cards.

POST
/kit-manager/manageAllKits

Authorization

tenantAuth
tenant<token>

The DCMS tenant name for multi-tenant isolation. Every API call must include this header to identify the client organization.

In: header

Header Parameters

tenant*string

The DCMS client or tenant name for multi-tenant isolation.

Request Body

application/json

mobileNo?string

Mobile number to identify all cards. Either mobileNo or entityId is required.

entityId?string

Customer entity identifier. Either mobileNo or entityId is required.

operation*string

Lifecycle operation to perform on all cards.

Value in"BLOCK" | "LOCK" | "UNLOCK"
reason?string

Reason for the bulk operation for audit purposes.

changer?string

Identifier of the user performing the operation.

channel?string

Channel through which the operation was initiated.

Value in"IVR" | "WEB" | "MOBILE" | "BRANCH"

Response Body

application/json

curl -X POST "https://api.dcms.example.com/v1/kit-manager/manageAllKits" \  -H "tenant: ACME_BANK" \  -H "Content-Type: application/json" \  -d '{    "mobileNo": "9876543210",    "operation": "BLOCK",    "reason": "CUSTOMER_REQUEST",    "changer": "user",    "channel": "IVR"  }'
{
  "result": {
    "managedCards": [
      {
        "kitNo": "4240181652",
        "cardNumber": "608040XXXXXX6954",
        "previousStatus": "ACTIVE",
        "currentStatus": "BLOCKED"
      },
      {
        "kitNo": "4240181653",
        "cardNumber": "608040XXXXXX6962",
        "previousStatus": "ACTIVE",
        "currentStatus": "BLOCKED"
      }
    ],
    "totalCardsManaged": 2,
    "operation": "BLOCK",
    "entityId": "req11"
  },
  "exception": null,
  "pagination": null
}

Kit Tracking POST

Tracks the delivery status of a card kit that was issued. Returns detailed shipment tracking information from the delivery service provider including origin, destination, expected delivery date, current status, and a full scan history showing each transit point the shipment has passed through.

Manage Existing Kits POST

Manages existing card kits by performing lifecycle operations such as BLOCK, LOCK, UNLOCK, REPLACE, and BLOCK_AND_REPLACE. LOCK temporarily disables the card and can be reversed with UNLOCK. BLOCK permanently disables the card. REPLACE issues a new card to replace the existing one. BLOCK_AND_REPLACE blocks the current card and issues a replacement in one operation. For REPLACE and BLOCK_AND_REPLACE operations, the cardType and deliveryAddress fields may be required.