MPin Validation

Documentations

Documentations for API

End Points

https://z-sandbox.jsbl.com/zconnect/api/v1/mpinValidation

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
MobileNumber MobileNumber Mandatory STRING 0318231838
DateTime DateTime Mandatory STRING 2023042718
TraceNo TraceNo Mandatory STRING 673886
ChannelId ChannelId Mandatory STRING KUICKPAY
TerminalId TerminalId Mandatory STRING KUICKPAY
Mpin Mpin Mandatory STRING RW5DzQYRVQ

Sample Request

{
    "MpinValidation": {
        "MobileNumber": "03182318381",
        "DateTime": "20230427181818",
        "TraceNo": "673886",
        "ChannelId": "KUICKPAY",
        "TerminalId": "KUICKPAY",
        "Mpin": "RW5DzQYRVQo4tBdO0KpZ9LmGzVKL6V3plfBtTBwFaVpbJfk0TuVSvaPeJMKlvQ8cxbcd9Q6RWRvH6kcs\/QU2OcVdFfFEkRL23pkzpRkMP4FZsFt0\/ZFRDGJbj9TfQ+XnM0T4CWlpRFuCvghIisG0ec8S0H+LqEIfINlKMleK8p9WgULvUfyeURig3yuz8o8fO9fYzsfkk\/UlQPzzlcFL3PPvEIjVDOcGOmiTylLTwspmw8s0xH6MsaqLQF3yE9vtzNCbh7\/qM0xNbbKcu50ET+fhhvc7HKl29zC\/4aBYbPjagvlQNnkf+QCxhTtV1CRPW1Qds3EkNwcWcYaD3CjUwA=="
    }
}

Response Parameters

Name Description Parameter Type Length Sample Value
ResponseDescription ResponseDescription String Successful
ResponseCode ResponseCode String 00
TraceNo TraceNo String 673886

Response Sample

{
    "MpinValidation": {
        "ResponseDescription": "Successful",
        "ResponseCode": "00",
        "TraceNo": "673886"
    }
}
curl --location --request POST 'https://z-sandbox.jsbl.com/zconnect/api/v1/mpinValidation' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'clientId: 364E9806o51K9' \
--header 'clientSecret: eyJhbGciOiJIUzUxMiJ9.eyJleHAiOjE2OTI2MzcxOTl9.0s3evOaGFm6uyRxSioiXlOffHbZTDIB1zB1xl3ck_IIfxSrsARI9tPiooIOVjVv9rQqUInqtk1odcWtk8V3rFA' \
--header 'organizationId: 223' \
--data-raw '{
   "MpinValidation": {
       "MobileNumber": "03182318381",
       "DateTime": "20230427181818",
       "TraceNo": "673886",
       "ChannelId": "KUICKPAY",
       "TerminalId": "KUICKPAY",
       "Mpin": "RW5DzQYRVQo4tBdO0KpZ9LmGzVKL6V3plfBtTBwFaVpbJfk0TuVSvaPeJMKlvQ8cxbcd9Q6RWRvH6kcs\/QU2OcVdFfFEkRL23pkzpRkMP4FZsFt0\/ZFRDGJbj9TfQ+XnM0T4CWlpRFuCvghIisG0ec8S0H+LqEIfINlKMleK8p9WgULvUfyeURig3yuz8o8fO9fYzsfkk\/UlQPzzlcFL3PPvEIjVDOcGOmiTylLTwspmw8s0xH6MsaqLQF3yE9vtzNCbh7\/qM0xNbbKcu50ET+fhhvc7HKl29zC\/4aBYbPjagvlQNnkf+QCxhTtV1CRPW1Qds3EkNwcWcYaD3CjUwA=="
   }
}'
var request = require('request');
var options = {
 'method': 'POST',
 'url': 'https://z-sandbox.jsbl.com/zconnect/api/v1/mpinValidation',
 'headers': {
   'Content-Type': 'application/json',
   'Accept': 'application/json',
   'clientId': '364E9806o51K9',
   'clientSecret': 'eyJhbGciOiJIUzUxMiJ9.eyJleHAiOjE2OTI2MzcxOTl9.0s3evOaGFm6uyRxSioiXlOffHbZTDIB1zB1xl3ck_IIfxSrsARI9tPiooIOVjVv9rQqUInqtk1odcWtk8V3rFA',
   'organizationId': '223'
 },
 body: JSON.stringify({
   "MpinValidation": {
     "MobileNumber": "03182318381",
     "DateTime": "20230427181818",
     "TraceNo": "673886",
     "ChannelId": "KUICKPAY",
     "TerminalId": "KUICKPAY",
     "Mpin": "RW5DzQYRVQo4tBdO0KpZ9LmGzVKL6V3plfBtTBwFaVpbJfk0TuVSvaPeJMKlvQ8cxbcd9Q6RWRvH6kcs/QU2OcVdFfFEkRL23pkzpRkMP4FZsFt0/ZFRDGJbj9TfQ+XnM0T4CWlpRFuCvghIisG0ec8S0H+LqEIfINlKMleK8p9WgULvUfyeURig3yuz8o8fO9fYzsfkk/UlQPzzlcFL3PPvEIjVDOcGOmiTylLTwspmw8s0xH6MsaqLQF3yE9vtzNCbh7/qM0xNbbKcu50ET+fhhvc7HKl29zC/4aBYbPjagvlQNnkf+QCxhTtV1CRPW1Qds3EkNwcWcYaD3CjUwA=="
   }
 })

};
request(options, function (error, response) {
 if (error) throw new Error(error);
 console.log(response.body);
});

