m2pfintech
API LibraryInventory Management

Fetch Kit Details From Inventory

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.

POST
/inventory/fetchKitDetailsFromInventory

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

refType*string

Reference type for the inventory lookup.

Value in"DC_KIT" | "PARENT_KIT"
kitRefNo?array<string>

List of kit reference numbers to look up (primary filter).

orderIds?array<string>

List of order IDs to filter by (primary filter).

branchId?string

Branch identifier to filter by (primary filter).

orderingPartyId?string

Ordering party identifier to filter by (primary filter).

orderingPartyType?string

Ordering party type (secondary filter, must combine with a primary filter).

fromDate?string

Start date for date range filter in ISO-8601 UTC format.

Formatdate-time
toDate?string

End date for date range filter in ISO-8601 UTC format.

Formatdate-time
kitStatus?string

Filter by kit status.

Value in"UNALLOCATED" | "LOCKED" | "BLOCKED" | "REPLACED" | "EXPIRED_CARD" | "INACTIVE" | "ACTIVE"
deliveryStatus?string

Filter by delivery status (case-insensitive).

pageNo?integer

Page number for pagination. Default is 1.

pageSize?integer

Number of records per page. Default is 10.

Response Body

application/json

curl -X POST "https://api.dcms.example.com/v1/inventory/fetchKitDetailsFromInventory" \  -H "tenant: ACME_BANK" \  -H "Content-Type: application/json" \  -d '{    "refType": "DC_KIT",    "kitRefNo": [      "10000853",      "10000854"    ],    "orderIds": [      "ORD-001",      "ORD-002"    ],    "branchId": "BRANCH001",    "orderingPartyId": "CREATOR01",    "orderingPartyType": "BANK",    "fromDate": "2025-01-01T00:00:00Z",    "toDate": "2025-12-31T23:59:59Z",    "kitStatus": "UNALLOCATED",    "deliveryStatus": "DELIVERED",    "pageNo": 1,    "pageSize": 10  }'
{
  "result": [
    {
      "bin": "12345678",
      "cardOrderName": "ORD-001",
      "cardType": "DEBIT",
      "deliveryStatus": "DELIVERED",
      "embossType": "NON_PERSONALIZED",
      "entityId": "12345",
      "expDate": "2027-12-31",
      "holder": null,
      "kitNo": "10000853",
      "networkType": "VISA",
      "orderCreatedDate": "2025-06-15T10:30:00Z",
      "owner": "BRANCH001",
      "product": "PRODUCT_A",
      "status": "UNALLOCATED"
    }
  ],
  "exception": null,
  "pagination": {
    "pageNo": 1,
    "pageSize": 10,
    "totalElements": 1,
    "totalPages": 1
  }
}

Fetch Card Order Details From Inventory POST

Retrieves card order details from the inventory system based on reference type. At least one primary filter must be provided such as orderIds, branchId, or orderingPartyId. The orderingPartyType is a secondary filter that must be combined with a primary filter. Returns the original order request data including branch information, product details, and delivery addresses. Supports date range filtering, order status filtering, and pagination.

Get Kit Summary POST

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.