BBPS
  • BBPS
    • BBPS Agent Integration
      • Broad examples of bill payments
      • How a bill is presented
      • FETCH AND PAY
        • Bill fetch api
        • Bill Fetch by bill id api
        • Bill Fetch by client request id api
      • VALIDATE AND PAY
        • Bill validate api
        • Bill Validation response by client request id api
        • Bill validation response by bill id api
      • QUICK PAY
      • COMPLAINT RAISING
      • AGENT APPLICATION
      • BBPS Master Data API
        • List Billers API
        • Billers By ID API
        • Categories Master Data API
        • Contact Master Data API
        • Customer Parameters API
        • Customer Parameters API
        • Customer Parameters Groups API
        • Disposition API
        • Initiating Channel API
      • BBPS Agent API
        • Bill Fetch by bill id
        • Bill Fetch by Client Request ID API
        • Get all Plan categories
        • Get all Plans
        • Bill Validate API
        • Bill Validation response by Client Request ID API
        • Bill validation response by bill id
        • Bill Payment API
        • Transaction Status txnId API
        • Transaction Status ClientReqId API
        • Adding complaint by txnId
        • View Complaints by id
        • View All Complaints
        • Txn Status Check API (401)
        • View Complaints History by id
        • Close Complaint
        • Reopen Complaint
        • Complaint Status
      • Get all Plan categories
      • Get all Plans
    • BBPS Biller Integration
      • BBPS API Workflow
      • BBPS API List
        • BILL FETCH API
        • Bill Fetch Response Endpoint
        • BILL PAY API
          • BillPayment Response Endpoint
          • Payment Notification API
          • Payment Status API
        • BILL VALIDATE API
          • BillValidation Response Endpoint
        • STATUS 402 API
          • TxnStatusResponse Endpoint
      • Bill Fetch by bill id
Powered by GitBook
On this page

Was this helpful?

  1. BBPS
  2. BBPS Agent Integration

How a bill is presented

A bill is presented with the help of following properties

  • Biller response{billerResponse} and additional information .

  • BIller response contains summary of the bill and amount options .

  • Amount Options explains the line items of a bill.Detailed items will be present if amountOption is set to true in the bill JSON. The property tagList contains the various line items.

// Given below is an example of the bill.

{
 	"genericResponse": null,
 	"billId": "c884a1a7-6824-499d-849c-acbb853f3cc6",
 	"refId": "118GQ1X2ndXcIXVkJTMRARlrLln23261125",
 	"billerId": "OTOE00005XXZ43",
 	"status": "BILL_FETCH_SUCCESS",
 	"actionType": "BILL_FETCH",
 	"userId": "FE41FE42BNK519012345",
 	"billerResponse": {
 	"billId": "c884a1a7-6824-499d-849c-acbb853f3cc6",
 	"amount": "100000",
 	"billDate": "2015-06-14",
 	"billNumber": "12303",
 	"billPeriod": "june",
 	"custConvFee": "0",
 	"couCustConvFee": "0",
 	"dueDate": "2015-06-20",
 	"customerName": "BBPS",
 	"amountOption": true,
 	"tagList": [
 	{
 	"name": "Late Payment Fee",
 	"value": "40"
 	},
 	{
 	"name": "Fixed Charges",
 	"value": "50"
 	},
 	{
 	"name": "Additional Charges",
 	"value": "60"
 	},
 	{
 	"name": "BASE_BILL_AMOUNT",
 	"value": "100000"
 	}
 	]
 	},
 	"additionalInfo": [
 	{
         "additionalInfoId": null,
         "name": "a",
         "value": "10"
         },
         {
         "additionalInfoId": null,
         "name": "a b",
         "value": "20"
         },
         {
         "additionalInfoId": null,
         "name": "a b c",
         "value": "30"
         },
         {
         "additionalInfoId": null,
         "name": "a b c d",
         "value": "40"
         }
         ],
         "customerParams": [
         {
         "name": "a",
         "value": "10",
         "type": null
         },
         {
         "name": "a b",
         "value": "20",
         "type": null
         },
         {
         "name": "a b c",
         "value": "30",
         "type": null
         },
         {
         "name": "a b c d",
         "value": "40",
         "type": null
         },
         {
         "name": "a b c d e",
         "value": "50",
         "type": null
         }
         ],
         "creationDate": "2022-11-22T11:25:14.807217",
         "modifiedDate": "2022-11-22T11:25:15.424531",
         "createdEpochDate": 1669096514,
         "modifiedEpochDate": 1669096515
}

The above example contains following line items

  • Late Payment Fee

  • Fixed Charges

  • Additional Charges

  • BASE_BILL_AMOUNT

The tag BASE_BILL_AMOUNT is a special one which points to amount property in billerResponse

property of bill JSON.

If amount option is present , then the application needs to call master API and get AmountBreakUp Set.

Suggested method is before each presentation , the application should fetch AmountBreakUpSet.

additionalInfo is another property in Bill JSON. additionalInfo provides additional information

about the bill. This is for providing additional information to the user . Property additionalInfo does not have an impact on bill payment. Application can display the content of additionalInfo to the user.

Property customerParams is used by the biller to identify the bill for a customer.

An application should create the GUI dynamically making use of the parameters in the bill and with master data of the biller ,irrespective of biller type or any other parameters . In this way the application need not be re-written for any present or future biller in the BBPS ecosystem.

PreviousBroad examples of bill paymentsNextFETCH AND PAY

Last updated 1 year ago

Was this helpful?