m2pfintech
API LibraryCard Order Management

Create Card Order for DC Kits

Creates a new card order without file upload for debit card (DC) kits. Allows branch users to place bulk card orders by specifying branch details, product information, delivery preferences, and scheduling. The order supports multiple products with different BINs and configurations. Each product can have its own quantity, plastic code, PAN length, and PIN generation settings. The order goes through processing stages including RECEIVED, PENDING, PROCESSED, and may end in SUCCESS or FAILED.

POST
/card-order

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

orderId?string

Unique order identifier for tracking.

branchInfo?

Branch details for the order.

address?string

Delivery address with fields separated by tilde (~) character.

pinCode?string

Postal code for the delivery address.

orderingPartyInfo?

Details about who placed the order.

metaValues?

Custom metadata key-value pairs for the order.

processStartTime?string

Scheduled processing start time in YYYY-MM-DD HH:mm:ss format.

validity?integer

Order validity period in days.

products?

List of products to order.

Response Body

application/json

application/json

curl -X POST "https://api.dcms.example.com/v1/card-order" \  -H "tenant: ACME_BANK" \  -H "Content-Type: application/json" \  -d '{}'
{
  "result": "success",
  "exception": null,
  "pagination": null
}
{
  "result": null,
  "exception": {
    "errorCode": "ORD001",
    "shortMessage": "Invalid order request",
    "detailMessage": "The card order request contains invalid or missing fields",
    "httpStatus": "BAD_REQUEST",
    "fieldError": [
      "branchInfo is required",
      "At least one product is required"
    ],
    "languageCode": "en"
  },
  "pagination": null
}

Cancel Card Order POST

Cancels a card order that is in a cancellable state such as RECEIVED. Both the orderId and branchId must match the original order for the cancellation to succeed. Orders that have already been processed or are in PENDING state at CMS may not be cancellable.

Create Card Order With File Upload For PGK Kits POST

Creates a new card order with file upload for PGK (Pre-Generated Kit) cards. This API is similar to the standard card order creation but includes a fileName field referencing a previously uploaded file via the uploadFile endpoint. The file contains pre-generated card data that will be used for the order. Use the uploadFile endpoint first to upload the file, then reference its name in this request.