Z-Connect

Debit Payment

Documentations

Documentations for API

End Points

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

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	DebitPayme
merchantType	merchantType	Mandatory	STRING	4	0088
traceNo	traceNo	Optional	STRING	6	000012
companyName	companyName	Mandatory	STRING	4	NOVA
dateTime	dateTime	Mandatory	STRING	14	2020090612
mobileNo	mobileNo	Mandatory	STRING	11	xxxxxxxxxx
channelId	channelId	Mandatory	STRING	4	NOVA
terminalId	terminalId	Mandatory	STRING	4	NOVA
productId	productId	Mandatory	STRING	8	10245185
otpPin	otpPin	Mandatory	STRING	344	ZarH77yWmg
pinType	pinType	Mandatory	STRING	2	02
transactionAmount	transactionAmount	Mandatory	STRING	5	120.0
reserved1	reserved1	Optional	STRING	0
reserved2	reserved2	Optional	STRING	0
reserved3	reserved3	Optional	STRING	0
reserved4	reserved4	Optional	STRING	0
reserved5	reserved5	Optional	STRING	0
reserved6	reserved6	Optional	STRING	0
reserved7	reserved7	Optional	STRING	0
reserved8	reserved8	Optional	STRING	0
reserved9	reserved9	Optional	STRING	0
reserved10	reserved10	Optional	STRING	0

Sample Request

{
    "DebitPaymentRequest": {
        "processingCode": "DebitPayment",
        "merchantType": "0088",
        "traceNo": "000012",
        "companyName": "NOVA",
        "dateTime": "20200906121218",
        "mobileNo": "xxxxxxxxxxx",
        "channelId": "NOVA",
        "terminalId": "NOVA",
        "productId": "10245185",
        "otpPin": "01",
        "pinType": "01",
        "transactionAmount": "120.0",
        "reserved1": "01",
        "reserved2": "",
        "reserved3": "",
        "reserved4": "",
        "reserved5": "",
        "reserved6": "",
        "reserved7": "",
        "reserved8": "",
        "reserved9": "",
        "reserved10": ""
    }
}

Response Parameters

Name	Description	Parameter Type	Length	Sample Value
processingCode	processingCode	String	12	DebitPayment
MerchantType	MerchantType	String	4	0088
TraceNo	TraceNo	String	6	000002
CompanyName	CompanyName	String	4	NOVA
DateTime	DateTime	String	14	20200906121218
ResponseCode	ResponseCode	String	1	00
ResponseDetails	ResponseDetails	object	14	["Successful"]
rrn	rrn	String	24	NOVA20210105201527000033
responseDescription	responseDescription	String	10	Successful
responseDateTime	responseDateTime	String	14	20200906121218
ransactionId	ransactionId	String	12	911370913067
commissionAmount	commissionAmount	String	4	4.31
transactionAmount	transactionAmount	String	6	115.69
totalTransactionAmount	totalTransactionAmount	String	5	120.0

Response Sample

{
    "DebitPaymentResponse": {
        "processingCode": "DebitPayment",
        "merchantType": "0088",
        "traceNo": "000002",
        "companyName": "NOVA",
        "dateTime": "20200906121218",
        "responseCode": "00",
        "responseDetails": ["Successfull"],
        "rrn": "NOVA20200906121218000002",
        "responseDescription": "Successfull",
        "responseDateTime": "20200906121218",
        "transactionId": "911370913067",
        "commissionAmount": "4.31",
        "transactionAmount": "115.69",
        "totalTransactionAmount": "120.0"
    }
}

curl --location --request POST 'https://z-sandbox.jsbl.com/zconnect/api/v2/debitpayment-blb2' \

--header 'Content-Type: application/json' \

--header 'Accept: application/json' \

--header 'clientId: 364E9806o51K9' \

--header 'clientSecret: eyJhbGciOiJIUzUxMiJ9.eyJleHAiOjE2OTI2MzcxOTl9.0s3evOaGFm6uyRxSioiXlOffHbZTDIB1zB1xl3ck_IIfxSrsARI9tPiooIOVjVv9rQqUInqtk1odcWtk8V3rFA' \

--header 'organizationId: 223' \

--data-raw '{

    "DebitPaymentRequest": {

        "processingCode": "DebitPayment",

        "merchantType": "0088",

        "traceNo": "000012",

        "companyName": "NOVA",

        "dateTime": "20200906121218",

        "mobileNo": "xxxxxxxxxxx",

        "channelId": "NOVA",

        "terminalId": "NOVA",

        "productId": "10245185",

        "otpPin": "01",

        "pinType": "01",

        "transactionAmount": "120.0",

        "reserved1": "01",

        "reserved2": "",

        "reserved3": "",

        "reserved4": "",

        "reserved5": "",

        "reserved6": "",

        "reserved7": "",

        "reserved8": "",

        "reserved9": "",

        "reserved10": ""

    }

}'

