Agent Bill Payment

This API will pay the bill via an agent

AgentBillPayment

POST

AgentBillPayment

 

 

Description

 

This API will pay the bill via an agent.

 

 

Version


V2


Resource URL

https://sandbox.jsbl.com /v2/agentbillpayment-blb2


Header


Name Type Values Description Length

Authorization

String Bearer
Example: Bearer xxxxxxxxxxxxx
Access Token will be generated through OAuth API NA

Content-Type

String Example:
application/json
Only “application/json” Content-Type is supported. NA


 

Request Parameters

 

Name Description Parameter Type Sample Value

processingCode

processing Code String AgentBillPayment

merchantType

merchant Type String 0088

traceNo

trace No Only numbers are allowed 510111

companyName

company Name String NOVA

dateTime

date Time YYYYMMddHHmmss 20210105201527

terminalId

terminal Id String NOVA

mobileNo

mobile No String 03422142169

agentMobileNo

agent Mobile No String 03110000000

consumerNo

consumer No String 03422142169

productId

product Id String 2510738

otpPin

otp Pin String

WjbGEHEJ5IrqOiH3z313KaO3iiHvEa4l5uNPPUoN9jOBPLGh0NxQ/

TZA7Lnaw+9Uz+2ZI5QtCRyjak4kzZ+BG5O4ddYNJe KmoTCZI9+

 jghlr/Vu1HO5qtB2/Xm+OIAgRyPhgItGn7BpW9POdJZpdXrR/EiE1

bn4jklsDPYNrIoEgmDsBFvv8wFl7JDyPEFFXuVIKJMUK3JWUbCK

 UbCKCkXo9yfZ3yLOJGcchARVE5XoSuwnY+Bq56t4AgPVHblL

dr5Typw0CQUOUG3HXny1xyY+S8zplHM 4hNuAGfGcgi

 Gd6eCQpk7srkzeQ6wgpTSrNuV7LIgy+uEgWVu6l/mFL0lQWcA==

pinType

pin Type String "03

amount

amount String 100.0

reserved1

reserved 1 String NA

reserved2

reserved 2 String NA

reserved3

reserved 3 String NA

reserved4

reserved 4 String NA

reserved5

reserved 5 String NA

 

 

Sample  Request

 

{"AgentBillPaymentRequest":{
    "processingCode": "AgentBillPayment",
    "merchantType": "0088",
    "traceNo": "510111",
    "companyName": "NOVA",
    "dateTime": "20210105201527",
    "terminalId": "NOVA",
    "mobileNo":"03422142169",
    "agentMobileNo": "03110000000",
    "consumerNo": "03422142169",
    "productId":"2510738",
    "otpPin":"WjbGEHEJ5IrqOiH3z313KaO3iiHvEa4l5uNPPUoN9jOBPLGh0NxQ/TZA7Lnaw+9Uz+2ZI5QtCRyjak4kzZ+BG5O4ddYNJeKmoTCZI9+jghlr/Vu1HO5qtB2/Xm+OIAgRyPhgItGn7BpW9POdJZpdXrR/EiE1bn4jklsDPYNrIoEgmDsBFvv8wFl7JDyPEFFXuVIKJMUK3JWUbCKCkXo9yfZ3yLOJGcchARVE5XoSuwnY+Bq56t4AgPVHblLdr5Typw0CQUOUG3HXny1xyY+S8zplHM4hNuAGfGcgiGd6eCQpk7srkzeQ6wgpTSrNuV7LIgy+uEgWVu6l/mFL0lQWcA==",
    "pinType": "03",
    "amount": "100.0",
    "reserved1": "",
    "reserved2": "",
    "reserved3": "",
    "reserved4": "",
    "reserved5": ""
}
}
 

Response Parameters

 

Name Description Parameter Type Sample Value

processingCode

processing Code String  AgentBillPayment

merchantType

merchant Type String  0088

traceNo

trace No Only numbers are allowed  510111

companyName

company Name String  BIFILER

dateTime

date Time YYYYMMddHHmmss  20210105201527

responseCode

response Code String

 00

responseDetails

response Details String  Successful

rrn

rrn String

 APIGEEBIFILER20210105201527510111

responseDescription

response Description String  Successful

responseDateTime

response Date Time String

 20210105201527

billAmount

bill Amount String  100.0

commissionAmount

commission Amount String

 0.00

consumerNo

consumer No String  03422142169

paymentDateTime

payment Date Time String

 20210105201527

totalAmount

total Amount String  100.0

transactionID

transaction ID String

 934720950661

transactionAmount

transaction Amount String  100.0

 

 

Sample  Response

{

"processingCode": "AgentBillPayment",

"merchantType": "0088",

"traceNo": "510111",

"companyName": "BIFILER",

"dateTime": "20210105201527",

"responseCode": "00",

"responseDetails": [ "Successful" ],

"rrn": "APIGEEBIFILER20210105201527510111",

"responseDescription": "Successful",

"responseDateTime": "20210105201527",

"billAmount": "100.0",

"commissionAmount": "0.00",

"consumerNo": "03422142169",

"paymentDateTime": "20210105201527",

"totalAmount": "100.0",

"transactionID": "934720950661",

"transactionAmount": "100.00" 

}

Response Code Details


{
"requestId": "3091741309081",
"errorCode": "01",
"errorMessage": "Bad Request - Invalid Authorization Header"
}



{
"requestId": "3091741309081",
"errorCode": "03",
"errorMessage": "Bad Request - Invalid Request Payload"
}



{
"requestId": "3091741309081",
"errorCode": "04",
"errorMessage": "Bad Request - Resource not found"
}



