m2pfintech
API LibraryUnknown

Fetch entity details by search criteria

Fetches a paginated list of entity (customer/account) records matching the given search criteria and search type. Supports searching by entity ID or kit number (in credit-clms), or by a string criteria (in credit-customer-service). Returns full entity details including KIT info, credit details, block code info, and credit limits. The endpoint exists in both credit-clms (internal path) and credit-customer-service.

POST
/Yappay/business-entity-manager/fetchEntities

Query Parameters

pageNumber?integer

Zero-based page index (default: 0)

Default0
Range0 <= value
pageSize?integer

Number of records per page (default: 10)

Default10
Range1 <= value

Header Parameters

TENANT*string

Tenant identifier for multi-tenancy routing

Request Body

application/json

searchCriteria*string

The value to search for (entity ID, kit number, etc.)

searchType?string

The type of search to perform. In credit-clms: ENTITY_ID or KIT_NO.

Value in"ENTITY_ID" | "KIT_NO"

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://uat-m2p-ccms.m2pfintech.com/Yappay/business-entity-manager/fetchEntities" \  -H "TENANT: string" \  -H "Content-Type: application/json" \  -d '{    "searchCriteria": "CUST123456"  }'
{
  "status": 200,
  "result": [
    {
      "entityId": "string",
      "firstName": "string",
      "lastName": "string",
      "emailAddress": "user@example.com",
      "contactNo": "string",
      "entityType": "string",
      "kitInfo": [
        {
          "kitNo": "string",
          "cardStatus": "string",
          "cardType": "string",
          "expiryDate": "string",
          "networkType": "string",
          "productCode": "string"
        }
      ],
      "customerCredit": {
        "creditLimit": 0.1,
        "cashLimit": 0.1,
        "creditStatus": "string",
        "statementDay": 0
      },
      "customerBlockCodeInfo": [
        {
          "blockCode": "string",
          "blockCodeDescription": "string",
          "appliedDate": "2019-08-24"
        }
      ],
      "creditLimit": {
        "limitActual": 0.1,
        "limitAvailable": 0.1,
        "limitUtilized": 0.1,
        "cashLimit": 0.1,
        "creditBalance": 0.1
      }
    }
  ],
  "message": "Success",
  "pagination": {
    "pageNo": 0,
    "pageSize": 20,
    "totalPages": 5,
    "totalElements": 100,
    "isList": true
  }
}
{
  "status": 400,
  "message": "Invalid request parameters",
  "timestamp": "2019-08-24T14:15:22Z"
}
{
  "status": 400,
  "message": "Invalid request parameters",
  "timestamp": "2019-08-24T14:15:22Z"
}
{
  "status": 400,
  "message": "Invalid request parameters",
  "timestamp": "2019-08-24T14:15:22Z"
}

Fetch block code details for an entity POST

Returns detailed block code information for a given entity, including block reason, inducer, reversibility flag, effective date, and feature flags for statement generation, card issuance, and card controls.

Fetch statement as Base64 encoded string POST

Retrieves the PDF statement for a given entity and statement month and returns it as a Base64-encoded string. Supports optional encryption of the PDF.