var request = require('request');

var options = {

  'method': 'POST',

  'url': 'https://z-sandbox.jsbl.com/zconnect/api/v2/debitpayment-blb2',

  'headers': {

    'Content-Type': 'application/json',

    'Accept': 'application/json',

    'clientId': '364E9806o51K9',

    'clientSecret': 'eyJhbGciOiJIUzUxMiJ9.eyJleHAiOjE2OTI2MzcxOTl9.0s3evOaGFm6uyRxSioiXlOffHbZTDIB1zB1xl3ck_IIfxSrsARI9tPiooIOVjVv9rQqUInqtk1odcWtk8V3rFA',

    'organizationId': '223'

  },

  body: JSON.stringify({

    "DebitPaymentRequest": {

      "processingCode": "DebitPayment",

      "merchantType": "0088",

      "traceNo": "000012",

      "companyName": "NOVA",

      "dateTime": "20200906121218",

      "mobileNo": "xxxxxxxxxxx",

      "channelId": "NOVA",

      "terminalId": "NOVA",

      "productId": "10245185",

      "otpPin": "01",

      "pinType": "01",

      "transactionAmount": "120.0",

      "reserved1": "01",

      "reserved2": "",

      "reserved3": "",

      "reserved4": "",

      "reserved5": "",

      "reserved6": "",

      "reserved7": "",

      "reserved8": "",

      "reserved9": "",

      "reserved10": ""

    }

  })



 



};

request(options, function (error, response) {

  if (error) throw new Error(error);

  console.log(response.body);

});




 



$curl = curl_init();



 



curl_setopt_array($curl, array(

  CURLOPT_URL => 'https://z-sandbox.jsbl.com/zconnect/api/v2/debitpayment-blb2',

  CURLOPT_RETURNTRANSFER => true,

  CURLOPT_ENCODING => '',

  CURLOPT_MAXREDIRS => 10,

  CURLOPT_TIMEOUT => 0,

  CURLOPT_FOLLOWLOCATION => true,

  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,

  CURLOPT_CUSTOMREQUEST => 'POST',

  CURLOPT_POSTFIELDS =>'{

    "DebitPaymentRequest": {

        "processingCode": "DebitPayment",

        "merchantType": "0088",

        "traceNo": "000012",

        "companyName": "NOVA",

        "dateTime": "20200906121218",

        "mobileNo": "xxxxxxxxxxx",

        "channelId": "NOVA",

        "terminalId": "NOVA",

        "productId": "10245185",

        "otpPin": "01",

        "pinType": "01",

        "transactionAmount": "120.0",

        "reserved1": "01",

        "reserved2": "",

        "reserved3": "",

        "reserved4": "",

        "reserved5": "",

        "reserved6": "",

        "reserved7": "",

        "reserved8": "",

        "reserved9": "",

        "reserved10": ""

    }

}',

  CURLOPT_HTTPHEADER => array(

    'Content-Type: application/json',

    'Accept: application/json',

    'clientId: 364E9806o51K9',

    'clientSecret: eyJhbGciOiJIUzUxMiJ9.eyJleHAiOjE2OTI2MzcxOTl9.0s3evOaGFm6uyRxSioiXlOffHbZTDIB1zB1xl3ck_IIfxSrsARI9tPiooIOVjVv9rQqUInqtk1odcWtk8V3rFA',

    'organizationId: 223'

  ),

));



 



$response = curl_exec($curl);



 



curl_close($curl);

echo $response;





require "uri" require "json" require "n... by Romail Ahmed

Romail Ahmed

1:08 PM



require "uri"

require "json"

require "net/http"



 



url = URI("https://z-sandbox.jsbl.com/zconnect/api/v2/debitpayment-blb2")



 



http = Net::HTTP.new(url.host, url.port);

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({

  "DebitPaymentRequest": {

    "processingCode": "DebitPayment",

    "merchantType": "0088",

    "traceNo": "000012",

    "companyName": "NOVA",

    "dateTime": "20200906121218",

    "mobileNo": "xxxxxxxxxxx",

    "channelId": "NOVA",

    "terminalId": "NOVA",

    "productId": "10245185",

    "otpPin": "01",

    "pinType": "01",

    "transactionAmount": "120.0",

    "reserved1": "01",

    "reserved2": "",

    "reserved3": "",

    "reserved4": "",

    "reserved5": "",

    "reserved6": "",

    "reserved7": "",

    "reserved8": "",

    "reserved9": "",

    "reserved10": ""

  }

})



 



