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 Biller Integration
  3. BBPS API List

BILL FETCH API

Bill Fetch API is a request which will be sent from NPCI through BOU to the biller portal in order to retrieve bill related details from the biller.

REQUEST PARAMETERS

The various parameters are explained below:

Parent Property/Element
Property Name
Mandatory
Data Type
Description

[ROOT] (No parent property / element)

refId

M

Alphanumeric Format: Fixed Length – 35

Unique identification assigned by the initiating BBPOU to unambiguously identify the transaction which is passed on, unchanged, throughout the entire end-to-end chain, binding the Fetch and Payment messages

billerId

M

String Fixed Length – 14

Unique identification code allocated to the Biller (by NPCI)

customerParams

M

Array of name value pairs

Customer bill fetch related reference field tag

tenantId

M

String Fixed length - 4

OU ID of the BOU

name

M

String Min Length – 1, Max Length – 100

Customer bill fetch related reference field.

Name of the reference field as

configured for the Biller

value

M

String Min Length – 1, Max Length – 100

Value of the reference field which uniquely identifies the customer for the Biller

Expected Acknowledgement Parameters

The various parameters are explained below:

Parent Property/Element
Property Name
Mandatory
Data Type

[ROOT] (No parent property / element)

reason

M

String Min Length – 1, Max Length – 100

Reason of the Status

code

M

String Fixed Length 3

Response code for a request

status

M

String Min Length – 1, Max Length – 100

Status of given request

Json Formatted Request Example

{

"refId": "String", "billerId:": "String", "customerParams": [ { "name": "String", "value": "String" } ], "tenantId" : "String"

}

Json Formatted Response Example

{

"reason":"String", "code":"Integer", "status":"String"

}

PreviousBBPS API ListNextBill Fetch Response Endpoint

Last updated 2 years ago

Was this helpful?