Cancel Card Order
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.
Authorization
tenantAuth The DCMS tenant name for multi-tenant isolation. Every API call must include this header to identify the client organization.
In: header
Header Parameters
The DCMS client or tenant name for multi-tenant isolation.
Request Body
application/json
Order identifier to cancel.
Branch identifier that placed the order.
Response Body
application/json
application/json
curl -X POST "https://api.dcms.example.com/v1/card-order/cancel" \ -H "tenant: ACME_BANK" \ -H "Content-Type: application/json" \ -d '{ "orderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "branchId": "12345" }'{
"result": "Order cancelled successfully",
"exception": null,
"pagination": null
}{
"result": null,
"exception": {
"errorCode": "ORD003",
"shortMessage": "Order cannot be cancelled",
"detailMessage": "The order is not in a cancellable state",
"httpStatus": "BAD_REQUEST",
"fieldError": [
"Order status is PROCESSED and cannot be cancelled"
],
"languageCode": "en"
},
"pagination": null
}Card Upgrade POST
Upgrades an existing card to a higher tier or different product variant. The existing card identified by kitNo will be replaced with a new card of the specified tier type and product. The kitInfo array specifies the desired card characteristics including alias name, card type, plastic code, and tier type for the upgrade.
Create Card Order for DC Kits POST
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.