require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://z-sandbox.jsbl.com/zconnect/api/v1/mpinValidation');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
 'follow_redirects' => TRUE
));
$request->setHeader(array(
 'Content-Type' => 'application/json',
 'Accept' => 'application/json',
 'clientId' => '364E9806o51K9',
 'clientSecret' => 'eyJhbGciOiJIUzUxMiJ9.eyJleHAiOjE2OTI2MzcxOTl9.0s3evOaGFm6uyRxSioiXlOffHbZTDIB1zB1xl3ck_IIfxSrsARI9tPiooIOVjVv9rQqUInqtk1odcWtk8V3rFA',
 'organizationId' => '223'
));
$request->setBody('{
\n    "MpinValidation": {
\n        "MobileNumber": "03182318381",
\n        "DateTime": "20230427181818",
\n        "TraceNo": "673886",
\n        "ChannelId": "KUICKPAY",
\n        "TerminalId": "KUICKPAY",
\n        "Mpin": "RW5DzQYRVQo4tBdO0KpZ9LmGzVKL6V3plfBtTBwFaVpbJfk0TuVSvaPeJMKlvQ8cxbcd9Q6RWRvH6kcs\\/QU2OcVdFfFEkRL23pkzpRkMP4FZsFt0\\/ZFRDGJbj9TfQ+XnM0T4CWlpRFuCvghIisG0ec8S0H+LqEIfINlKMleK8p9WgULvUfyeURig3yuz8o8fO9fYzsfkk\\/UlQPzzlcFL3PPvEIjVDOcGOmiTylLTwspmw8s0xH6MsaqLQF3yE9vtzNCbh7\\/qM0xNbbKcu50ET+fhhvc7HKl29zC\\/4aBYbPjagvlQNnkf+QCxhTtV1CRPW1Qds3EkNwcWcYaD3CjUwA=="
\n    }
\n}');
try {
 $response = $request->send();
 if ($response->getStatus() == 200) {
   echo $response->getBody();
 }
 else {
   echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
   $response->getReasonPhrase();
 }
}
catch(HTTP_Request2_Exception $e) {
 echo 'Error: ' . $e->getMessage();
}
require "uri"
require "json"
require "net/http"

url = URI("https://z-sandbox.jsbl.com/zconnect/api/v1/mpinValidation")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request["Accept"] = "application/json"
request["clientId"] = "364E9806o51K9"
request["clientSecret"] = "eyJhbGciOiJIUzUxMiJ9.eyJleHAiOjE2OTI2MzcxOTl9.0s3evOaGFm6uyRxSioiXlOffHbZTDIB1zB1xl3ck_IIfxSrsARI9tPiooIOVjVv9rQqUInqtk1odcWtk8V3rFA"
request["organizationId"] = "223"
request.body = JSON.dump({
 "MpinValidation": {
   "MobileNumber": "03182318381",
   "DateTime": "20230427181818",
   "TraceNo": "673886",
   "ChannelId": "KUICKPAY",
   "TerminalId": "KUICKPAY",
   "Mpin": "RW5DzQYRVQo4tBdO0KpZ9LmGzVKL6V3plfBtTBwFaVpbJfk0TuVSvaPeJMKlvQ8cxbcd9Q6RWRvH6kcs/QU2OcVdFfFEkRL23pkzpRkMP4FZsFt0/ZFRDGJbj9TfQ+XnM0T4CWlpRFuCvghIisG0ec8S0H+LqEIfINlKMleK8p9WgULvUfyeURig3yuz8o8fO9fYzsfkk/UlQPzzlcFL3PPvEIjVDOcGOmiTylLTwspmw8s0xH6MsaqLQF3yE9vtzNCbh7/qM0xNbbKcu50ET+fhhvc7HKl29zC/4aBYbPjagvlQNnkf+QCxhTtV1CRPW1Qds3EkNwcWcYaD3CjUwA=="
 }
})

