m2pfintech
API LibraryInventory Management

Update Delivery Status

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.

POST
/inventory/update/deliveryStatus

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

Response Body

application/json

curl -X POST "https://api.dcms.example.com/v1/inventory/update/deliveryStatus" \  -H "tenant: ACME_BANK" \  -H "Content-Type: application/json" \  -d '[    {      "deliveryStatus": "DELIVERED",      "kitNo": [        "10012192",        "10000843"      ]    },    {      "deliveryStatus": "BANK",      "kitNo": [        "234"      ]    }  ]'
{
  "result": [
    {
      "kitNo": "10012192",
      "result": true,
      "status": "200"
    },
    {
      "kitNo": "10000843",
      "result": true,
      "status": "200"
    },
    {
      "kitNo": "234",
      "status": "500",
      "exception": {
        "errorCode": "MCC007",
        "shortMessage": "valid kit not found",
        "detailMessage": "valid kit not found",
        "httpStatus": "BAD_REQUEST",
        "fieldError": [
          "Invalid Kit No"
        ],
        "cause": null,
        "languageCode": "en",
        "localizedMessage": null,
        "message": null,
        "suppressed": []
      }
    }
  ],
  "exception": null,
  "pagination": null
}

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.

Register Card POST

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.