m2pfintech
API LibraryInventory Management

Fetch Card Order Details From Inventory

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.

POST
/inventory/fetchCardOrderDetailsFromInventory

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"
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).

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
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/fetchCardOrderDetailsFromInventory" \  -H "tenant: ACME_BANK" \  -H "Content-Type: application/json" \  -d '{    "refType": "DC_KIT",    "orderIds": [      "ORD-001",      "ORD-002"    ],    "branchId": "BRANCH001",    "orderingPartyId": "CREATOR01",    "fromDate": "2025-01-01T00:00:00Z",    "toDate": "2025-12-31T23:59:59Z",    "pageNo": 1,    "pageSize": 10  }'
{
  "result": [
    {
      "orderId": "ORD-001",
      "address": "123 Main St",
      "pinCode": "600001",
      "branchInfo": {
        "branchId": "BRANCH001",
        "branchName": "Main Branch"
      },
      "orderingPartyInfo": {
        "orderingPartyId": "CREATOR01",
        "orderingPartyType": "BANK"
      },
      "products": [
        {
          "bin": "12345678",
          "productId": "PROD-001",
          "quantity": 100
        }
      ]
    }
  ],
  "exception": null,
  "pagination": {
    "pageNo": 1,
    "pageSize": 10,
    "totalElements": 1,
    "totalPages": 1
  }
}

Expire Insta Kits POST

Expires unassigned insta-kits that have not been allocated to any customer. This is used for inventory cleanup when insta-card kits that were pre-generated are no longer needed. Either the kitNo or parentKitNo can be provided to identify the kit or kits to expire.

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.