response = https.request(request)
puts response.read_body
OkHttpClient client = new OkHttpClient().newBuilder()
 .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\r\n    \"MpinValidation\": {\r\n        \"MobileNumber\": \"03182318381\",\r\n        \"DateTime\": \"20230427181818\",\r\n        \"TraceNo\": \"673886\",\r\n        \"ChannelId\": \"KUICKPAY\",\r\n        \"TerminalId\": \"KUICKPAY\",\r\n        \"Mpin\": \"RW5DzQYRVQo4tBdO0KpZ9LmGzVKL6V3plfBtTBwFaVpbJfk0TuVSvaPeJMKlvQ8cxbcd9Q6RWRvH6kcs\\/QU2OcVdFfFEkRL23pkzpRkMP4FZsFt0\\/ZFRDGJbj9TfQ+XnM0T4CWlpRFuCvghIisG0ec8S0H+LqEIfINlKMleK8p9WgULvUfyeURig3yuz8o8fO9fYzsfkk\\/UlQPzzlcFL3PPvEIjVDOcGOmiTylLTwspmw8s0xH6MsaqLQF3yE9vtzNCbh7\\/qM0xNbbKcu50ET+fhhvc7HKl29zC\\/4aBYbPjagvlQNnkf+QCxhTtV1CRPW1Qds3EkNwcWcYaD3CjUwA==\"\r\n    }\r\n}");
Request request = new Request.Builder()
 .url("https://z-sandbox.jsbl.com/zconnect/api/v1/mpinValidation")
 .method("POST", body)
 .addHeader("Content-Type", "application/json")
 .addHeader("Accept", "application/json")
 .addHeader("clientId", "364E9806o51K9")
 .addHeader("clientSecret", "eyJhbGciOiJIUzUxMiJ9.eyJleHAiOjE2OTI2MzcxOTl9.0s3evOaGFm6uyRxSioiXlOffHbZTDIB1zB1xl3ck_IIfxSrsARI9tPiooIOVjVv9rQqUInqtk1odcWtk8V3rFA")
 .addHeader("organizationId", "223")
 .build();
Response response = client.newCall(request).execute();
var client = new RestClient("https://z-sandbox.jsbl.com/zconnect/api/v1/mpinValidation");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("clientId", "364E9806o51K9");
request.AddHeader("clientSecret", "eyJhbGciOiJIUzUxMiJ9.eyJleHAiOjE2OTI2MzcxOTl9.0s3evOaGFm6uyRxSioiXlOffHbZTDIB1zB1xl3ck_IIfxSrsARI9tPiooIOVjVv9rQqUInqtk1odcWtk8V3rFA");
request.AddHeader("organizationId", "223");
var body = @"{
" + "\n" +
@"    ""MpinValidation"": {
" + "\n" +
@"        ""MobileNumber"": ""03182318381"",
" + "\n" +
@"        ""DateTime"": ""20230427181818"",
" + "\n" +
@"        ""TraceNo"": ""673886"",
" + "\n" +
@"        ""ChannelId"": ""KUICKPAY"",
" + "\n" +
@"        ""TerminalId"": ""KUICKPAY"",
" + "\n" +
@"        ""Mpin"": ""RW5DzQYRVQo4tBdO0KpZ9LmGzVKL6V3plfBtTBwFaVpbJfk0TuVSvaPeJMKlvQ8cxbcd9Q6RWRvH6kcs\/QU2OcVdFfFEkRL23pkzpRkMP4FZsFt0\/ZFRDGJbj9TfQ+XnM0T4CWlpRFuCvghIisG0ec8S0H+LqEIfINlKMleK8p9WgULvUfyeURig3yuz8o8fO9fYzsfkk\/UlQPzzlcFL3PPvEIjVDOcGOmiTylLTwspmw8s0xH6MsaqLQF3yE9vtzNCbh7\/qM0xNbbKcu50ET+fhhvc7HKl29zC\/4aBYbPjagvlQNnkf+QCxhTtV1CRPW1Qds3EkNwcWcYaD3CjUwA==""
" + "\n" +
@"    }
" + "\n" +
@"}";
request.AddParameter("application/json", body,  ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Response Code Details

{
    "MpinValidation": {
        "ResponseDescription": "Successful",
        "ResponseCode": "00",
        "TraceNo": "673886"
    }
}
{
    "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

Response Body