Update a single card transaction channel preference
Enable or disable a single transaction channel for a customer card. This API updates one preference at a time. For bulk preference updates, use the setPreferences API instead which is more efficient.
Changes take effect immediately after a successful response. Use status ALLOWED to enable a channel and NOTALLOWED to disable it.
Supported channel types are ATM (cash withdrawals), POS (point of sale purchases), ECOM (online purchases), CONTACTLESS (tap-to-pay NFC payments), INTERNATIONAL (foreign currency transactions), and DCC (dynamic currency conversion at merchant).
Authorization
BearerAuth TenantHeader JWT Bearer token obtained from the /auth/login endpoint
In: header
Tenant identifier provided by M2P (e.g. ENBDTABBY)
In: header
Request Body
application/json
Customer ID for preference lookup
length <= 16Preference status value. Use ALLOWED to enable the channel and NOTALLOWED to disable it.
"ALLOWED" | "NOTALLOWED"Transaction channel type to update. ATM for cash withdrawals, POS for store purchases, ECOM for online purchases, CONTACTLESS for tap-to-pay, INTERNATIONAL for foreign transactions, DCC for dynamic currency conversion.
"ATM" | "POS" | "ECOM" | "CONTACTLESS" | "INTERNATIONAL" | "DCC"Kit number to apply preference to. Optional - if not provided, applies to the primary card.
length <= 20Response Body
application/json
curl -X POST "https://api.m2p.com/Yappay/business-entity-manager/updatePreferenceExternal" \ -H "Content-Type: application/json" \ -d '{ "entityId": "ABCDEF", "status": "NOTALLOWED", "type": "DCC" }'{
"result": true,
"exception": null,
"pagination": null
}Set multiple card preferences at once POST
Update multiple transaction channel preferences simultaneously for a customer card. This is the bulk alternative to the updatePreferenceExternal API and is recommended for initial preference setup to minimize the number of API calls. Only include the preferences you want to modify in the request body. Preferences not included will remain unchanged. All included preferences are updated at the same time. Changes take effect immediately. Boolean values control each channel - true to enable, false to disable. At least one preference should be provided in the request. Comparison with updatePreferenceExternal - setPreferences updates multiple preferences at once using boolean true/false values. updatePreferenceExternal updates one preference at a time using ALLOWED/NOTALLOWED strings. setPreferences requires fewer API calls for multiple changes.
Get secure card details widget URL POST
Generate a secure URL for displaying card details (card number, CVV, expiry date) via a hosted web view or APK. The URL contains a one-time random string and expires after a configured timeout period. This is the recommended secure method for displaying sensitive card details without exposing them directly in your application. The token parameter is an encrypted string composed of kitNo, entityId, and DOB (if configured). The returned URL is valid for a single use only. A new URL must be generated for each card details viewing session.