m2pfintech
API LibraryCard Preferences

Set NCMC Preference

Sets or updates NCMC (National Common Mobility Card) specific preferences for a card. Currently supports configuring the auto-reload feature which automatically loads the wallet when the balance falls below a specified threshold amount.

POST
/ncmc/preference/set

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

entityId*string

Customer entity identifier.

kitNo*string

Kit number of the NCMC card.

accountNo?string

Account number to use for auto-reload funding.

autoReload?

Auto-reload configuration for the NCMC wallet.

channel?string

Channel through which the preference was set.

creator?string

Identifier of the user creating the preference.

changer?string

Identifier of the user making the change.

Response Body

application/json

curl -X POST "https://api.dcms.example.com/v1/ncmc/preference/set" \  -H "tenant: ACME_BANK" \  -H "Content-Type: application/json" \  -d '{    "entityId": "ENTITY123",    "kitNo": "KIT001",    "accountNo": "1234567890",    "autoReload": {      "enabled": true,      "threshold": 100,      "loadAmount": 500    },    "channel": "MOBILE",    "creator": "ENTITY123",    "changer": "ENTITY123"  }'
{
  "result": {
    "entityId": "ENTITY123",
    "kitNo": "KIT001",
    "accountNo": "1234567890",
    "autoReload": {
      "enabled": true,
      "threshold": 100,
      "loadAmount": 500
    },
    "channel": "MOBILE",
    "creator": "ENTITY123",
    "changer": "ENTITY123",
    "createdDate": "2024-01-15T10:30:00Z",
    "changedDate": "2024-01-15T10:30:00Z"
  },
  "exception": null,
  "pagination": null
}

Process Opt-In POST

Processes a customer opt-in or opt-out preference for a specific operation. The operation is specified in the URL path parameter and represents the feature being opted in or out of. The optedIn field controls whether the customer is opting in (true) or opting out (false). Supports audit fields for tracking who made the change.

Set Preference POST

Sets or updates the transaction preferences for a specific card. Allows configuring domestic and international transaction controls including enabling or disabling specific channels (ATM, POS, e-commerce, contactless), setting daily and maximum transaction limits, dynamic authentication settings (OTP and PIN), and swipe-to-pay configuration. The response returns the complete updated preference state including system-calculated monthly and yearly limits.