m2pfintech
API LibraryOnboarding

Register Card

Registers a new card for an existing customer in the DCMS system. This API is used when a customer already exists and needs a new card issued. The kitInfo array specifies the card details including the linked account number and card type. The deliveryAddress field determines which address to use for physical card delivery.

POST
/registerCard

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

Existing customer entity identifier to issue the card for.

deliveryAddress?string

Address type for physical card delivery.

Value in"PERMANENT" | "COMMUNICATION"
kitInfo*

Card details for issuance. At least one entry is required.

Response Body

application/json

application/json

curl -X POST "https://api.dcms.example.com/v1/registerCard" \  -H "tenant: ACME_BANK" \  -H "Content-Type: application/json" \  -d '{    "entityId": "676765",    "deliveryAddress": "PERMANENT",    "kitInfo": [      {        "accountNo": 8642135,        "cardType": "PHYSICAL"      }    ]  }'
{
  "result": {
    "entityId": "676765",
    "kitInfo": [
      {
        "accountNo": 8642135,
        "bin": "608040",
        "cardCategory": "DEBIT",
        "cardNumber": "608040XXXXXX6384",
        "cardStatus": "INACTIVE",
        "cardType": "PHYSICAL",
        "encryptedCardNumber": "44a938afd8c4c062ded334e77d5c5e6275dc6e1422d2d2af370f3a99dfbe7482",
        "entityId": "676765",
        "expDate": "2029-07-31T00:00:00.000+00:00",
        "kitNo": "4240181595",
        "networkType": "RUPAY",
        "productId": "2003_PHYSICAL",
        "productName": "2003_PHYSICAL"
      }
    ]
  },
  "exception": null,
  "pagination": null
}
{
  "result": null,
  "exception": {
    "errorCode": "CUS001",
    "shortMessage": "Customer not found",
    "detailMessage": "No customer found for the given entity ID",
    "httpStatus": "BAD_REQUEST",
    "fieldError": [
      "Invalid entityId"
    ],
    "languageCode": "en"
  },
  "pagination": null
}

Update Delivery Status POST

Updates the delivery status for one or more card kits. Accepts a list of delivery status groups, each containing a delivery status value and a list of kit numbers to update. Returns individual success or failure results for each kit number. Common delivery statuses include DELIVERED, BANK, IN_TRANSIT, and RETURNED.

Register Customer POST

Registers a new customer into the DCMS platform. This is the primary onboarding API that creates a customer profile with their personal information, KYC documents, address details, communication contacts, and bank account linkage. Optionally, a card can be issued as part of registration by including the kitInfo array in the request. This is commonly used for insta-card issuance where the card is issued at the time of account opening. The entityId must be unique and typically corresponds to the CIF number from the core banking system.