m2pfintech
API LibraryInventory Management

Get Kit Summary

Retrieves a paginated kit list or report with various filter options. Supports filtering by branchId, cardOrderId, productId, cardType, embossType, and deliveryStatus. Returns kit details including card numbers, statuses, entity associations, and embedded metadata. The branchId field is required as a mandatory filter.

POST
/inventory/fetchKitSummary

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

branchId*string

Branch identifier to filter kits by. This is a mandatory filter.

cardOrderId?string

Filter by specific card order identifier.

productId?string|null

Filter by product identifier.

cardType?string

Filter by card type.

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

Filter by emboss type.

Value in"PERSONALIZED" | "NON_PERSONALIZED"
deliveryStatus?string

Filter by delivery status.

pageNo?integer

Page number for pagination (zero-based).

pageSize?integer

Number of records per page.

Response Body

application/json

curl -X POST "https://api.dcms.example.com/v1/inventory/fetchKitSummary" \  -H "tenant: ACME_BANK" \  -H "Content-Type: application/json" \  -d '{    "branchId": "CORPORATE_NAME",    "cardOrderId": "Card Order Name",    "productId": null,    "cardType": "PHYSICAL",    "embossType": "PERSONALIZED",    "deliveryStatus": "DELIVERED",    "pageNo": 0,    "pageSize": 10  }'
{
  "result": {
    "result": [
      {
        "accountNo": "55555555555556782",
        "aliasName": "Test",
        "branchId": "BR002",
        "cardCategory": "DEBIT",
        "cardNumber": "6080390000022751",
        "cardStatus": "INACTIVE",
        "cardType": "VIRTUAL",
        "embeddedValues": {
          "parentKitNo": "656576"
        },
        "entityId": "Test2022",
        "expDate": "2029-07-31",
        "kitNo": "4240161732",
        "parentKitNo": "1406464682",
        "plasticCode": "71"
      }
    ],
    "pagination": {
      "list": true,
      "pageNo": 0,
      "pageSize": 10,
      "totalElements": 629699,
      "totalPages": 62970
    },
    "exception": null
  },
  "exception": null,
  "pagination": null
}

Fetch Kit Details From Inventory POST

Retrieves kit details from the inventory system based on reference type. The refType field is mandatory and can be DC_KIT for debit card kits or PARENT_KIT for parent kit references. At least one primary filter must be provided such as kitRefNo, orderIds, branchId, or orderingPartyId. The orderingPartyType is a secondary filter that must be combined with a primary filter. Optional filters include date ranges (ISO-8601 UTC format), kitStatus, and deliveryStatus. Supports pagination with default pageNo of 1 and pageSize of 10.

Transfer Kits Between Branches POST

Transfers card kits from one branch to another. This is used for inventory management when physical card kits need to be redistributed between branch locations. The API accepts a list of kit numbers and moves them from the source branch (fromBranch) to the destination branch (toBranch). Returns the count of successfully transferred kits and any failures.