BBPS API SPECIFICATIONS

Bill Fetch Request

Purpose: To request bill information from a biller.

Participants:

Customer BBPOU to BBPCU: The initial request is made.
BBPCU to Biller BBPOU: The request is forwarded to the appropriate Biller BBPOU.

Structure:

Header (<Head>): Contains API metadata, including version, timestamp, origination instance, and a unique reference ID.
Analytics (<Analytics>): Meta tags for logging request times.
Transaction (<Txn>): Includes risk scores and transaction identifiers.
Customer Details (<Customer>): Includes customer-specific information like mobile number, email, Aadhaar, and PAN.
Agent Information (<Agent>): Includes device-related details like IP address, IMEI, and initiating channel.
Bill Details (<BillDetails>): Includes the biller ID and customer parameters necessary for fetching the bill.

Bill Fetch Response

Purpose: To return the requested bill details.

Participants:

Biller BBPOU to BBPCU: The response is generated by the Biller BBPOU.
BBPCU to Customer BBPOU: The response is forwarded to the Customer BBPOU.

Structure:

Header (<Head>): Metadata similar to the request structure.
Reason (<Reason>): Provides approval references, response codes, and compliance details.
Transaction (<Txn>): Mirrors the transaction data from the request.
Biller Response (<BillerResponse>): Includes customer-specific information such as:
- Customer Name
- Bill Amount
- Due Date
- Bill Period
- Additional bill-related information.
Additional Info (<AdditionalInfo>): Includes supplementary metadata tags.

Key Tags

Extensive use of <Tag> elements to include metadata across various sections.
Example tags include transaction ID, timestamp, biller-specific data, and compliance codes.

XSD Definition

The XML Schema Definition (XSD) ensures the validation of the structure of requests and responses.

Key Elements:

<BillFetchRequest>: Encapsulates the request structure.
Nested elements include:
- <Head>
- <Analytics>
- <Txn>
- <Customer>
- <Agent>
- <BillDetails>

Attributes:

Namespace: http://bbps.org/schema
Validation Constraints:
- minOccurs and maxOccurs to define the occurrence of elements.

Usage:

Ensure the XML request adheres to the defined schema structure.
Validate the XML request against the XSD to ensure compliance.
Handle response codes effectively:
- 000: Success.
- 200: Failure or other statuses.

By adhering to these standards and validation practices, participants in the BBPS ecosystem can ensure secure, efficient, and compliant bill payment transactions.