m2pfintech
API LibraryCard Lifecycle

Manage Existing Kits

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.

POST
/kit-manager/manageKit

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

entityId*string

Customer entity identifier who owns the card.

oldKit*string

Kit number of the existing card to manage.

operation*string

Lifecycle operation to perform on the card. LOCK temporarily disables the card. UNLOCK reverses a LOCK. BLOCK permanently disables the card. REPLACE issues a new card. BLOCK_AND_REPLACE blocks and replaces in one step.

Value in"LOCK" | "UNLOCK" | "BLOCK" | "REPLACE" | "BLOCK_AND_REPLACE"
cardType?string

Card type for the replacement card. Required for REPLACE and BLOCK_AND_REPLACE operations.

Value in"PHYSICAL" | "VIRTUAL"
deliveryAddress?string

Address type for replacement card delivery. Used for BLOCK_AND_REPLACE with physical cards.

Value in"PERMANENT" | "COMMUNICATION"

Response Body

application/json

curl -X POST "https://api.dcms.example.com/v1/kit-manager/manageKit" \  -H "tenant: ACME_BANK" \  -H "Content-Type: application/json" \  -d '{    "entityId": "req11",    "oldKit": "4240181649",    "operation": "LOCK"  }'

{
  "result": {
    "status": true
  },
  "exception": null,
  "pagination": null
}

Manage All Cards POST

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.

Regeneration of PIN Mailer POST

Regenerates a PIN mailer for an existing card. A PIN mailer is a physical document sent to the customer containing their card PIN. The addressType specifies which address (PERMANENT or COMMUNICATION) to use for delivery. The homeCurrencyCode is required for processing.