Z-Connect

Generate MPin

Documentations

Documentations for API

End Points

https://z-sandbox.jsbl.com/zconnect/api/v2/generateMpin

Http Method

POST

Header

Name	Type	Values	Description
Accept	JSON	application/json
Content-Type	JSON	application/json
clientId	String	*************
clientSecret	String	Access-Token	Auth2.0 verification
organizationId	String	223	Authenticate organization

Request Parameters

Name	Description	Required	Parameter Type	Length	Sample Value
processingCode	processingCode	Mandatory	STRING	12	GenerateMP
MerchantType	MerchantType	Mandatory	STRING	4	0088
TraceNo	TraceNo	Mandatory	STRING	6	000004
CompanyName	CompanyName	Mandatory	STRING	4	NOVA
DateTime	DateTime	Mandatory	STRING	14	2022072210
MobileNo	MobileNo	Mandatory	STRING	11	xxxxxxxxxx
TerminalId	TerminalId	Mandatory	STRING	4	NOVA
mPin	mPin	Mandatory	STRING	344	ZarH77yWmg
confirmMpin	confirmMpin	Mandatory	STRING	344	ZarH77yWmg

Sample Request

{
    "GenerateMpinRequest": {
        "processingCode": "GenerateMPIN",
        "merchantType": "0088",
        "traceNo": "000004",
        "companyName": "NOVA",
        "dateTime": "20220722103315",
        "mobileNo": "xxxxxxxxxxx",
        "terminalId": "NOVA",
        "mPin": "ZarH77yWmgdnieZNwITKvM7aYrwBN5NsmNtLw8yvhPJz0w\/jgsxcinpsvjLA2nab1O9A5IkwLq6QMKWduR4QoW4K\/7ZTK8Fxnrm6fCYCf78XSheT7jsZOoByY8kPYzk2BC2sZRLbdUnj8DolsaXfUBn+qiHqD70QtrvegqD8hEwe1HLojELFuW8ghFSFDVscBRdv04mWCqnzUcAVZ2rSyX\/Vj9\/HbxiqogvrWJCrKg5OZlz2RofDwMLb2UNjWrdn1pHx+OKpHG5tMJTKmhyl7HKXyvboTjT2VieaL87hsvIJW6RMx2sUe99UQg9VnCtyU6T1Q6s0CysIXUpUhnoFJw==",
        "confirmMpin": "ZarH77yWmgdnieZNwITKvM7aYrwBN5NsmNtLw8yvhPJz0w\/jgsxcinpsvjLA2nab1O9A5IkwLq6QMKWduR4QoW4K\/7ZTK8Fxnrm6fCYCf78XSheT7jsZOoByY8kPYzk2BC2sZRLbdUnj8DolsaXfUBn+qiHqD70QtrvegqD8hEwe1HLojELFuW8ghFSFDVscBRdv04mWCqnzUcAVZ2rSyX\/Vj9\/HbxiqogvrWJCrKg5OZlz2RofDwMLb2UNjWrdn1pHx+OKpHG5tMJTKmhyl7HKXyvboTjT2VieaL87hsvIJW6RMx2sUe99UQg9VnCtyU6T1Q6s0CysIXUpUhnoFJw=="
    }
}

Response Parameters

Name	Description	Parameter Type	Length	Sample Value
processingCode	processingCode	String	12	GenerateMPIN
MerchantType	MerchantType	String	4	0088
TraceNo	TraceNo	String	6	000004
CompanyName	CompanyName	String	4	NOVA
DateTime	DateTime	String	14	20220722103315
mobileNetwork	mobileNetwork	String	0
ResponseCode	ResponseCode	String	2	00
ResponseDetails	ResponseDetails	object	14	["Successful"]

Response Sample

{
    "GenerateMpinResponse": {
        "processingCode": "GenerateMPIN",
        "merchantType": "0088",
        "traceNo": "000004",
        "companyName": "NOVA",
        "dateTime": "20220722103315",
        "mobileNetwork": "",
        "responseCode": "00",
        "responseDetails": ["Successful"]
    }
}

Response Code Details

{
    "GenerateMpinResponse": {
        "processingCode": "GenerateMPIN",
        "merchantType": "0088",
        "traceNo": "000004",
        "companyName": "NOVA",
        "dateTime": "20220722103315",
        "mobileNetwork": "",
        "responseCode": "00",
        "responseDetails": ["Successful"]
    }
}

{
    "messages": "Bad Request - Invalid Access Token",
    "errorcode": "4001"
}

{
    "messages": "Bad Request - Invalid Request Payload",
    "errorcode": "4002"
}

{
    "messages": "Bad Request - Invalid Authorization Header",
    "errorcode": "4003"
}

{
    "messages": "Something Went Wrong",
    "errorcode": "4004"
}

{
    "messages": "Record Not Found",
    "errorcode": "4005"
}

{
    "messages": "Invalid Client Id\/Secret",
    "errorcode": "4006"
}

{
    "messages": "Bad Request - Invalid Access Token",
    "errorcode": "4007"
}

Try out yourself

Security

X-IBM-Client-Id(apiKey located in header)

X-IBM-Client-Secret(apiKey located in header)
1c48aa28-2614-486f-aa2c-cbc86cc7ab51

Header Parameter

Name	Values	Description
Content-Type	application/json	Content Type application/json is supported
Accept	application/json	Content Type application/json is supported
organizationId	xyz	You will make a call to the auth-blb api and give it your client ID. You should add the client secret and organisation ID it returns here.
clientId		Enter your verified Client Id
clientSecret		Enter Your Verified Client Secret

Request Body

{
    "GenerateMpinRequest": {
        "processingCode": "GenerateMPIN",
        "merchantType": "0088",
        "traceNo": "000004",
        "companyName": "NOVA",
        "dateTime": "20220722103315",
        "mobileNo": "xxxxxxxxxxx",
        "terminalId": "NOVA",
        "mPin": "ZarH77yWmgdnieZNwITKvM7aYrwBN5NsmNtLw8yvhPJz0w\/jgsxcinpsvjLA2nab1O9A5IkwLq6QMKWduR4QoW4K\/7ZTK8Fxnrm6fCYCf78XSheT7jsZOoByY8kPYzk2BC2sZRLbdUnj8DolsaXfUBn+qiHqD70QtrvegqD8hEwe1HLojELFuW8ghFSFDVscBRdv04mWCqnzUcAVZ2rSyX\/Vj9\/HbxiqogvrWJCrKg5OZlz2RofDwMLb2UNjWrdn1pHx+OKpHG5tMJTKmhyl7HKXyvboTjT2VieaL87hsvIJW6RMx2sUe99UQg9VnCtyU6T1Q6s0CysIXUpUhnoFJw==",
        "confirmMpin": "ZarH77yWmgdnieZNwITKvM7aYrwBN5NsmNtLw8yvhPJz0w\/jgsxcinpsvjLA2nab1O9A5IkwLq6QMKWduR4QoW4K\/7ZTK8Fxnrm6fCYCf78XSheT7jsZOoByY8kPYzk2BC2sZRLbdUnj8DolsaXfUBn+qiHqD70QtrvegqD8hEwe1HLojELFuW8ghFSFDVscBRdv04mWCqnzUcAVZ2rSyX\/Vj9\/HbxiqogvrWJCrKg5OZlz2RofDwMLb2UNjWrdn1pHx+OKpHG5tMJTKmhyl7HKXyvboTjT2VieaL87hsvIJW6RMx2sUe99UQg9VnCtyU6T1Q6s0CysIXUpUhnoFJw=="
    }
}