{
"requestId": "3091741309081",
"errorCode": "05",
"errorMessage": "Bad Request - Invalid Access Token"
}
{
    "ResponseCode": "00",
    "ResponseDescription": "Successful",
    "Rrn": "",
    "MobileNumber": "03464991719",
    "Cnic": "3520214402765",
    
}


Try-out Yourself

Header Parameters


Name Values Description
Authorization
(required)

Auth2.0 verification. "Bearer" keyword followed by a space and generated Access Token from OAuth API. Like "Bearer xxxxxxx"

Content-Type
(required)

Content Type application/json is supported

Body Parameters


Name Values Description
Request Body
(required)

Add values in JSON Body

Request Body

HTTP Basic

OAuth 2.0

API Key

Clear Request

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Code examples

  • var request = require('request'),
    oauth_token = "YOUR_ACCESS_TOKEN",
    url = "https://sandbox.jsbl.com/v2/agentbillpayment-blb2"
    auth = "Bearer " + oauth_token;
    request(
    {
    method: 'POST'
    url : url,
    headers : {
    "Authorization" : auth
    }, json : {
    "processingCode" :"",
    "merchantType" :"",
    "traceNo" :"",
    "companyName" :"",
    "dateTime" :"",
    "terminalId" :"",
    "mobileNo" :"",
    "agentMobileNo" :"",
    "consumerNo" :"",
    "productId" :"",
    "otpPin" :"",
    "pinType" :"",
    "amount" :"",
    "reserved1" :"",
    "reserved2" :"",
    "reserved3" :"",
    "reserved4" :"",
    "reserved5" :"",
    
    } }, function (error, response, body) {
    // TODO: Use the body object to extract the response
    console.log(body)
    }
    )
    
  • <?PHP
    
    $url = 'https://sandbox.jsbl.com/v2/agentbillpayment-blb2';
    $curl = curl_init();
    curl_setopt($curl, CURLOPT_URL, $url);
    curl_setopt($curl, CURLOPT_HTTPHEADER, 
    array('Content-Type:application/json','Authorization:Bearer 
    ACCESS_TOKEN')); //setting custom header $curl_post_data = array(
    //Fill in the request parameters with valid values
    'processingCode' => ' ',
    'merchantType' => ' ',
    'traceNo' => ' ',
    'companyName' => ' ',
    'dateTime' => ' ',
    'terminalId' => ' ',
    'mobileNo' => ' ',
    'agentMobileNo' => ' ',
    'consumerNo' => ' ',
    'productId' => ' ',
    'otpPin' => ' ',
    'pinType' => ' ',
    'amount' => ' ',
    'reserved1' => ' ',
    'reserved2' => ' ',
    'reserved3' => ' ',
    'reserved4' => ' ',
    'reserved5' => ' '
    
    ); $data_string = json_encode($curl_post_data);
    
  • require 'net/http'
    require 'net/https'
    require 'uri'
    uri = URI('https://sandbox.jsbl.com/v2/agentbillpayment-blb2')
    http = Net::HTTP.new(uri.host, uri.port)
    http.use_ssl = true
    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
    request = Net::HTTP::Get.new(uri)
    request["accept"] = 'application/json'
    request["content-type"] = 'application/json'
    request["authorization"] = 'Bearer '
    request.body = "{
    "processingCode" :"",
    "merchantType" :"",
    "traceNo" :"",
    "companyName" :"",
    "dateTime" :"",
    "terminalId" :"",
    "mobileNo" :"",
    "agentMobileNo" :"",
    "consumerNo" :"",
    "productId" :"",
    "otpPin" :"",
    "pinType" :"",
    "amount" :"",
    "reserved1" :"",
    "reserved2" :"",
    "reserved3" :"",
    "reserved4" :"",
    "reserved5" :""
    response = http.request(request)
    puts response.read_body
    
  • curl -X POST --header "Authorization: 
    Bearer " --header "Content-Type: 
    "processingCode" :"",
    "merchantType" :"",
    "traceNo" :"",
    "companyName" :"",
    "dateTime" :"",
    "terminalId" :"",
    "mobileNo" :"",
    "agentMobileNo" :"",
    "consumerNo" :"",
    "productId" :"",
    "otpPin" :"",
    "pinType" :"",
    "amount" :"",
    "reserved1" :"",
    "reserved2" :"",
    "reserved3" :"",
    "reserved4" :"",
    "reserved5" :""
    }" "https://sandbox.jsbl.com/v2/agentbillpayment-blb2"
    
  • OkHttpClient client = new OkHttpClient();
    MediaType mediaType = MediaType.parse("application/json");
    RequestBody body = RequestBody.create(mediaType, "{
    "processingCode" :"",
    "merchantType" :"",
    "traceNo" :"",
    "companyName" :"",
    "dateTime" :"",
    "terminalId" :"",
    "mobileNo" :"",
    "agentMobileNo" :"",
    "consumerNo" :"",
    "productId" :"",
    "otpPin" :"",
    "pinType" :"",
    "amount" :"",
    "reserved1" :"",
    "reserved2" :"",
    "reserved3" :"",
    "reserved4" :"",
    "reserved5" :""
    
    }");
    Request request = new Request.Builder()
    .url("https://sandbox.jsbl.com/v2/agentbillpayment-blb2")
    .post(body)
    .addHeader("authorization", "Bearer YOUR_OAUTH_TOKEN")
    .addHeader("content-type", "application/json")
    .build();
    Response response = client.newCall(request).execute(); 
    

FAQs

You need to go through the section "How it Works".

Prerequisite(s)

1. Authentication Bear OAuth access token

2. Agent Bill Payment Inquiry

Resource Summary

Security

Authentication

Content Type

application/json

Working...