m2pfintech
API LibraryClick To Pay

Remove customer from Click to Pay

Remove a customer and all their enrolled cards from the Visa Click to Pay network. Use this when a cardholder opts out entirely or withdraws consent.

The entity and all associated payment instruments transition to REMOVAL_IN_PROGRESS immediately and are set to REMOVED on successful webhook confirmation.

Validations:

  1. Entity must be registered on CTP
  2. Entity CTP status must be ACTIVE
POST
/Yappay/click-to-pay/v1/removeEntity

Authorization

BearerAuth TenantHeader
AuthorizationBearer <token>

JWT Bearer token obtained from the /auth/login endpoint

In: header

TENANT<token>

Tenant identifier provided by M2P (e.g. ENBDTABBY)

In: header

Request Body

application/json

entityId*string

Entity identifier to remove from CTP

Response Body

application/json

application/json

curl -X POST "https://api.m2p.com/Yappay/click-to-pay/v1/removeEntity" \  -H "Content-Type: application/json" \  -d '{    "entityId": "a2e3bd09-7676-4bc5-88c6-625483b29821"  }'
{
  "result": {
    "tenant": "ENDTABBY",
    "entityId": "a2e3bd09-7676-4bc5-88c6-625483b29821",
    "requestTraceId": "551562ba-83cf-11ee-b962-0242ac120004",
    "event": "CTP_REMOVE_ENTITY"
  },
  "exception": null,
  "pagination": null
}
{
  "result": null,
  "exception": {
    "detailMessage": "Not a registered Customer",
    "shortMessage": "Not a registered Customer",
    "errorCode": "Y109",
    "languageCode": "en"
  },
  "pagination": null
}

Register customer and card with Visa Click to Pay POST

Enroll a customer and their card with the Visa Click to Pay network in a single operation. This is the primary CTP onboarding API. The operation is asynchronous. On success, a requestTraceId is returned which can be used to poll the operation status via /click-to-pay/v1/fetchRequestStatus. Prerequisites: - Customer must be registered on M2P via v3/register or v4/register - Kit must be assigned to the entity - CTP must be enabled for the tenant (BUSINESSCUSTOMFIELD click.to.pay.enable) - Explicit cardholder consent must be obtained Validations performed: 1. entityId must be present and non-null 2. kitNo must be present and non-null 3. Entity must exist as a registered BusinessEntity 4. Customer status must be ACTIVE 5. Kit must be assigned to the entity 6. CTP must be enabled for the tenant When CTP is enabled with ALL scope (Y|ALL in business custom fields), registration is also triggered automatically during customer registration via v3/register and v4/register.

Remove a card from Click to Pay POST

Remove a specific card/kit from the Visa Click to Pay network without removing the customer enrollment. The customer remains active on CTP with their other cards. Validations: 1. Entity CTP status must be ACTIVE 2. Kit CTP status must be ACTIVE