Customer Onboarding-BULK

Request Method :: POST

Base URL: Will be shared later.

Endpoint: /ppcard/mw/user/create_customer

Description: This API will be used for customer on boarding in BULK. Customers can be onboarded by the Program manager admin.

Headers

Content-Type: application/JSON

header_secrets: These values must be generated each time while consuming the API (refer to the generation process mentioned in the note above).

client_id: To be shared during integration by ISU Team

Request Body Parameters

Parameters	Parameter description	Sample	Data type	Mandatory/Optional
productCategory	Product Category	GIFT / GPR	String	Mandatory
productName	Name of the Product	GIFTINVENTORY TESTPR	string	The product name must start with a capital letter and contain only alphanumeric characters and spaces Mandatory
title	User's title name	E.g., Mr,Mrs,Ms	String	Mandatory (only forGPR)
firstName	User's First name	Situl	String	Mandatory
lastName	User's Last name	Mohanty	String	Mandatory
mobileNumber	User's mobile number	8763351549	Numeric String	Mandatory
latLong	User's latitude and longitude coordinates	19.0759837,72.8776559	String	Mandatory
email	email address of the user	e.g. - "[email protected]"	String	Mandatory (only for GPR)
dateOfBirth	User's date of birth	E.g.- 1998-05-15	String	Mandatory (only for GPR)
ovdId	Identification number of the OVD	E.g.-5364758656879	String	Mandatory (only for GPR)
ovdType	Type of official valid document(OVD)	AADHAAR/ PAN/VOTERID/ DL/PASSPORT	String	Mandatory (only for GPR)
gender	User's gender	E.g. "Male" ,"Female" or "Other"	String	Mandatory (only for GPR)
pinCode	User's postal code	751024	Integer	Mandatory (only for GPR)
state	User's state of residence	ODISHA	String	Mandatory (only for GPR)
city	City	SBP	String	Mandatory (only for GPR)
address	User's full address	bbsr	String	Mandatory (only for GPR)
channel	It should be either ANDROID OR WEB	WEB	String	Mandatory
additionalFields	Depending upon program manager additional Fields will be marked	Depending upon program manager additional Fields will be marked	Object	Optional
persoType	card personalization type	Perso type should be either Personalized or Non Personalized	String	Mandatory
cardNature	Nature of the card	V	String	Mandatory
cardRefNo	Card Reference Number	1500000001	String	Mandatory (only for non personalized user)

Sample Request Body

GIFT(Personalized):

{ "customerData": [ { "firstName": "Situl", "lastName": "Mohanty", "additionalFields": { "amount": "15" }, "latLong": "19.0759837,72.8776559", "mobileNumber": "8763367849", "channel": "WEB", "cardNature":"V", "productName": "FlexiGift Card", "productCategory": "GIFT", "persoType": "Personalized" } ] }

GIFT - Non-Personalized:

{ "customerData": [ { "productCategory": "GIFT", "productName": "GIFTINVENTORYTESTPR", "firstName": "Situl", "lastName": "Mohanty", "mobileNumber": 8763351549, "latLong": "19.0759837,72.8776559", "channel": "WEB", "additionalFields": { "amount": "2" }, "persoType": "NonPersonalized", "cardNature": "P", "cardRefNo": "1500000001" } ] }

GPR (Personalized):

{ "customerData": [ { "firstName": "Situl", "lastName": "Mohanty", "email": "8608823187@gmail.com", "additionalFields": { "amount": 15 }, "dateOfBirth": "2001-12-25", "gender": "Male", "latLong": "19.0759837,72.8776559", "mobileNumber": "8763367849", "channel": "WEB", "cardNature":"V", "productName": "FlexiGift Card", "productCategory": "GIFT", "persoType": "Personalized", "ovdId": "733255314014", "ovdType": "AADHAAR", "city": "Chennai", "address": "Sriperumbattur", "pinCode": 602105, "state": "Tamilnadu" } ] }

GPR (Non-Personalized):

{ "customerData": [ { "productCategory": "GPR", "productName": "PMOWNINVENTORY", "title": "Mr", "firstName": "Manish", "lastName": "Malhotra", "mobileNumber": "8658024224", "email": "8658022424@gmail.com", "dateOfBirth": "1998-05-15", "gender": "Male", "latLong": "34567989", "channel": "WEB", "ovdId": "536471488501", "ovdType": "AADHAAR", "city": "SBP", "address": "Bhubaneswar", "pinCode": 751024, "state": "ODISHA", "additionalFields": { "amount": 5 }, "cardNature": "P", "persoType": "NonPersonalized", "cardRefNo": "1500000001" } ] }

Response Body Parameters

Parameters	Parameter Description	Data type
statusCode	Status Code of the operation (0/1)	String
statusmessage	Status message for the operation. SUCCESS/FAILED	String
SRTicketNo	SR Ticket Number. E.g. - SR20240919143046463	String
statusDesc	Status Description. E.g. - BLKPCSUC1 - Validated Successfully. Processing Customer Creation	String

Sample Response Body

SUCCESS:

{ "statusCode": 0, "status": "SUCCESS", "statusDesc": "BLKPCSUC1 - Validated Successfully. Processing Customer Creation.", "srTicketNo": "SR20250722154943847" }

FAILED:

{ "statusCode": 1, "status": "FAILED", "statusDesc": "First Name is invalid" }

Detailed Status Codes

Status Code	Status	Description
0	SUCCESS	BLKPCSUC1 - Validated Successfully.Processing Customer Creation
1	FAILED	First Name is invalid