m2pfintech
API LibraryUnknown

Register Customer

Registers a new customer (individual or business entity) with credit info, KYC, kit info, address, communication, bank, and nominee details. Returns kit number, entity ID, and customer name fields.

POST
/credit-customer/register/customer

Header Parameters

TENANT*string

Tenant identifier

Request Body

application/json

entityId?string

Unique entity identifier

entityType*string
Value in"CUSTOMER" | "CORPORATE" | "DEPENDENT" | "BUSINESS"
customerId?string

Customer identifier

sorCustomerId?string

System of record customer ID

business?string

Business name or identifier

businessType?string

Type of business

businessId?string

Business identifier

parentEntityId?string

Parent entity ID for dependent customers

title?string
Value in"MR" | "MRS" | "MS" | "DR" | "PROF"
firstName?string

Customer first name

middleName?string

Customer middle name

lastName?string

Customer last name

gender?string
Value in"MALE" | "FEMALE" | "OTHER"
isNRICustomer?boolean

Flag for NRI customer

isMinor?boolean

Flag for minor customer

isDependant?boolean

Flag for dependent customer

overrideProgramBulkShipping?boolean

Override bulk shipping program flag

plasticCode?string

Plastic code for card customization

maritalStatus?string
Value in"SINGLE" | "MARRIED" | "DIVORCED" | "WIDOWED"
employmentIndustry?string
Value in"AGRICULTURE" | "BANKING" | "EDUCATION" | "GOVERNMENT" | "HEALTHCARE" | "IT" | "MANUFACTURING" | "RETAIL" | "OTHERS"
employmentType?string
Value in"SALARIED" | "SELF_EMPLOYED" | "BUSINESS" | "RETIRED" | "STUDENT" | "UNEMPLOYED"
creditInfo?
kitInfo?

Kit/card info list

addressInfo?

Address list

communicationInfo?

Communication info list

kycInfo?

KYC info list

dateInfo?

Date info list

accountInfo?

Bank account info list

nomineeDetail?

Nominee details list

externalEntityId?string

External entity identifier

employeeId?string

Employee ID

cardName?string

Name to be embossed on card

Lengthlength <= 21
fatherName?string

Father's name

Lengthlength <= 100
motherName?string

Mother's name

Lengthlength <= 100
spouseName?string

Spouse's name

Lengthlength <= 100
nationality?string

Customer nationality

Lengthlength <= 50
customerStatus?string
Value in"ACTIVE" | "INACTIVE" | "BLOCKED" | "CLOSED" | "SUSPENDED"
secretQuestions?

Secret questions and answers

metaData?

Additional metadata key-value pairs

ucic?string

Unique customer identification code

isCorporateCustomer?boolean

Flag to identify corporate customer

preferredLanguage?string

Customer's preferred language

isPhysicalPinRequired?boolean

Flag for physical PIN requirement

staffIndicator?boolean

Flag to indicate staff member

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://api.m2pfintech.com/credit-customer/register/customer" \  -H "TENANT: string" \  -H "Content-Type: application/json" \  -d '{    "entityId": "CUST20260617001",    "entityType": "CUSTOMER",    "parentEntityId": "PROG001",    "title": "MS",    "firstName": "Priya",    "lastName": "Sharma",    "gender": "FEMALE",    "maritalStatus": "SINGLE",    "employmentType": "SALARIED",    "creditInfo": {      "cardCategory": "INDIVIDUAL",      "cardLimit": 150000,      "cashLimit": 30000,      "statementDate": 15,      "statementDueDate": 5,      "creditStatus": "ACTIVE"    },    "kitInfo": [      {        "cardType": "VIRTUAL",        "cardRegStatus": "ACTIVE",        "aliasName": "PRIYA SHARMA",        "deliveryType": "STANDARD"      }    ],    "addressInfo": [      {        "address1": "42 MG Road",        "address2": "Apt 3B",        "city": "Bangalore",        "state": "Karnataka",        "country": "India",        "pinCode": "560001",        "addressCategory": "HOME"      }    ],    "communicationInfo": [      {        "contactNo": "9876543210",        "emailId": "priya.sharma@example.com",        "mobileCountryCode": "+91"      }    ],    "kycInfo": [      {        "kycRefNo": "KYC20260617001",        "documentType": "AADHAAR",        "documentNo": "XXXX-XXXX-1234"      }    ],    "dateInfo": [      {        "dateType": "DOB",        "date": "1990-01-15"      }    ]  }'
{
  "result": {
    "kitNo": "180010188",
    "entityId": "CUST20260617001",
    "status": "ACTIVE",
    "firstName": "Priya",
    "lastName": "Sharma"
  },
  "exception": null,
  "pagination": null
}
{
  "result": null,
  "exception": {
    "errorCode": "ERR_400",
    "shortMessage": "Bad Request",
    "detailMessage": "Validation error — check field values and enum constraints."
  },
  "pagination": null
}
{
  "result": null,
  "exception": {
    "errorCode": "ERR_401",
    "shortMessage": "Unauthorized",
    "detailMessage": "Missing or invalid TENANT header."
  },
  "pagination": null
}
{
  "result": null,
  "exception": {
    "errorCode": "ERR_500",
    "shortMessage": "Internal Server Error",
    "detailMessage": "An unexpected error occurred. Please try again later."
  },
  "pagination": null
}

Get Card List POST

Retrieves the list of cards associated with a customer, including card details such as status, type, expiry, and network type.

Replace Card POST

Initiates a card replacement request, optionally with a new kit, network type, and delivery address. Returns the replacement reference string.