m2pfintech
API LibraryCustomer Registration

Register a new credit customer

Registers a new credit customer (individual, corporate, or joint) in the system. Creates the customer profile including personal details, kit/card information, address, communication details, KYC, date information, bank account details, and nominee details. The endpoint maps internally to POST /credit-customer/register/customer.

POST
/v4/register

Header Parameters

TENANT*string

Tenant identifier for the request

X-TENANT-ID?string

Alternate tenant identifier header

Request Body

application/json

entityId?string

Unique entity identifier for the customer

entityType*string

Type of entity being registered

Value in"BUSINESS" | "CUSTOMER" | "CORPORATE" | "CUSTOMER_JOINT" | "PROGRAM" | "CORPORATE_CUSTOMER" | "CORPORATE_CUSTOMER_JOINT" | "GROUP"
customerId?string

Customer identifier

sorCustomerId?string

System of record customer ID

business?string

Business name

businessType?string

Type of business

businessId?string

Business identifier

parentEntityId?string

Parent entity identifier for linked/child customers

title?string

Customer title/salutation

Value in"Mr" | "mr" | "Ms" | "ms" | "Mrs" | "mrs" | "Sr" | "Jr" | "Dr" | "sr" | "jr" | "dr"
firstName?string

Customer first name

middleName?string

Customer middle name

lastName?string

Customer last name

gender?string

Customer gender

Value in"MALE" | "FEMALE" | "OTHER" | "M" | "F" | "T" | "O"
isNRICustomer?boolean

Whether the customer is a Non-Resident Indian

isMinor?boolean

Whether the customer is a minor

isDependant?boolean

Whether the customer is a dependant

overrideProgramBulkShipping?boolean

Whether to override program bulk shipping settings

plasticCode?string

Plastic/card design code

maritalStatus?string

Customer marital status

Value in"SINGLE" | "MARRIED" | "OTHER" | "DIVORCED" | "WIDOWED" | "NA"
employmentIndustry?string

Industry of employment

Value in"AGRICULTURE_FOOD_NATURAL_RESOURCES" | "ARCHITECTURE_AND_CONSTRUCTION" | "ARTS_AUDIO_OR_VIDEO_TECHNOLOGY_AND_COMMUNICATIONS" | "BUSINESS_MANAGEMENT_AND_ADMINISTRATION" | "EDUCATION_AND_TRAINING" | "FINANCE" | "GOVERNMENT_AND_PUBLIC_ADMINISTRATION" | "HEALTH_SCIENCE" | "HOSPITALITY_AND_TOURISM" | "HUMAN_SERVICES" | "INFORMATION_TECHNOLOGY" | "LAW_PUBLIC_SAFETY_CORRECTIONS_AND_SECURITY" | "MANUFACTURING" | "MARKETING_SALES_AND_SERVICE" | "SCIENCE_TECHNOLOGY_ENGINEERING_AND_MATHEMATICS" | "TRANSPORTATION_DISTRIBUTION_AND_LOGISTICS"
employmentType?string

Type of employment

Value in"EMPLOYED" | "UNEMPLOYED" | "ENTREPRENEUR" | "PUBLIC_SECTOR_EMPLOYEE" | "FREELANCER" | "HOUSEWORK" | "APPRENTICE" | "RETIRED" | "STUDENT" | "SELF_EMPLOYED" | "MILITARY_OR_COMMUNITY_SERVICE" | "SALARIED" | "HOUSEWIFE"
creditInfo?

Credit account configuration details

kitInfo?

Card/kit information list

addressInfo?

List of customer addresses

communicationInfo?

Customer communication details (phone, email)

kycInfo?

KYC document information list

dateInfo?

Important date information list (DOB, marriage, etc.)

accountInfo?

Bank account details

nomineeDetail?

Nominee details list

externalEntityId?string

External system entity identifier

employeeId?string

Employee identifier

cardName?string

Name to be embossed on the card (max 21 characters)

Lengthlength <= 21
fatherName?string

Father's name (max 100 characters)

Lengthlength <= 100
motherName?string

Mother's name (max 100 characters)

Lengthlength <= 100
spouseName?string

Spouse's name (max 100 characters)

Lengthlength <= 100
nationality?string

Customer nationality (max 50 characters)

Lengthlength <= 50
customerStatus?string

Customer credit account status

Value in"ACTIVE" | "INACTIVE" | "ACTIVATED" | "BLOCKED" | "CLOSED" | "IN_PROGRESS" | "WRITE_OFF" | "SETTLEMENT" | "POST_WO_SETTLED" | "EXPIRED"
secretQuestions?

List of secret question-answer pairs (key-value map)

metaData?

Additional metadata as key-value pairs

ucic?string

Unique Customer Identification Code

isCorporateCustomer?boolean

Whether the customer is a corporate customer

preferredLanguage?string

Customer preferred language

isPhysicalPinRequired?boolean

Whether a physical PIN mailer is required

staffIndicator?boolean

Whether the customer is a bank staff member

deleted?boolean

Soft delete flag

created?string

Record creation timestamp

Formatdate-time
changed?string

Record last update timestamp

Formatdate-time
creator?string

Record creator identifier

changer?string

Record last updater identifier

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://api.m2pfintech.com/v4/register" \  -H "TENANT: string" \  -H "Content-Type: application/json" \  -d '{    "entityType": "BUSINESS"  }'
{
  "result": {
    "kitNo": "180010188",
    "entityId": "CUST20260617001",
    "status": "ACTIVE",
    "firstName": "Priya",
    "lastName": "Sharma",
    "sorCustomerId": "SOR123456",
    "kycStatus": "VERIFIED"
  },
  "exception": null,
  "pagination": null
}
{
  "result": null,
  "exception": {
    "errorCode": "ERR_400",
    "shortMessage": "Bad Request",
    "detailMessage": "Invalid or missing required fields in the request payload."
  },
  "pagination": null
}
{
  "result": null,
  "exception": {
    "errorCode": "ERR_401",
    "shortMessage": "Unauthorized",
    "detailMessage": "Missing or invalid authentication credentials."
  },
  "pagination": null
}
{
  "result": null,
  "exception": {
    "errorCode": "ERR_500",
    "shortMessage": "Internal Server Error",
    "detailMessage": "An unexpected error occurred. Please try again later."
  },
  "pagination": null
}

API Library

Complete REST API reference for the M2P Retail Credit Card v1.1 platform.

Preview outstanding balance before account closure (v2) POST

Validates and returns a preview of the outstanding balance and charges that would apply if the account were to be closed. Version 2 includes additional validation checks before returning the closure preview.