m2pfintech
API LibraryCustomer Management

Fetch Kits by Entity ID V2

Enhanced version of Fetch Kits by Entity ID that returns encrypted card numbers using AES-GCM encryption. If the encrypted cardNumber field is configured for the bank, it will be encrypted using AES-GCM algorithm with a 16-byte random IV and 128-bit authentication tag. The encrypted value is Base64 encoded and combines the IV and ciphertext. Use the shared AES-GCM decryption key to decrypt the card number.

POST
/kit-manager/v2/fetchKitsByEntityId

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 to fetch kits for.

Response Body

application/json

curl -X POST "https://api.dcms.example.com/v1/kit-manager/v2/fetchKitsByEntityId" \  -H "tenant: ACME_BANK" \  -H "Content-Type: application/json" \  -d '{    "entityId": "181223116"  }'
{
  "result": [
    {
      "accountNo": "221000182316",
      "bin": "817649",
      "cardActivationDate": "2023-12-18T10:14:11.552+00:00",
      "cardCategory": "DEBIT",
      "cardNumber": "817649XXXXXX0662",
      "cardStatus": "REPLACED",
      "cardType": "PHYSICAL",
      "changedDate": "2024-06-16T06:04:53.241+00:00",
      "createdDate": "2023-12-18T10:14:11.552+00:00",
      "encryptedCardNumber": "QSMJ9ceNJME5YibrPtYk6yeRxOcQr59+7A/1AgWTFiQ=",
      "entityId": "181223116",
      "expDate": "2028-11-30T00:00:00.000+00:00",
      "kitNo": "10930010476",
      "networkType": "RUPAY",
      "productId": "RuPay_TRG_Classic_Debit_Physical",
      "productName": "RuPay_TRG_Classic_Debit_Physical",
      "tierType": "CLASSICONE"
    }
  ],
  "exception": null,
  "pagination": null
}