response = http.request(request)

puts response.read_body





has context menu

require "uri"

require "json"

require "net/http"



 



url = URI("https://z-sandbox.jsbl.com/zconnect/api/v2/debitpayment-blb2")



 



http = Net::HTTP.new(url.host, url.port);

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({

  "DebitPaymentRequest": {

    "processingCode": "DebitPayment",

    "merchantType": "0088",

    "traceNo": "000012",

    "companyName": "NOVA",

    "dateTime": "20200906121218",

    "mobileNo": "xxxxxxxxxxx",

    "channelId": "NOVA",

    "terminalId": "NOVA",

    "productId": "10245185",

    "otpPin": "01",

    "pinType": "01",

    "transactionAmount": "120.0",

    "reserved1": "01",

    "reserved2": "",

    "reserved3": "",

    "reserved4": "",

    "reserved5": "",

    "reserved6": "",

    "reserved7": "",

    "reserved8": "",

    "reserved9": "",

    "reserved10": ""

  }

})



 



response = http.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    \"DebitPaymentRequest\": {\r\n        \"processingCode\": \"DebitPayment\",\r\n        \"merchantType\": \"0088\",\r\n        \"traceNo\": \"000012\",\r\n        \"companyName\": \"NOVA\",\r\n        \"dateTime\": \"20200906121218\",\r\n        \"mobileNo\": \"xxxxxxxxxxx\",\r\n        \"channelId\": \"NOVA\",\r\n        \"terminalId\": \"NOVA\",\r\n        \"productId\": \"10245185\",\r\n        \"otpPin\": \"01\",\r\n        \"pinType\": \"01\",\r\n        \"transactionAmount\": \"120.0\",\r\n        \"reserved1\": \"01\",\r\n        \"reserved2\": \"\",\r\n        \"reserved3\": \"\",\r\n        \"reserved4\": \"\",\r\n        \"reserved5\": \"\",\r\n        \"reserved6\": \"\",\r\n        \"reserved7\": \"\",\r\n        \"reserved8\": \"\",\r\n        \"reserved9\": \"\",\r\n        \"reserved10\": \"\"\r\n    }\r\n}");

Request request = new Request.Builder()

  .url("https://z-sandbox.jsbl.com/zconnect/api/v2/debitpayment-blb2")

  .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/v2/debitpayment-blb2");

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" +

@"    ""DebitPaymentRequest"": {

" + "\n" +

@"        ""processingCode"": ""DebitPayment"",

" + "\n" +

@"        ""merchantType"": ""0088"",

" + "\n" +

@"        ""traceNo"": ""000012"",

" + "\n" +

@"        ""companyName"": ""NOVA"",

" + "\n" +

@"        ""dateTime"": ""20200906121218"",

" + "\n" +

@"        ""mobileNo"": ""xxxxxxxxxxx"",

" + "\n" +

@"        ""channelId"": ""NOVA"",

" + "\n" +

@"        ""terminalId"": ""NOVA"",

" + "\n" +

@"        ""productId"": ""10245185"",

" + "\n" +

@"        ""otpPin"": ""01"",

" + "\n" +

@"        ""pinType"": ""01"",

" + "\n" +

@"        ""transactionAmount"": ""120.0"",

" + "\n" +

@"        ""reserved1"": ""01"",

" + "\n" +

@"        ""reserved2"": """",

" + "\n" +

@"        ""reserved3"": """",

" + "\n" +

@"        ""reserved4"": """",

" + "\n" +

@"        ""reserved5"": """",

" + "\n" +

@"        ""reserved6"": """",

" + "\n" +

@"        ""reserved7"": """",

" + "\n" +

@"        ""reserved8"": """",

" + "\n" +

@"        ""reserved9"": """",

" + "\n" +

@"        ""reserved10"": """"

" + "\n" +

@"    }

" + "\n" +

@"}";

request.AddParameter("application/json", body,  ParameterType.RequestBody);

IRestResponse response = client.Execute(request);

Console.WriteLine(response.Content);

Response Code Details

{
    "DebitPaymentResponse": {
        "processingCode": "DebitPayment",
        "merchantType": "0088",
        "traceNo": "000002",
        "companyName": "NOVA",
        "dateTime": "20200906121218",
        "responseCode": "00",
        "responseDetails": ["Successfull"],
        "rrn": "NOVA20200906121218000002",
        "responseDescription": "Successfull",
        "responseDateTime": "20200906121218",
        "transactionId": "911370913067",
        "commissionAmount": "4.31",
        "transactionAmount": "115.69",
        "totalTransactionAmount": "120.0"
    }
}

{
    "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