m2pfintech
API LibraryCard Management

Get full customer details by entity ID

Retrieve comprehensive customer details including personal information, address, preferences, KYC documents, and associated card (kit) list by entity ID.

The response includes a kitList array with each card's kitNo, status, cardType, and description. The primary card (first ALLOCATED card) is set as the top-level kitNo and cardType.

Use the v1 variant (/v1/fetchEntityByEntityid/{entityId}) to receive address details in the preference object format instead of the flat addressDto format.

When Click to Pay is enabled, use the CTP-specific fetchEntityDetails endpoint (/Yappay/click-to-pay/v1/fetch-entity-details) to retrieve CTP enrollment status per card.

GET
/Yappay/business-entity-manager/fetchEntityByEntityid/{entityId}

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

Path Parameters

entityId*string

Unique entity ID of the customer

Lengthlength <= 16

Response Body

application/json

application/json

curl -X GET "https://api.m2p.com/Yappay/business-entity-manager/fetchEntityByEntityid/ABCDEF"
{
  "result": {
    "firstName": "John",
    "lastName": "Doe",
    "entityId": "ABCDEF",
    "contactNo": "9876543210",
    "emailAddress": "john.doe@example.com",
    "entityType": "CUSTOMER",
    "customerType": "PREPAID",
    "productId": "PROD001",
    "businessId": "BIZ001",
    "isBlocked": false,
    "isDependent": false,
    "kitNo": "10000001",
    "cardType": "PHYSICAL",
    "entityGender": "Male",
    "address": "123 Main Street",
    "address2": "Apt 4B",
    "city": "Mumbai",
    "state": "Maharashtra",
    "country": "India",
    "pincode": 400050,
    "kitList": [
      {
        "kitNo": "10000001",
        "status": "ALLOCATED",
        "cardType": "PHYSICAL",
        "description": "NA",
        "pinSet": true
      }
    ],
    "addressDto": null,
    "document": null
  },
  "exception": null,
  "pagination": null
}
{
  "result": null,
  "exception": {
    "detailMessage": "Invalid Customer Id",
    "shortMessage": "Invalid Customer Id",
    "errorCode": "Y109",
    "languageCode": "en"
  },
  "pagination": null
}

Reverse a previous transaction POST

Reverse a previously completed transaction. Supports both full and partial reversals. For a full reversal, omit the amount field or set it equal to the original transaction amount. For a partial reversal, provide the partial amount (must be less than the original). The partial reversal amount must not exceed the original transaction amount. The originalTransactionId identifies which transaction to reverse. A transaction can only be reversed once for full reversals. Multiple partial reversals are allowed as long as the total does not exceed the original amount.

Fetch card transaction channel preferences POST

Retrieve the current preference configuration for a customer card. Returns the enabled or disabled status for each transaction channel (ATM, POS, ECOM, CONTACTLESS, INTERNATIONAL, DCC). Also returns advanced rule configurations if configured for the tenant, including allowed and disallowed rules for transaction origins, MCC (Merchant Category Code) groupings, and country groupings. Transaction limits, cash limits, and category-specific limit configurations are included when configured for the customer.