BBPS Agent Institution Integration Toolkit

Integration Kit-BBPS Agent Institution
BBPS- Agent Institution

Integration Toolkit (Web API)
Version
v1.5
Prepared By
Mindgate Solutions
Private & Confidential Page 1

Document Release Note

Project Name: BBPS – Agent Institution
Document Name Integration Toolkit Document – API
Version: 1.5
Release Date: 20-Dec-2019
Prepared by: Kishor Singh Date: 20-Dec-2019
Reviewed by: Riyaz Parve Date: 20-Dec-2019
Approved by: Saurabh R Date: 20-Dec-2019
Document Revision History

Sr. No. Revision Date Revision Description Release Date
1 19-Dec-2018 First version 21-Dec-2018
2 05-Jan-2019 1) Added description of the API parameters 07-Jan-2019

2) Overall document formatting.
3 08-Apr-2019 1) Updated the API parameters and API 11-Apr-2019

formats.
2) Added the UAT URL’s for the API’s
4 16-Nov-2019 Added Guidelines for UI Design 16-Nov-2019
5 20-Dec-2019 Updated API Specs as per NPCI Guidelines 20-Dec-2019

(New Enhancements)

TABLE OF CONTENTS
Introduction ..................................................................................................................................................................... 5
Purpose ....................................................................................................................................................................... 5
BBPS Introduction ........................................................................................................................................................ 5
Assumptions and Prerequisites .................................................................................................................................... 5
API Integration Approach ............................................................................................................................................. 6
Encryption Decryption logic ......................................................................................................................................... 9
API List ............................................................................................................................................................................10
API Specification .............................................................................................................................................................11
Biller List API ...............................................................................................................................................................11
Biller Details API ..........................................................................................................................................................16
Bill Fetch API ...............................................................................................................................................................39
Bill validation API ........................................................................................................................................................51
Bill Payment API ..........................................................................................................................................................57
Transaction Status.......................................................................................................................................................85
Using Reference ID ..................................................................................................................................................85
Using Mobile Number .............................................................................................................................................90
Raise Complaint API ....................................................................................................................................................96
Check Complaint Status.............................................................................................................................................105
Annexure ......................................................................................................................................................................110
Annexure I: Error Codes ............................................................................................................................................110
Annexure II: BOU Decline Scenarios (Examples).........................................................................................................111
Annexure III: BIQ Form ..............................................................................................................................................113
Annexure IV: Device Details ......................................................................................................................................114
Annexure V: Payment Information ............................................................................................................................114

Annexure VI: Payment Mode Combinations ..............................................................................................................115
Guidline for UI Design ...................................................................................................................................................115

INTRODUCTION
PURPOSE
The purpose of this document is to detail out the technical integration approach for web API based integration between
Bank BBPS platform with Agent Institutions. This document describes the process flow and API functionalities which
provide quick integration for the Agent Institutions.
BBPS INTRODUCTION
BBPS stands for Bharat Bill Payment System. It offers bill payment services to consumer through network of
agents/retail shops/bank-branches and digital channels like Internet banking / Mobile app of banks etc. allowing
multiple payment modes like Card, UPI, AEPS, Wallet, Cash over the counter and provides instant confirmation to the
biller as well to consumer.
BBPS adores multifold payment modes and is a cost-effective alternative to the existing bill payment system.
Participants in Customer Operating Unit Side
BBPCU: ‘Bharat Bill Payment Central Unit’ (CU) is a central unit hosted by NPCI which has defined business standards,
technical standards, rules and procedure in the BBPS ecosystem.
BBPOU: ‘Bharat Bill Payment Operating Unit’ is the entity that is authorized by Reserve Bank of India. It can be a Bank or
a Non-Bank. BBPOU act as Customer Interfacing channel as ‘COU’ (Customer OU)
AI: ‘Agent Institution’ who handles bill payment, collection and aggregation business, which operate under a COU with
necessary approvals from NPCI/RBI. Customer BBPOU on-board Agent institutions, which can further on-board agents
and/or set up customer service points in various regions and locations.
AGENTS: Agents are part of Agent Institution in BBPOU (As COU) and act as the customer touch point available in the
form of outlets, bank branches, collection centers and other service points where customer can pay their bills.
ASSUMPTIONS AND PRER EQUISITES
The following are the pre-requites for BBPS integration:
 Agent institution Id and Agents under agent institution exists in the Bank BBPS system
 Agent Institution should be able to develop API’s in JSON.
 Agent Institution should pass all the text parameters in English text. Else “NA” should be passed by Agent
Institution as NPCI accepts only English text.

API INTEGRATION APPROACH
Steps to generate request & read response messages
 Agent Institution/Agent sends the request message (JSON format) in encrypted format to customer side BBPOU.
 Customer side BBPOU will decrypt the request message based on agent institution/Agent id passed in the
message.
 Encryption Key will be generated at the time of on-boarding. Same will be shared with Agent Institution/Agent
via Email Manually. (Key will be different for UAT & Production environment)
 If the request is valid, BBPOU will convert the request into XML format and pass the same to NPCI.
 NPCI will get response from the biller and forward the response to BBPOU in XML format.
 BBPOU will convert the XML response into JSON format and encrypt the response and pass the same to Agent
Institution/Agent.
Clear Text Request:
"BillFetchRequest" : {
"Head" : {
"msgId" : "PYZAP08062018165735JXGVSZ4ACFB8MAZS",
"agentId" : "OU01OU21INT000000001",
"origInst" : "OU01",
"refId" : "MAHA00000MUM0108062018165735MCZ1XDK",
"ts" : "2016-10-20T13:00:00+05:30"
},
"BillDetails" : {
"billerId" : "MAHA00000MUM01",
"CustomerParams" : [{
"name": "CA Number",
"value": "210000339066"
}]

 URL: https://127.0.0.1:9080/<Refer service name at each API section>

[URL to be changed as per UAT/Production Server]
BBPOU sends Acknowledgment back to Agent Institution which is in JSON Format.
Response Message Format (JSON Format)
"BillFetchResponse": {
"Head": {
"origInst": "BBCU",
"refId": "1541815307090FETCHREF073147101118B1",
"ts": "2018-11-10T07:31:54+05:30",
"ver": "1.0"
},
"Reason": {
"approvalRefNum": "12345678",
"complianceReason": "",
"complianceRespCd": "",
"responseCode": "000",
"responseReason": "Successful"
},
"Txn": {
"msgId": "1541815307090FETCHMSG073147101118bd",
"ts": "2018-11-10T07:29:47+05:30"
},

"BillDetails": {
"billerId": "MAHA00000MUM01",
"CustomerParams": [
"name": "RefFld1",
"value": "123"
},
"BillerResponse": {
"customerName": "Arnab Moitra",
"amount": "120000",
"dueDate": "2015-09-24",
"custConvFee": "1000",
"custConvDesc": "Customer service fee",
"billDate": "2015-01-22",
"billNumber": "1232332",
"billPeriod": "January",
"Tag": []
},
"AdditionalInfo": [ ]

ENCRYPTION DECRYPTION LOGIC
BBPOU will share 'bbpstoolkit-1.0.jar' library and 32 characters Private KEY <PVT_KEY>for encryption and decryption.
Using this library agent institution can encrypt and decrypt data wherever required.
Sample PVT_KEY = abcedf12345ABCDEF67890abcDEF123
JAR File:-
bbpstoolkit-1.0.jar
Sample Code snippet:
import com.biller.merchanttoolkit.security.BillerSecurity;
public class AESTest {
public static void main(String[] args) throws Exception {
String clearTextMsg = "Testing Clear Text Data....";
String key = "<PVT_KEY>"; // Sample : abcedf12345ABCDEF67890abcDEF123
BillerSecurity security = new BillerSecurity();
String encValue = security.encrypt(clearTextMsg, key);
System.out.println("Encrypted String : " + encValue);
String decValue = security.decrypt(encValue, key);
System.out.println("Dencrypted String : " + decValue);
}
}
----------------------------------------------------------------------------------------------------
Console Output >>
Encrypted String: CEECBC1C7F00BADC54DAE3666A8A1092219D767620EDFB41B92AC6D653446FF2
Decrypted String: Testing Clear Text Data....

API LIST
BBPS platform provides the following API to the agent institution
Sr. No API Name Description Description

This API will get the list of billers in the
1 Biller List https://IP:PORT/getBillerList
BBPS ecosystem
This API will get the details of respective
2 Biller Details https://IP:PORT/getBillerDetails
biller in the BBPS ecosystem
Customer can get bill details in BBPS
ecosystem by providing certain
3 Bill Fetch parameters like; Service Provider Name, https://IP:PORT/billFetch
Customer Reference / Account or
Relationship ID
Validation of details provided by the
4 Bill Validation https://IP:PORT/billValidate
customer before the ad-hoc payment.
Bills fetched by customer can be taken
for payment processing lifecycle by
5 Bill Payment invoking the Bill Pay process. Payment https:// IP:PORT/billPay
confirmation will be sent to Biller
through BBPS ecosystem.
Transaction Status (401) To check the status of the transaction
6 https://IP:PORT/getTxnStatus
– Transation ID using reference ID
Transaction Status (401) To check the status of the transaction
7 https://IP:PORT/getTxnStatus
– Mob Number using Mobile Number
Raise a complaint against a transaction,
8 Raise Compliant https://IP:PORT/raiseComplaint
agent or biller.
9 Complaint Status To check the status of the compliant https://IP:PORT/getComplaintStatus

API SPECIFICATION
BILLER LIST API
Biller List API helps agent institution to get list of the biller registered with NPCI
Request Parameter for Biller List API
Mandatory /
Sr. No. Fields Description Data Type Length
Optional
1 ver Version of the API i.e. 1.0 Character 3 Mandatory
Code assigned by NPCI to each agent institution
2 origInst Character 4 Mandatory
Example: OU01
Unique identification generated by AI/Agent to
unambiguously identify the transaction.
3 refId It should be Unique for end-to-end process. Character 35 Mandatory
Example:
MAHA00000MUM0108062018165735MCZ1XDK
Timestamp of the request and response which
will be updated at each leg of the transaction.
4 ts Character 27 Mandatory
Current timestamp Format:
YYYY-MM-DDTHH24:MM:SS+05:30
Category of Biller such as Electricity, Water, DTH
5 category etc. for which agent institution wants to fetch Character 15 Optional
the biller list
Date when the biller is last updated. It should
6 lastUpdated be in yyyy-mm-dd format. Character 10 Optional
Example: 1999-12-31
Biller List Fetch Request API
Clear Text Request :

{
"head": {
"ver": "1.0",
"ts": "2015-02-16T22:02:35+05:30",
"origInst": "OU01",
"refId": "OU01TESTABILLERLSTREQ20190409124502"
},
"search": {
"category": "DTH",
"lastUpdated": "09-04-2019"
}

}
Encrypted Request :
{
"requestMsg":
"14A693F86D1604157F6FC23E35D6388B93CE5FF542A6E02CC0F8FADECB69FB35EAB82875ACBED0AF6F9DFBC86359A0
8335050FF8E48E8B667935CD974AB211F7EC9FECBC234752F7A1ED77166A0AA7F6C7717F9B4338691C1EF5725901B20
AF96DE13CBA2DC84D7486991FA9D194A18D7A176A717147FB4CF02B0098B5DA930F207A49CB02F26705E767D2F2752
02BB4D6C238A143BE942E780E6F8BDA3F26871DA4C6A11EB5F05B9C2E45159DAC844A7BD4C6F581D9980DEDE79E63F
ABF55EDB9B4B6C3431877B1769CC56528058F2DFEBE92FD83207D32ACE5A2675EA0042E3EC9C6EC95080DA745CA504
8F1DD68C2",
"agentInstitutionId": "OU01"
}

Response Parameters for Biller List API
Sr. Data Mandatory

Fields Description Length
No. Type / Optional
Code assigned by NPCI to each BBPOU
Example: OU01
Example:
MAHA00000MUM0108062018165735MCZ1XDK
3 ts Character Mandatory
Biller should pass the respective Response code
based on the success or failure state of the
5 responseCode transaction Number 6 Mandatory
000 for Success
Other than 000 is Failure
Min 7
Biller should pass the description of the
6 responseReason Character Max Mandatory
response code, as "Successful" or "Failure"
100
7 billers List of billers from the Customer side BBPCU Character
Unique identification code allocated to the
Biller by NPCI post on-boarding by respective
8 billerId Character 14 Mandatory
BBPOU
Example: MAHA00000MUM01
9 billerName Name of Biller registered with the NPCI Character 100 Mandatory
10 billerAliasName Alias Name of Biller registered with the NPCI Character 50 Mandatory
Category of Biller such as Electricity, Water, DTH
11 billerCategoryName Character 20 Mandatory
etc.
12 Status Status of the Biller, i.e., active/inactive Character 6-8 Mandatory
Date Biller is last updated.
13 lastUpdated It should be in yyyy-mm-dd format. Date 10 Mandatory
Example: 1999-12-31

Biller List Response API
Clear Text Response :

{
"head": {
"refId": "OU01TESTABILLERLSTREQ20190409124503",
"origInst": "OU01",
"ts": "2019-04-09T12:57:31",
"ver": "1.0"
},
"reason": {
"responseReason": "Successful"
},
"billers": [
{
"billerId": "OU0111P00NAT01",
"billerName": "Test Biller",
"billerAliasName": "Test Biller One",
"billerCategoryName": "DTH",
"status": "Inactive",
},
{
"billerId": "OX0450007XXA63",
"billerName": "Oxigen",
"billerAliasName": "Oxigen Alias",
"billerCategoryName": "DTH",
"status": "Active",
}
]
}

Encrypted Request :
{
"responseMsg":
"2946B46F68BB8AB34F3C17ECF76D5E62A80EECF86064A527318B20AC78DDA825C0A01003478AB37509E9677310CE26
B525BE05368B4101B0E7D3174693F1EBFD8EC4895BDD6D7C4A3E83769DD7CEE90534A1292924DE29817AD3ABF4220A
725F493DB6CC025BD2DB7464057CB3DD05E223261E09724EF7BD7950F4F210D48904D1DE7770BD2811652664995897
C755836B7C58471C710FC67C822C2DF7525F64EFEE06612B0B1490AF81AA3EB13A5ECF75622DCFD603018CE68228C0F
5A0BFC4C13775F0CAF3C6FA7F2F3C9C7E34AD726804642C41C611DFC1ED4226EC341523278DCD2F51170E15B392898E
DD11326C24A141D5CAB671C6CD56F60D08607DF13A3BA91D14FACB9BCF8CABF231244B1BBC736FBB095ADFFDD77AE
1ECDFFBB735545DB18EDECB55FEC66C5B8A94B23BBAB8BA6C00602974BF6B3F133DBA9603DBBF54718C52BD81CD0C
000490ACD249D53A4BF5538325C5C18EDA3AC1F94B33E86C13376989808DE1A30A84478E3E283E4656CF4DB9F50B81
AAA3DAD475F3DD9A",
}

BILLER DETAILS API
Biller Details API helps agent institution to get details of the biller registered with NPCI
Request Parameter for Biller Details API
Mandatory /
Optional
Code assigned by NPCI to each agent institution
Example: OU01
Example:
MAHA00000MUM0108062018165735MCZ1XDK
BBPOU
Biller Details Request API

{
"head": {
"ver": "1.0",
"ts": "2020-01-17T18:29:01+05:30",
"origInst": "OU01",
"refId": "OU0120200117182901REFTSR83269206689"
},
"biller": {
"billerId": "HPCL00000NAT01"
}
}

Encrypted Request :
{
"requestMsg":
83D4D8950FE9D95BD8C93B17114BBF137C6FCCCE8D0ECE0F46523ADB5556E931FBC7717F9B4338691C1EF5725901B20
AF9AE9AD0D19341BCB1ED31E6854C5A285234861266FE82D6975F9D6BB528F32F2944C0A38EE4ED483CA3A093A16F7
DEB1C85D27DB089EE2950A8C9FE8492EE453E4246B89456EAB9A2DB4947F53C95151C940ED48DDCEBC6C96430E163C
BF39484A7F7830876994549AEC77816311689729B6D6858D0CAE9FE627BDDBA02EFA95E",
}
Response Parameters Biller Details API
Sr. Mandatory /
Fields Description Data Type Length
No. Optional
Timestamp of the request and response
which will be updated at each leg of the
2 ts transaction. Character Mandatory
Example: OU01
Unique identification generated by AI/Agent
to unambiguously identify the transaction.
It should be Unique for end-to-end process.
4 refId Character 35 Mandatory
Example:
MAHA00000MUM0108062018165735MCZ1
XDK
Biller should pass the respective Response
code based on the success or failure state of
5 responseCode the transaction Number 6 Mandatory
000 for Success
Min 7
6 responseReason Character Max Mandatory
100
BBPOU
6 billerName Name of Biller registered with the NPCI Character 100 Mandatory
8 billerAliasName Alias Name of Biller registered with the NPCI Character 50 Mandatory

Category of Biller such as Electricity, Water,

9 billerCategoryName Character 20 Mandatory
DTH etc.
Mode by which biller is connected to the
10 billerMode Character 9 Mandatory
BBPOU, i.e., Online, Offline A, Offline B
This Flag (Yes/No) will be passed by NPCI, it
indicates if the Biller accepts ad-hoc
Min 2
11 billerAcceptsAdhoc payment Character Mandatory
Max 3
If accepts then Yes
If not accepts then No
This Flag (Yes/No) will be passed by NPCI, it
indicating if the Biller is a parent Biller Conditional
12 parentBiller Character 14
If parent biller then Yes Mandatory
If not parent biller then No
If parent biller flag is No Min 2
13 parentBillerID Character Mandatory
Then parent biller ID will be present. Max 3
Type of ownership of the biller passed by
14 billerOwnerShp Character 20 Mandatory
NPCI, as Government, PSU, Private
Coverage of the Biller passed by NPCI, as
15 billerCoverage Character 20 Mandatory
National, State/UT, City/District
Indicates if the Biller allows Bill Fetch or not
16 fetchRequirement NPCI will pass values as MANDATORY, Character 20 Mandatory
OPTIONAL, NOT_SUPPORTED
This flag indicates whether biller accept
partial payment/advance payment or not
paymentAmountExactn EXACT- If biller accept only exact payment
17 Character 20 Mandatory
ess EXACT DOWN - If biller accept partial
payment
EXACT UP - If Biller accept advance payment
Indicates if the Biller allows Bill validation or
18 supportBillValidation not NPCI will pass values as MANDATORY, Character 20 Mandatory
OPTIONAL, NOT_SUPPORTED
Effective from date of the Biller
19 billerEffectiveFrom It should be in yyyy-mm-dd format. Date 10 Mandatory
Example: 1999-12-31
Effective to date of the Biller
20 billerEffectiveTo It should be in yyyy-mm-dd format. Date 10 Mandatory
Example: 1999-12-31
Payment mode accepted by the Biller. List of
the payment modes is attached in the
21 billerPaymentModes Character Mandatory
ANNEXURE III
Example: Credit Card, Debit Card
Payment channel accepted by the Biller. List
of the payment channels is attached in the
22 billerPaymentChannels Character Mandatory
ANNEXURE III
Example: Internet Banking, KIOSK

The parameters based on which customer

will perform the Bill Fetch operation. Biller
will configure the customer parameters at
billerCustomerParams the time of biller on-boarding. Refer
23 Character Mandatory
(List of Key Value Pair) attached ANNEXURE III for Customer
parameter details. Max 5 customer
parameters can be configured by Biller.
Example: Connection ID, Mobile No
Parameters which are received in the
response from the biller
billerResponseParams
24 Max 7 response parameters can be Character Mandatory
(List of Key Value Pair)
configured by Biller.
Example: Bill Amount, Bill Date
If Biller wants to pass any additional
information is response, then Additional Info
tag can be used. Max 5 parameters can be
billerAdditionalInfo
25 passed by billers. Character Optional
(List of Key Value Pair)
Example:
Early Payment Date, Late Payment Date,
Discount, Bill Month, etc.
Interchange fee configuration details of the
26 interchangeFeeConf Character Mandatory
Biller
27 interchangeFee Interchange fee details of the Biller Character Mandatory
28 Status Status of the Biller, i.e., active/inactive Character 6-8 Mandatory
Description about the biller which will be
29 billerDescription Character 150 Optional
displayed on the front end
It is flag which notify if the biller support
deem transaction status (Yes/No).
If Yes then Agent Institution should wait till
biller time out period then should call the
30 supportDeemed Character 2-3 Mandatory
401 API before attempting reversal of
respective transaction.
If No then Agent Institution can attempting
instant reversal after transaction timeout.
It is flag which notify if the biller support
Pending transaction status (Yes/No)
If Yes then NPCI will wait till biller time out
31 supportPendingStatus Character 2-3 Mandatory
period then call the 402 API.
If No then NPCI will mark this transaction as
failed after transaction timeout at biller OU.
Biller will define biller Timeout (in minutes).
0-2880 (ie. Max 48 hrs).
If supportPendingStatus is Yes. Conditional
32 billerTimeOut Number
If NPCI receive definite status within the Mandatory
biller timeout period, the same shall be
forwarded to COU and the transaction can

be closed with appropriate status.

If NPCI doesn't receive response till the biller
timeout, NPCI will close the transaction as
Failure.
Biller Details Response API – Pending Not Supported

{
"head": {
"refId": "OU0120200117182901REFTSR83269206689",
"origInst": "OU01",
"ts": "2020-01-17T18:29:15",
"ver": "1.0"
},
"reason": {
"responseReason": "Successful",
"complianceRespCd": null,
"complianceReason": null
},
"biller": {
"billerId": "HPCL00000NAT01",
"billerName": "Hindustan Petroleum Corporation Ltd (HPCL)",
"billerAliasName": "HPCL",
"billerCategoryName": "LPG Gas",
"billerMode": "ONLINE",
"billerAcceptsAdhoc": false,
"parentBiller": false,
"parentBillerId": null,
"billerOwnerShp": "PSU",
"billerCoverage": "IND",
"fetchRequirement": "MANDATORY",
"paymentAmountExactness": "Exact",
"supportBillValidation": "NOT_SUPPORTED",
"billerEffectiveFrom": "15-04-2019",
"billerEffectiveTo": "31-12-2099",
"billerTempDeactivationStart": null,
"billerTempDeactivationEnd": null,
"billerPaymentModes": [
{

"paymentMode": "Internet Banking",

"minLimit": 1,
"maxLimit": null,
"supportPendingStatus": "No"
},
{
"paymentMode": "Debit Card",
"minLimit": 1,
"maxLimit": null,
},
{
"paymentMode": "Credit Card",
"minLimit": 1,
"maxLimit": null,
},
{
"paymentMode": "Prepaid Card",
"minLimit": 1,
"maxLimit": null,
},
{
"paymentMode": "IMPS",
"minLimit": 1,
"maxLimit": null,
},
{
"paymentMode": "Cash",
"minLimit": 1,
"maxLimit": null,
},
{
"paymentMode": "UPI",
"minLimit": 1,
"maxLimit": null,

},
{
"paymentMode": "Wallet",
"minLimit": 1,
"maxLimit": null,
},
{
"paymentMode": "NEFT",
"minLimit": 1,
"maxLimit": null,
},
{
"paymentMode": "AEPS",
"minLimit": 1,
"maxLimit": null,
},
{
"paymentMode": "Account Transfer",
"minLimit": 1,
"maxLimit": null,
}
],
"billerPaymentChannels": [
{
"paymentChannel": "INT",
"minLimit": 100,
"maxLimit": 20000000,
},
{
"paymentChannel": "INTB",
"minLimit": 100,
"maxLimit": 20000000,
},
{

"paymentChannel": "MOB",
"minLimit": 100,
"maxLimit": 20000000,
},
{
"paymentChannel": "MOBB",
"minLimit": 100,
"maxLimit": 20000000,
},
{
"paymentChannel": "POS",
"minLimit": 100,
"maxLimit": 20000000,
},
{
"paymentChannel": "MPOS",
"minLimit": 100,
"maxLimit": 20000000,
},
{
"paymentChannel": "ATM",
"minLimit": 100,
"maxLimit": 20000000,
},
{
"paymentChannel": "BNKBRNCH",
"minLimit": 100,
"maxLimit": 20000000,
},
{
"paymentChannel": "KIOSK",
"minLimit": 100,
"maxLimit": 20000000,

},
{
"paymentChannel": "AGT",
"minLimit": 100,
"maxLimit": 20000000,
},
{
"paymentChannel": "BSC",
"minLimit": 100,
"maxLimit": 20000000,
}
],
"billerCustomerParams": [
{
"paramName": "Consumer Number",
"dataType": "NUMERIC",
"optional": true,
"minLength": 1,
"maxLength": 8,
"regex": "^[0-9]{1,8}$"
},
{
"paramName": "Distributor ID",
"optional": true,
"minLength": 8,
"maxLength": 8,
"regex": "^[0-9]{8}$"
},
{
"paramName": "Mobile Number",
"optional": true,
"minLength": 10,
"maxLength": 10,
"regex": "^[0-9]{10}$"
},
{

"paramName": "Unique Consumer ID",

"optional": true,
"minLength": 17,
"maxLength": 17,
"regex": "^[2][0-9]{16}$"
}
],
"billerResponseParams": {
"params": [],
"amountOptions": [
{
"amountBreakupSet": [
"BASE_BILL_AMOUNT"
]
}
]
},
"billerAdditionalInfo": [
{
"paramName": "Consumer Address",
"dataType": "ALPHANUMERIC",
"optional": false,
"minLength": null,
"maxLength": null,
"regex": null
},
{
"paramName": "Consumer Number",
"optional": false,
"minLength": null,
"maxLength": null,
"regex": null
},
{
"paramName": "Distributor Contact",
"optional": false,
"minLength": null,

"maxLength": null,
"regex": null
},
{
"paramName": "Distributor Name",
"optional": false,
"minLength": null,
"maxLength": null,
"regex": null
}
],
"interchangeFeeConf": [],
"interchangeFee": [],
"status": "Active",
"billerDescription": null,
"supportDeemed": "No",
"supportPendingStatus": "No",
"billerTimeOut": null
}
}
Encrypted Request :
{
"responseMsg":
"2946B46F68BB8AB34F3C17ECF76D5E62F6A3C53A29B6CB2B78ABC3B8544A2E9D54230E2E063D302060A18D3AAEAAA
638332E432B8C4060E81A0C8D425B03B92861AADFCD8983BDBD114E5CBB6127F6ED41E7D5F48F8F372204758CCC012
17B2D65B1643DE375EBB33CD26EBB3953093E23261E09724EF7BD7950F4F210D48904D1DE7770BD2811652664995897
C755836B7C58471C710FC67C822C2DF7525F649EE09D511F82F69A70160B79B7A0046C4595B51C59EA5C2FD1DF79039
B386F6D0BCB15D883A5742FA8EC08681B624FBD5BDCA5BFC2CAE03A63E8BEAA9B8E9D947AC2CACB853A1CCC4033DE
27830964D994B6C1709EDBD8FE56985ED504B62479307053999C2EA81A55FC1FAD5A693420E172CF8D2E13434EDF8D
0F6C1892D4AB3519F175F90B2FFCC54BB265D167196FD86FD213FED657D60DA88856E372ED7E357C5647ED136CC082
D6024D8853B8AB156174E81B1E76518F38691DE195165C0A1AC9DC69D8747E066FD1289D0A7581FFBC90A8341FF8D8
2FEFF93995F2E6FE56AE71318BE55C17162E72F956DD8B53C2D65A4B3E7FD0EAFA5B85E9FB4FE3E6E4D874C01D42C06
6759B6F39FAA910925D951BE6D81FDDE8BA625C4D06AE4FCF3D4CAEF5E8300F409D051BBD350A0C9A781528565EAED
E88BE7E3335439DCEB8080E34D75A9B5F145FB48A53756AE12CE8A1CD86687CF6BA6F5488B9D9E0E13D37C942E8E056
FF4AC8717753BDD8E30682E4B4796E5116E90D4E971C5805D5D7871B944950B0455E2A73A3F5A8A1C1E0FF40E2D773
D6064818549F59C8D267795A7E120FE01511C42D507E19775013456D57C947A534427A1B255C25059035AE1F231486B
4152A6F42B740ED288F1700F191E16534F17281F36A718932766936AA9CD886F1BE0945C87E7C36AC1A4647DD069F2C
071F0A9C4ACF4A8B161057F84A8C9A3D6D494788A5FB2A9D83EB3EE116C8D2D8738FA2C10A90059D66939EDAF3B18E
74370A43602FF1C353690625D266366E07BF2470C97E406D512C8020BE51F53A5A4203450E117CC71E1F5B762DEB21D

6DAFA0150F858CF4DA8FD26F9486532094C6D7F79BBEECB896D2F9AA371C48E8C5F23A118CAD339A2EC3D17DA6BAA
1DF1666413A963E03E0201DB72831A06A157BC497366A84B49290E2E2F555048498DAE64EBF921EA36218A9B7899D84
82283D18FAC3552D6F5280BC8A85F44C6E68C8A15F99182212A567766BDBA727C174CF38A860DC15990E157A2ABA28
499F661BC337235617C2C14AC33C850017147ED345AFFA1BACC3AEAE6DB03F42EB74BE0056184DB9B52E68C1F707B62
6A4AAA386FC625ECBD0BD4FCD51F49C14AD729596CCC78B9DBDBDCE7E34C8A00FB7DB386A8D502E771C2196C2279F
0773A85C5441C532D60A100D2A2731611F5AE025DA7B24B9F2CBD7173BCE5A3AB4777E7970A6F2A8991E4D70712D31
E1029AEF5BDED3E5897E3D760C75121682493BBA9A9AD550CA7AB6748BFB01ABFB0EF8DDA4B137CD204B165CA44EC
2F37BEE3170590C3F2EBA30F6C731BB06CE4CFACDC88D0D5951EBAF848A3A0CD1F36A9AE57C4814158D3517CC891C3
D456F79B4DAA03EF689FA26DAD4E879248089EAC6D1BDA4B137CD204B165CA44EC2F37BEE3170590C3F2EBA30F6C73
1BB06CE4CFACDC88D0D5951EBAF848A3A0CD1F36A9AE57C4814158D3517CC891C3D456F79B4DAAA0E4E0D1EF348BF
DB36FCB91E52F48E7DA4B137CD204B165CA44EC2F37BEE3170590C3F2EBA30F6C731BB06CE4CFACDC88D0D5951EBAF
848A3A0CD1F36A9AE57C4814158D3517CC891C3D456F79B4DAA1916076102F4DE01F622ED393E0792A5A0F03953909
659BFFFD42B6196455E9C70044B43559B9B40A1A1182A9B94554AAC75AA10DBBAEEBDDDE15D9892FDB75B8C336FAF
8B1E6AA6A5A996DE0F2ACAA051F69EE70DDF4795B1D61404635E684799F661BC337235617C2C14AC33C850017147ED
345AFFA1BACC3AEAE6DB03F42EB74BE0056184DB9B52E68C1F707B626A4AAA386FC625ECBD0BD4FCD51F49C14A49B6
110F16787B3BFDA3B6001487A0E199F661BC337235617C2C14AC33C850017147ED345AFFA1BACC3AEAE6DB03F42EB7
4BE0056184DB9B52E68C1F707B626A4AAA386FC625ECBD0BD4FCD51F49C14AEEBDAACB944B4A182A59C451FEE029F0
A4AAA386FC625ECBD0BD4FCD51F49C14A0729B97F373FCC1F0D5964156B4F6D91287DBA345A000CB984AE0D8E656EE
FCB91E8840AAEBB5C2382DE147CC1A811A0626A4F2A4C1D0EF6DE6CF07B022F9BE619981A3DDB7DF7FC04228827460
7A9C98548DF4214D1C5253BFE2812A2858D31512036A86A0A2500CB24DBCC452BBAB2408C1B3B653C88FF6F24D2630
3C724D944660FB286BB3A499DA827D88537EB7B79546F904069167F4A6BDF4DB10B9963825938A9B77C815B91E8D42
29E443798AC75AA10DBBAEEBDDDE15D9892FDB75B8C336FAF8B1E6AA6A5A996DE0F2ACAA025AA627FD6AE631EB271
1065AF5320024DB832C72E5D4F39FE1C6A86F545FDFD2421448AD6270432F050D14D6E27B632157D5DB1D2EB0A902D
10B4D04643D815E7970A6F2A8991E4D70712D31E1029AE3ED26CB10A7E88AD536388B5E57E55DB1C166A3B5F7C6E90
A1F18B5CFADB8D67CCBC519A3E46B12AD18855A7402F9F1680E3880F5E048E2811865FF1E1376E0A88D0D5951EBAF84
8A3A0CD1F36A9AE57C4814158D3517CC891C3D456F79B4DAA89040B70A08A600A060C7540BE82BA5C2DEA91D21698
7C3BF2479F9B1FC5E73DDF8A9F42C6968FEB3F525CBE698D8C5FF609B2EFCAE63DD5A32B3D7AFB1C6112349346F0DCB
72B1840DC00CEDC1EC820C7F8B420F25CB6C744E739FBF10DEFFF0083B182EABB04AC09E988A2450D2CA48438AD288
A8F0483CA061D990DD9052471ED8EF7EB656AD7613961B481B00AF5B74BE0056184DB9B52E68C1F707B626A4AAA386
FC625ECBD0BD4FCD51F49C14AC9C212924832D5EF01AA47BDE65D2917977A11F3D32C54C4408D5FE8B0C35FF0264B9
B8D3B8B066F920DCA1006FFF8E83032DEB3B7806892DD3B4784E046305B7F91649447E867306E179795F343EB18FE97
B094CE696B0ADB8D40EFF1CC72B6159ED67F69D53EDD22BE2EBCF01BF41D98E0CD149D5248B3069816D388FBD66840
814511180738F87CA47F2E2A6B364BEAE0F832CE65A4097BF12D5895A44FADECA1C8A4D4BD72F9D39902D2475EE304
170BA582CD94A072208357A6B1270813D6BB8D6BD81E8C03C9C9F6894E6B141A79546F904069167F4A6BDF4DB10B99
63825938A9B77C815B91E8D4229E443798AC75AA10DBBAEEBDDDE15D9892FDB75B8C336FAF8B1E6AA6A5A996DE0F2
ACAA08544FA727F1BCE005E18AA2C7E1B68662DEA91D216987C3BF2479F9B1FC5E73DDF8A9F42C6968FEB3F525CBE69
8D8C5FF609B2EFCAE63DD5A32B3D7AFB1C6112349346F0DCB72B1840DC00CEDC1EC820C7F8B420F25CB6C744E739FB
F10DEFFF06A24904BD49311ACE510787944488AC8438AD288A8F0483CA061D990DD9052471ED8EF7EB656AD7613961
B481B00AF5B74BE0056184DB9B52E68C1F707B626A4AAA386FC625ECBD0BD4FCD51F49C14A06D3084EE6CF79290C65

B60D5FFF6A6D2DEA91D216987C3BF2479F9B1FC5E73DDF8A9F42C6968FEB3F525CBE698D8C5FF609B2EFCAE63DD5A3
2B3D7AFB1C6112349346F0DCB72B1840DC00CEDC1EC820E7BC289BE5BBFF40F90095067EFACB86B8CD6D9D0DE8C47E
33D66D002AA16FC399DAB06AC6FBA784ABCD53918F8F5CFCB4FE498592294B2FD3F51461AB1CE30566900ACC43D543
10A1256593ECB34724554DA42D1DB26D0B8BB27F2CF811CB051F8E7DDBF1EBAB0FD09482A114E0B665146B78EA0180
E4CFE603F6482C7F62E8FDEADA065B9EF6029EE3ACA2B28381CBD1F1B16B1EABAA0018F88BD7024570072477E42219C
9DB701CF38C18F232C28CF0DCDAFCA05B364AC43B6DB0F147358411BEB19611CD2C9DAD7AF1B0A147D09D7D24D318
56B2AB73283AFD17F4ED03F94D6BD77FA5F801D1BC01B8D691C95217B1BA2812770038060AD54CF03BE9F1E26803FA
817B30592282ED155BA5D9D41F2FB9B9750184192ACE775A875E1D0D669EB66D834565B7E7A340629D6FED8A52BBD7
376A36E0091489D1105AEBDE60CD1892AA26FEBED6D47835E5383A57F4B9913469DA3C8CE549C7B4570873E48F0802
D94A02449AED6AB81FC05F8FDBAC4B9D755A27F5350495AE4FD185D6E2C3B19A40BD2CF08660F55D66F902F6108229
1D91EE867943FB8C15538A5981C565F5F0DCDAFCA05B364AC43B6DB0F147358411BEB19611CD2C9DAD7AF1B0A147D
09D7D24D31856B2AB73283AFD17F4ED03F9D163CC9115588DC0352F64ED50E1A42D9AF39A33C3A471EC8994C3CE6F0
F5E6EC65D6840B89DA9174C1B4B139151B03B1592ED952EC9AA1976889297DF337C0D3087DA6264ACA6074368E25E7
B8B546E88D9E283DD6374294381E9964B2BC2A84FA248B4953961AA49B72AB47A239BAF1C0156D2229789EA5DC8DB
3861B4B2C5FAEE6307F6D641E97A67F8B5B1662AA6C913D5C7BAC6F620F8BB98846C3BE62224D7AE581C71671C6F0FB
48D4A54F097CBAFFB6131BCE4E1576C9CFA5B8040796460CC87F72FCB19B225111191925B60F09D6A3FF06A25D06D59
F3F80EF17FE53F1EA9C28789465D284E8519E27133A10EA021602AC9A1A0829427F4C3C453C58A76E4CC533B2D6CE1F
F6F75ED8D1DB09D64E64331518617436DEB2B12EDF2E9D1F1B16B1EABAA0018F88BD7024570075801ED7802A7A8BD5
91A446C2F8459E14196BE7D3ADA4C32A79F0B2249C59E9CA4D0C1451A1AE0BFD897BE75BA1DFC15A531B384779347A
811C8F93D8E7B6366AD132A0807A75242AD4C2C9D597B971D194E012FCE8CB6350CDD0D9CD6FE7596CB12FE2A24559
13127838AFDD1439FFBE4E5F2C10513E76C4225FF12A17256B9E370927768D1AD2E773854F5A66DA4CF56BD9572A950
CECAE115C13A3D8C2E9AFC1C1C0CEB3FAC55BAF4EA3085FD1346AB258DA4B0CF4443734E38256CA639BE39941EE2E4
5B2B9B70B6CF24316C9315723E04AEC70F9AB792276078AE527CC11BFC18C00CF745B242FB5D6E98BAF728D2337F551
CD7E4CF38588E9BCBC71CD9FD70EC55C2A65DFD9F0A23E2B1062F1866CAE5A85F70B248FBCA3C997FFAA4B8AEF7E94
C8D188CA1807A681E92FAC1E072BEE8933729C8A1D5F6821594D20201221DB110E87E38B5B5073A961FD718134305A
2E9228477E636F1BFA77C12604ACD42D4D809C8880CE8853DD492833931B6FDA3D56109BF2A9163A2F500174DEB455
0522770E89F105ADEBFDDC9C0E52C93A211A6145D16001E9EF6E14847FD1F41A0A5591D26B05052AF8AC8AB5EA5D1D
0020646B13A250CFE3E5187783B70EA42786418549616E153B627F749E4C5ECEAE0F832CE65A4097BF12D5895A44FAD
8E1AC1052C38D01DF72DFE1D43C588BAE60A836636DF854CBD8ECF5EC06FC68D",
}
Biller Details Response API – Pending Supported

{
"head": {
"refId": "OU0120200117183648REFTSR25428627207",
"origInst": "OU01",

"ts": "2020-01-17T18:36:52",
"ver": "1.0"
},
"reason": {
"complianceRespCd": null,
"complianceReason": null
},
"biller": {
"billerId": "HPSEB0000HIP02",
"billerName": "Himachal Pradesh State Electricity Board",
"billerAliasName": "HPSEB",
"billerCategoryName": "Electricity",
"billerMode": "ONLINE",
"billerAcceptsAdhoc": false,
"parentBiller": false,
"parentBillerId": null,
"billerOwnerShp": "PSU",
"billerCoverage": "IND-HIP",
"fetchRequirement": "MANDATORY",
"paymentAmountExactness": "Exact",
"supportBillValidation": "NOT_SUPPORTED",
"billerEffectiveFrom": "12-03-2018",
"billerEffectiveTo": "31-12-2099",
"billerTempDeactivationStart": null,
"billerTempDeactivationEnd": null,
"billerPaymentModes": [
{
"paymentMode": "Internet Banking",
"minLimit": 1,
"maxLimit": null,
"supportPendingStatus": "Yes"
},
{
"paymentMode": "Debit Card",
"minLimit": 1,
"maxLimit": null,
},

{
"minLimit": 1,
"maxLimit": null,
},
{
"paymentMode": "Prepaid Card",
"minLimit": 1,
"maxLimit": null,
},
{
"paymentMode": "IMPS",
"minLimit": 1,
"maxLimit": null,
},
{
"paymentMode": "Cash",
"minLimit": 1,
"maxLimit": 4999900,
},
{
"paymentMode": "UPI",
"minLimit": 1,
"maxLimit": null,
},
{
"paymentMode": "Wallet",
"minLimit": 1,
"maxLimit": null,
},
{
"paymentMode": "NEFT",
"minLimit": 1,
"maxLimit": null,

},
{
"paymentMode": "AEPS",
"minLimit": 1,
"maxLimit": null,
},
{
"paymentMode": "Account Transfer",
"minLimit": 1,
"maxLimit": null,
}
],
"billerPaymentChannels": [
{
"paymentChannel": "INT",
"minLimit": 100,
"maxLimit": 500000000,
},
{
"paymentChannel": "INTB",
"minLimit": 100,
"maxLimit": 500000000,
},
{
"paymentChannel": "MOB",
"minLimit": 100,
"maxLimit": 500000000,
},
{
"paymentChannel": "MOBB",
"minLimit": 100,
"maxLimit": 500000000,
},

{
"paymentChannel": "POS",
"minLimit": 100,
"maxLimit": 500000000,
},
{
"paymentChannel": "MPOS",
"minLimit": 100,
"maxLimit": 500000000,
},
{
"paymentChannel": "ATM",
"minLimit": 100,
"maxLimit": 500000000,
},
{
"minLimit": 100,
"maxLimit": 500000000,
},
{
"paymentChannel": "KIOSK",
"minLimit": 100,
"maxLimit": 500000000,
},
{
"minLimit": 100,
"maxLimit": 500000000,
},
{
"minLimit": 100,
"maxLimit": 500000000,

}
],
"billerCustomerParams": [
{
"paramName": "Consumer ID",
"optional": false,
"minLength": 12,
"maxLength": 12,
"regex": "^[0-9]{12}$"
}
],
"billerResponseParams": {
"params": [],
"amountOptions": [
{
"amountBreakupSet": [
"BASE_BILL_AMOUNT"
]
}
]
},
"billerAdditionalInfo": [],
"interchangeFeeConf": [
{
"mti": "PAYMENT",
"paymentMode": null,
"paymentChannel": null,
"fees": [
"CCF1",
"EBF"
],
"defaultFee": true,
"effctvFrom": "01-08-2019",
"effctvTo": null
},
{
"mti": "PAYMENT",

"fees": [
"CCF1",
"PBF"
],
"defaultFee": false,
"effctvFrom": "01-08-2019",
"effctvTo": null
},
{
"mti": "PAYMENT",
"fees": [
"CCF1",
"PBF"
],
"effctvFrom": "01-08-2019",
"effctvTo": null
},
{
"mti": "PAYMENT",
"fees": [
"CCF1",
"PBF"
],
"effctvFrom": "01-08-2019",
"effctvTo": null
}
],
"interchangeFee": [
{

"feeCode": "CCF1",
"feeDesc": "Customer_Convenience_Fee",
"feeDirection": "C_2_B",
"interchangeFeeDetails": [
{
"tranAmtRangeMax": 9223372036854776000,
"tranAmtRangeMin": 0,
"percentFee": 0,
"flatFee": 0,
"effctvFrom": "01-08-2019",
"effctvTo": null
}
]
},
{
"feeCode": "PBF",
"feeDesc": "Physical_Biller_Fee",
"feeDirection": "B_2_C",
{
"percentFee": 0,
"flatFee": 225,
"effctvFrom": "01-08-2019",
"effctvTo": null
}
]
},
{
"feeCode": "EBF",
"feeDesc": "Electronic_Biller_Fee",
"feeDirection": "B_2_C",
{
"percentFee": 0,
"flatFee": 225,
"effctvFrom": "01-08-2019",

"effctvTo": null
}
]
}
],
"status": "Active",
"billerDescription": null,
"supportDeemed": "Yes",
"supportPendingStatus": "Yes",
"billerTimeOut": "480"
}
}
Encrypted Request :
{
"responseMsg":
"2946B46F68BB8AB34F3C17ECF76D5E62F6A3C53A29B6CB2B78ABC3B8544A2E9D54230E2E063D302060A18D3AAEAAA
638332E432B8C4060E81A0C8D425B03B92861AADFCD8983BDBD114E5CBB6127F6ED41E7D5F48F8F372204758CCC012
17B2D65B1643DE375EBB33CD26EBB3953093E23261E09724EF7BD7950F4F210D48904D1DE7770BD2811652664995897
C755836B7C58471C710FC67C822C2DF7525F649EE09D511F82F69A70160B79B7A0046C4595B51C59EA5C2FD1DF79039
B386F6D0BCB15D883A5742FA8EC08681B624FBD5BDCA5BFC2CAE03A63E8BEAA9B8E9D947AC2CACB853A1CCC4033DE
27830964D994B6C1709EDBD8FE56985ED504B62479307053999C2EA81A55FC1FAD5A693420E172CF8D2E13434EDF8D
0F6C1892D4AB3519F175F90B2FFCC54BB265D167196FD86FD213FED657D60DA88856E372ED7E357C5647ED136CC082
D6024D8853B8AB156174E81B1E76518F38691DE195165C0A1AC9DC69D8747E066FD1289D0A7581FFBC90A8341FF8D8
2FEFF93995F2E6FE56AE71318BE55C17162E72F956DD8B53C2D65A4B3E7FD0EAFA5B85E9FB4FE3E6E4D874C01D42C06
6759B6F39FAA910925D951BE6D81FDDE8BA625C4D06AE4FCF3D4CAEF5E8300F409D051BBD350A0C9A781528565EAED
E88BE7E3335439DCEB8080E34D75A9B5F145FB48A53756AE12CE8A1CD86687CF6BA6F5488B9D9E0E13D37C942E8E056
FF4AC8717753BDD8E30682E4B4796E5116E90D4E971C5805D5D7871B944950B0455E2A73A3F5A8A1C1E0FF40E2D773
D6064818549F59C8D267795A7E120FE01511C42D507E19775013456D57C947A534427A1B255C25059035AE1F231486B
4152A6F42B740ED288F1700F191E16534F17281F36A718932766936AA9CD886F1BE0945C87E7C36AC1A4647DD069F2C
071F0A9C4ACF4A8B161057F84A8C9A3D6D494788A5FB2A9D83EB3EE116C8D2D8738FA2C10A90059D66939EDAF3B18E
74370A43602FF1C353690625D266366E07BF2470C97E406D512C8020BE51F53A5A4203450E117CC71E1F5B762DEB21D
6DAFA0150F858CF4DA8FD26F9486532094C6D7F79BBEECB896D2F9AA371C48E8C5F23A118CAD339A2EC3D17DA6BAA
1DF1666413A963E03E0201DB72831A06A157BC497366A84B49290E2E2F555048498DAE64EBF921EA36218A9B7899D84
82283D18FAC3552D6F5280BC8A85F44C6E68C8A15F99182212A567766BDBA727C174CF38A860DC15990E157A2ABA28
6A4AAA386FC625ECBD0BD4FCD51F49C14AD729596CCC78B9DBDBDCE7E34C8A00FB7DB386A8D502E771C2196C2279F
0773A85C5441C532D60A100D2A2731611F5AE025DA7B24B9F2CBD7173BCE5A3AB4777E7970A6F2A8991E4D70712D31
E1029AEF5BDED3E5897E3D760C75121682493BBA9A9AD550CA7AB6748BFB01ABFB0EF8DDA4B137CD204B165CA44EC
2F37BEE3170590C3F2EBA30F6C731BB06CE4CFACDC88D0D5951EBAF848A3A0CD1F36A9AE57C4814158D3517CC891C3
D456F79B4DAA03EF689FA26DAD4E879248089EAC6D1BDA4B137CD204B165CA44EC2F37BEE3170590C3F2EBA30F6C73

1BB06CE4CFACDC88D0D5951EBAF848A3A0CD1F36A9AE57C4814158D3517CC891C3D456F79B4DAAA0E4E0D1EF348BF
DB36FCB91E52F48E7DA4B137CD204B165CA44EC2F37BEE3170590C3F2EBA30F6C731BB06CE4CFACDC88D0D5951EBAF
848A3A0CD1F36A9AE57C4814158D3517CC891C3D456F79B4DAA1916076102F4DE01F622ED393E0792A5A0F03953909
659BFFFD42B6196455E9C70044B43559B9B40A1A1182A9B94554AAC75AA10DBBAEEBDDDE15D9892FDB75B8C336FAF
8B1E6AA6A5A996DE0F2ACAA051F69EE70DDF4795B1D61404635E684799F661BC337235617C2C14AC33C850017147ED
345AFFA1BACC3AEAE6DB03F42EB74BE0056184DB9B52E68C1F707B626A4AAA386FC625ECBD0BD4FCD51F49C14A49B6
110F16787B3BFDA3B6001487A0E199F661BC337235617C2C14AC33C850017147ED345AFFA1BACC3AEAE6DB03F42EB7
4BE0056184DB9B52E68C1F707B626A4AAA386FC625ECBD0BD4FCD51F49C14AEEBDAACB944B4A182A59C451FEE029F0
A4AAA386FC625ECBD0BD4FCD51F49C14A0729B97F373FCC1F0D5964156B4F6D91287DBA345A000CB984AE0D8E656EE
FCB91E8840AAEBB5C2382DE147CC1A811A0626A4F2A4C1D0EF6DE6CF07B022F9BE619981A3DDB7DF7FC04228827460
7A9C98548DF4214D1C5253BFE2812A2858D31512036A86A0A2500CB24DBCC452BBAB2408C1B3B653C88FF6F24D2630
3C724D944660FB286BB3A499DA827D88537EB7B79546F904069167F4A6BDF4DB10B9963825938A9B77C815B91E8D42
29E443798AC75AA10DBBAEEBDDDE15D9892FDB75B8C336FAF8B1E6AA6A5A996DE0F2ACAA025AA627FD6AE631EB271
1065AF5320024DB832C72E5D4F39FE1C6A86F545FDFD2421448AD6270432F050D14D6E27B632157D5DB1D2EB0A902D
10B4D04643D815E7970A6F2A8991E4D70712D31E1029AE3ED26CB10A7E88AD536388B5E57E55DB1C166A3B5F7C6E90
A1F18B5CFADB8D67CCBC519A3E46B12AD18855A7402F9F1680E3880F5E048E2811865FF1E1376E0A88D0D5951EBAF84
8A3A0CD1F36A9AE57C4814158D3517CC891C3D456F79B4DAA89040B70A08A600A060C7540BE82BA5C2DEA91D21698
7C3BF2479F9B1FC5E73DDF8A9F42C6968FEB3F525CBE698D8C5FF609B2EFCAE63DD5A32B3D7AFB1C6112349346F0DCB
72B1840DC00CEDC1EC820C7F8B420F25CB6C744E739FBF10DEFFF0083B182EABB04AC09E988A2450D2CA48438AD288
A8F0483CA061D990DD9052471ED8EF7EB656AD7613961B481B00AF5B74BE0056184DB9B52E68C1F707B626A4AAA386
FC625ECBD0BD4FCD51F49C14AC9C212924832D5EF01AA47BDE65D2917977A11F3D32C54C4408D5FE8B0C35FF0264B9
B8D3B8B066F920DCA1006FFF8E83032DEB3B7806892DD3B4784E046305B7F91649447E867306E179795F343EB18FE97
B094CE696B0ADB8D40EFF1CC72B6159ED67F69D53EDD22BE2EBCF01BF41D98E0CD149D5248B3069816D388FBD66840
814511180738F87CA47F2E2A6B364BEAE0F832CE65A4097BF12D5895A44FADECA1C8A4D4BD72F9D39902D2475EE304
170BA582CD94A072208357A6B1270813D6BB8D6BD81E8C03C9C9F6894E6B141A79546F904069167F4A6BDF4DB10B99
63825938A9B77C815B91E8D4229E443798AC75AA10DBBAEEBDDDE15D9892FDB75B8C336FAF8B1E6AA6A5A996DE0F2
ACAA08544FA727F1BCE005E18AA2C7E1B68662DEA91D216987C3BF2479F9B1FC5E73DDF8A9F42C6968FEB3F525CBE69
8D8C5FF609B2EFCAE63DD5A32B3D7AFB1C6112349346F0DCB72B1840DC00CEDC1EC820C7F8B420F25CB6C744E739FB
F10DEFFF06A24904BD49311ACE510787944488AC8438AD288A8F0483CA061D990DD9052471ED8EF7EB656AD7613961
B481B00AF5B74BE0056184DB9B52E68C1F707B626A4AAA386FC625ECBD0BD4FCD51F49C14A06D3084EE6CF79290C65
B60D5FFF6A6D2DEA91D216987C3BF2479F9B1FC5E73DDF8A9F42C6968FEB3F525CBE698D8C5FF609B2EFCAE63DD5A3
2B3D7AFB1C6112349346F0DCB72B1840DC00CEDC1EC820E7BC289BE5BBFF40F90095067EFACB86B8CD6D9D0DE8C47E
33D66D002AA16FC399DAB06AC6FBA784ABCD53918F8F5CFCB4FE498592294B2FD3F51461AB1CE30566900ACC43D543
10A1256593ECB34724554DA42D1DB26D0B8BB27F2CF811CB051F8E7DDBF1EBAB0FD09482A114E0B665146B78EA0180
E4CFE603F6482C7F62E8FDEADA065B9EF6029EE3ACA2B28381CBD1F1B16B1EABAA0018F88BD7024570072477E42219C
9DB701CF38C18F232C28CF0DCDAFCA05B364AC43B6DB0F147358411BEB19611CD2C9DAD7AF1B0A147D09D7D24D318
56B2AB73283AFD17F4ED03F94D6BD77FA5F801D1BC01B8D691C95217B1BA2812770038060AD54CF03BE9F1E26803FA
817B30592282ED155BA5D9D41F2FB9B9750184192ACE775A875E1D0D669EB66D834565B7E7A340629D6FED8A52BBD7
376A36E0091489D1105AEBDE60CD1892AA26FEBED6D47835E5383A57F4B9913469DA3C8CE549C7B4570873E48F0802

D94A02449AED6AB81FC05F8FDBAC4B9D755A27F5350495AE4FD185D6E2C3B19A40BD2CF08660F55D66F902F6108229
1D91EE867943FB8C15538A5981C565F5F0DCDAFCA05B364AC43B6DB0F147358411BEB19611CD2C9DAD7AF1B0A147D
09D7D24D31856B2AB73283AFD17F4ED03F9D163CC9115588DC0352F64ED50E1A42D9AF39A33C3A471EC8994C3CE6F0
F5E6EC65D6840B89DA9174C1B4B139151B03B1592ED952EC9AA1976889297DF337C0D3087DA6264ACA6074368E25E7
B8B546E88D9E283DD6374294381E9964B2BC2A84FA248B4953961AA49B72AB47A239BAF1C0156D2229789EA5DC8DB
3861B4B2C5FAEE6307F6D641E97A67F8B5B1662AA6C913D5C7BAC6F620F8BB98846C3BE62224D7AE581C71671C6F0FB
48D4A54F097CBAFFB6131BCE4E1576C9CFA5B8040796460CC87F72FCB19B225111191925B60F09D6A3FF06A25D06D59
F3F80EF17FE53F1EA9C28789465D284E8519E27133A10EA021602AC9A1A0829427F4C3C453C58A76E4CC533B2D6CE1F
F6F75ED8D1DB09D64E64331518617436DEB2B12EDF2E9D1F1B16B1EABAA0018F88BD7024570075801ED7802A7A8BD5
91A446C2F8459E14196BE7D3ADA4C32A79F0B2249C59E9CA4D0C1451A1AE0BFD897BE75BA1DFC15A531B384779347A
811C8F93D8E7B6366AD132A0807A75242AD4C2C9D597B971D194E012FCE8CB6350CDD0D9CD6FE7596CB12FE2A24559
13127838AFDD1439FFBE4E5F2C10513E76C4225FF12A17256B9E370927768D1AD2E773854F5A66DA4CF56BD9572A950
CECAE115C13A3D8C2E9AFC1C1C0CEB3FAC55BAF4EA3085FD1346AB258DA4B0CF4443734E38256CA639BE39941EE2E4
5B2B9B70B6CF24316C9315723E04AEC70F9AB792276078AE527CC11BFC18C00CF745B242FB5D6E98BAF728D2337F551
CD7E4CF38588E9BCBC71CD9FD70EC55C2A65DFD9F0A23E2B1062F1866CAE5A85F70B248FBCA3C997FFAA4B8AEF7E94
C8D188CA1807A681E92FAC1E072BEE8933729C8A1D5F6821594D20201221DB110E87E38B5B5073A961FD718134305A
2E9228477E636F1BFA77C12604ACD42D4D809C8880CE8853DD492833931B6FDA3D56109BF2A9163A2F500174DEB455
0522770E89F105ADEBFDDC9C0E52C93A211A6145D16001E9EF6E14847FD1F41A0A5591D26B05052AF8AC8AB5EA5D1D
0020646B13A250CFE3E5187783B70EA42786418549616E153B627F749E4C5ECEAE0F832CE65A4097BF12D5895A44FAD
8E1AC1052C38D01DF72DFE1D43C588BAE60A836636DF854CBD8ECF5EC06FC68D",
}

BILL FETCH API
Bill Fetch Request API helps customer side BBPOU to get bill details from NPCI.
Request Parameter for Bill Fetch API
Data Mandatory
Sr. No. Fields Description Length
Type / Optional
Example: OU01
It should be Unique for end-to-end process, i.e.
4 refId For both bill fetch and corresponding bill pay Character 35 Mandatory
transaction against the bill fetch
Example:
MAHA00000MUM0108062018165735MCZ1XDK

relate a request and response message.
It should be unique for bill fetch request and
5 msgId response and bill payment request and Character 35 Mandatory
response.
Example:
PYZAP08062018165735JXGVSZ4ACFB8MAZS
Risk evaluation associated with the transaction

and the related parties in the transaction. The
6 RiskScores tag information passed in this tag will be same as Character Mandatory
the example given below. Change the OU01 to
the BBPOU ID assigned to the linked OU
Meta data primarily for analytics. The

7 Analytics tag information passed in this tag will be same as Character Mandatory
the example given below
Customer mobile number who is requesting the
8 CustomerMobile bill fetch. The mobile number may be same or Character 10 Mandatory
different from the registered mobile number

CustomerDetails This tag carries the information provided by the

9 Character Mandatory
tag customer. This will be the list of key value pair.
Details of Device from which the transaction

was initiated. Device details are depending
10 Device tag upon the initiating channel. The information of Character Mandatory
device details required are given in the
Annexure IV
Agent by the NPCI post on-boarding by
11 AgentID Character 14 Mandatory
respective BBPOU
Example: AGNA00000MUM01
BBPOU
The parameters based on which customer will

perform the Bill Fetch operation. Biller must
configure the customer parameters at the time
CustomerParams
of biller on-boarding. Refer attached ANNEXURE
13 (List of Key Value Character Mandatory
III form for Customer parameter details. Max 5
Pair)
customer parameters can be configured by
Biller.

Bill Fetch Request API

{
"head": {
"ver": "1.0",
"ts": "2019-04-09T13:05:01+05:30",
"origInst": "OU01",
"refId": "OU01TESTABILLFETCHREF20190409130501"
},
"txn": {
"msgId": "OU01TESTABILLFETCHMSG20190409130501",
"ts": "2019-04-09T13:05:01+05:30",
"riskScores": [
{
"provider": "OU01",
"type": "TXNRISK",
"value": "030"
},
{
"provider": "BBPS",
"type": "TXNRISK",
"value": "030"
}
]
},
"analytics": [
{
"name": "FETCHREQUESTSTART",
"value": "2015-02-16T22:02:00+05:30"
},
{
"name": "FETCHREQUESTEND",
"value": "2019-04-09T13:05:01+05:30"
}
],
"customer": {
"mobile": "7466598081",
"tags": [
{
"name": "EMAIL",

"value": "arnabmoitra@npci.org.in"
},
{
"name": "AADHAAR",
"value": "123456789012"
},
{
"name": "PAN",
"value": "BXXCG7754K"
}
]
},
"agent": {
"device": [
{
"name": "INITIATING_CHANNEL",
"value": "INTB"
},
{
"name": "IP",
"value": "124.170.23.28"
},
{
"name": "MAC",
"value": "01-23-45-67-89-ab"
}
],
"id": "OU01OU21MOB527011179"
},
"billDetails": {
"billerId": "OTOE00005XXZ43",
"customerParams": [
{
"name": "a",
"value": "101"
},
{
"name": "a b",
"value": "102"
},

{
"name": "a b c",
"value": "103"
},
{
"name": "a b c d",
"value": "104"
},
{
"name": "a b c d e",
"value": "105"
}
]
}
}
Encrypted Request :
{
"requestMsg":
836CAE431AE2763402B196FE0AD2A586D03ABA21DB67ACB6A29CC70F6B23D873EBC7717F9B4338691C1EF5725901B2
0AF96DE13CBA2DC84D7486991FA9D194A18D7A176A717147FB4CF02B0098B5DA930F0A723F7D762B12E2339E3F3EFA
517937F7A99B51B1DF8B8BE12449C0BB98C82AFC8A60A4015F61C2AFD9A8DD51B16ED8A17748B475889DB4F74E008D
3918B36B92871BAE7271450B4841D6F03BB7F3D60646579D0EB3DD7109B3B0BBBAF35A68618A54E6F0F79955D8E4AF
68225DD3F9C23CC8C3B31D36D9A80398C46DD9D3925B20762B44A048396A42C9E136CBBF1A89F415CD4E94F6B1E8BB
2305A4020016CC99D361DE4D66037C05D9B3AC8D75B9E6AFA8A9558A78694B030648B3E99B09AF6B5C1261417978E3
CEA9715EFF3FF26DE13CBA2DC84D7486991FA9D194A18D231030AF06A0AE6D57813CC10077185CD8C09F9015D53257
2D1E635BAA2EE4357C9899775FE2BBCE8E6434BF1FB72BC409E1CD40E61F80D7DB4A3BD8AD2B6CFC3D3EDC7DCE1067
7930A42B5BDF3EB4F46ABE97B5869ED4DB6745D47F2CF54E96E68D25DB33A11EC426254A2D1655F251D3AB25F9BADC
647A4B6F9D0675DD1201B68133E6FDFBEBA219871564BCC0A4461994A66E88BC893036A7E766FFF2C21E2D0A790A26
AC0E2AD952E0F76804B24E3F936D9B2E32F132B7D31C1FAC75BE5474855A4ABFB267D37E7C33EE36014459CA2E3A365
072A6DDBDF6DFAA981BC68B832912E1F12D535F386E627ABD5A7948739F9B216C4E414D9F6DDD4D654D2CF8D8776A
C4C51BA5B2E60B8B7E0C3D5D262CE3FA06E608E75C158C01C5E4C732545DD43DE89C03C03A24267BFD708B7320BFCB
6E38847432974E6982CFBCA644BAE18A5B215A47B4BB3F96F2C7522604EFE680E692EED25A4E8A0659B0BE9D471866F
B06D111DFECFB7365E4C13C04E31490752080564A6D1FB89348EFFE4F03AE7C9899775FE2BBCE8E6434BF1FB72BC47C1
E7C4189F98277A899F673C34A7015DFE7BAB9EE95949CC51ED6B755FCCE77B93EB39DDA5555FF77676FE0BE7F5521C4
8B757B23DA1887A9DF8CA85CCBBB5E80F580E575583F7E02799B8A62BF7BE5ACCAA206760B0D35744A2BB4615FB56B
31172D895CEB86F2ABAACDE4D4916425DD502AE9E2E7234EFB57E981590794763A8588381257FF9C93BA2B5EE6DBCD
024A99A4A72BF1FCD25516710DDBC831385C452B417FF6765FDD288716D6567730A969842714733747FE65F13779E1A

18120D5BDE7FD442EB12F37A123980BCEEB3DA6F811045C0698ED7E1507285AEBF6E680E692EED25A4E8A0659B0BE9
D471846164A1727F2F9C3564EF991D888C5A7EFD3C938A9B2A727F59C882EB4C1320F7C9899775FE2BBCE8E6434BF1F
B72BC47C9BB02520DB6C75D0F8532727AEA7DC0CBB261D967CE4381D10DFBCD68DC2EB28811831F03E72C220CC12D
D81CAF497CA43CC6BE77F371E87EA0557F21A7F626E3AB24F78C9C979D8D4A8DE3E96AD1C7C9899775FE2BBCE8E643
4BF1FB72BC4E048C18314C927BF43C659C5E5027D9D272983C2C389887BAD5F0ACD21D9DF0DDA7B7FC077DF31A17C0
55D5F571179DC728E1CA957D2BB9B6147D6BD98037D84C1DF946861B94346D9A35C8A0DA2BD61C6355D9DDAC6462
368501AD8534A282C739F9B216C4E414D9F6DDD4D654D2CF822F9F747FF3141C77BD0682335BC83EA2C50EA33C1E5A
FFF53BD29B5E46D3334FD4C4FE421D311977A2AE08F0C4DC8CFF9A6C0F1EB5C8EB928A84DCC7E0F04661D0D1D5CA2D
674C0B457729102393FC03A13C14109A96FA3C0982A69A2AC276BA6072391FE4B605478F15EAE44197215611071E8D0
6307BEE6B89FB43CEE84FD22482DE101537B751FE5755147172574AC98107B49052597BF84358DEA302A961D0D1D5CA
2D674C0B457729102393FC03A13C14109A96FA3C0982A69A2AC276B1CDFBBA88049865337A3E1DFA5141F409C2E28B
AC886D1F2872DA043265EC41E837DFD1A76329AF6E3BBE49796C4E675C67C5C5396B67DA0E51D7AEF60918529B44D2
17A0BDB896E327B0316998C3DB8DEC914B1001E2DF31AC409A1FD0FAF8BC78BA5FC8D1AED2A0CA0D4BFADA93C3C61
A462047471366FE7F3860AD54BC3E691B99E95C6AAF27D9AA191BA44FC3EF8179EF205FD05B2B6E6A92452E28B25FA1
C037D7BBFBCF894846A0EA1850A032A1804EBA45672E275FDF8FC9924E8470CEA5A2DF2604A199735D5EA8C0CB8A58
E28811831F03E72C220CC12DD81CAF497CA43CC6BE77F371E87EA0557F21A7F6220BAB2837D3423C26160D2ED99BCE0
962D0A790A26AC0E2AD952E0F76804B24EDAC5D0C0D64F3018042A096608DEC00F9DB323B3C3D79F2BE8A313021709
28DD604AEA98067D95F8957AC5610BFDB614C3B3138911B46050938D66F34A186027C1F113E4F4F8884F52DC5FD0C41
C666070ACF533B9CE421AA58D33571178B3113DA6F811045C0698ED7E1507285AEBF6E680E692EED25A4E8A0659B0BE
9D471846164A1727F2F9C3564EF991D888C5A78F5898F581E2D8FBD4AC1B09B6BFCDEF2D0A790A26AC0E2AD952E0F7
6804B24E7495431FB3DC77E3B1648A29E7A6D9DB9DB323B3C3D79F2BE8A31302170928DD604AEA98067D95F8957AC5
610BFDB6146B508667CF713496CEA867288A3DC805AFF2A7AF1B88E56DD2C8C7AFE6BF5A28AA9A8434EC6F4DA7EFD6
2991153165280CBB261D967CE4381D10DFBCD68DC2EB28811831F03E72C220CC12DD81CAF497CA43CC6BE77F371E87
EA0557F21A7F6240B4685CD32107013B7A24130467C8FB3A13C14109A96FA3C0982A69A2AC276BC2C5984341DCCA63
482E796FCC79E2958E588C83D548D058495A3957586EE4A4499E434EF2409A926276EB73CB74DBDF",
}

Bill Fetch Response Parameters
Sr. Data Mandatory /

Fields Description Length
No. Type Optional
Example:
MAHA00000MUM0108062018165735MCZ1XDK
Example: OU01


000 for Success
Biller should pass the description of the Min 7
6 responseReason Character Mandatory
response code, as "Successful" or "Failure" Max 100
Internal reference number generated by Biller.
As defined by NPCI BBPOU will pass the refId in min 8
7 approvalRefNum Character Mandatory
ApprovalRefNum field if it is not provided by max 100
the biller.
Biller should pass the respective Compliance
8 complianceReason code (Error Code). Refer Attached Error Codes Character 3 Optional
list for details in Annexure I.
Reason (Error Description) which indicates the Min 7
9 complianceRespCd Number Optional
reason for a failed transaction. Refer Attached Max 20
Error Codes list for details in Annexure I
10 msgId It should be unique for bill fetch request and Character 35 Mandatory
response and bill payment request and
response.

Example:
11 billerID Biller by NPCI Character 14 Mandatory

CustomerParams
Pair)
Biller.
Customer Name registered in the billers system
13 customerName Character 100 Optional
(Only English text is allowed)
Bill Amount against the specific connection ID.

The Amount passed in response should be in
14 amount paise format (without decimal or commas). Numeric 20 Mandatory
Example: Bill Amount is Rs. 36.50 then the biller
should pass 3650 as the amount in response.
Due date against the specific connection ID

15 dueDate It should be in yyyy-mm-dd format. Date 10 Mandatory
Example: 1999-12-31
The date from which customer can pay the bills.

Bill date against the specific connection ID.
16 billDate Character 10 Mandatory
It should be in yyyy-mm-dd format.
Example: 1999-12-31
Unique identification Number of the bill in the

17 billNumber Character 20 Mandatory
biller system
Billing period of the bill.
18 billPeriod Example: January, Jan2019, Quarter1, First Character 20 Mandatory
Cycle, Year2019.
Customer convenience fee is Charged by BOU
19 custConvFee to customers directly it is in paisa format passed Character Optional
by BBPOU in response.
If the customer convenience fee is applicable
20 custConvDesc then description of same will be passed by Character Optional
BBPOU in response


AdditionalInfo tag can be used. Max 5 parameters can be
21 (List of Key Value passed by billers. Character Optional
Pair) Example:
Sample Bill Fetch Success Response
Clear Text Response:

{
"head": {
"refId": "OU01TESTABILLFETCHREF20190409130501",
"origInst": "BBCU",
"ts": "2019-04-09T13:06:16+05:30",
"ver": "1.0"
},
"reason": {
"approvalRefNum": "12345678"
},
"txn": {
"ts": "2019-04-09T13:06:15+05:30"
},
"billDetails": {
"customerParams": [
{
"name": "a b",
"value": "20"
},
{
"name": "a",
"value": "10"
},
{

"name": "a b c",

"value": "30"
},
{
"name": "a b c d",
"value": "40"
},
{
"value": "50"
}
]
},
"billerResponse": {
"customerName": "PRABHA",
"amount": "100000",
"dueDate": "2015-06-20",
"billDate": "2015-06-14",
"billPeriod": "june",
"custConvFee": "",
"custConvDesc": "",
"tags": [
{
"name": "Late Payment Fee",
"value": "40"
},
{
"name": "Fixed Charges",
"value": "50"
},
{
"name": "Additional Charges",
"value": "60"
}
]
},
"additionalInfoList": [
{
"name": "a",

"value": "10"
},
{
"name": "a b",
"value": "20"
},
{
"name": "a b c",
"value": "30"
},
{
"name": "a b c d",
"value": "40"
}
]
}
Encrypted Response:
{
"responseMsg":
"2946B46F68BB8AB34F3C17ECF76D5E62793A96B427B63154EA86B98395D587C531A44010271647EA208DBCDAF6C3
BF16CF24469F17C37FD8EF0CC1DE4C82A76C3E787E113A314B94F50A3272BCCDA4CDB8A0ED7304B6E088C141074D
C639BD6902A92AAB877CA68E644D3A102A8FB5AD58E33C9E5AF146F395FDC21EF7F0F4CD4E0F05C64584C879FDCA
EE8BF8B7627A469378E5C4FDC01DB712D6A38F0B2D91A04EE4983D24E4306621FE65C4D33BB1FF82CDC7D2679405
C503AA8B783AB5FB7A6C0A156BB8B9DE23541E42F1B997121FCC88618E1FDDBE5B7F7495D4C45181F15D4F012C9A
4D7D085A0EEF11F73C490F8C3FA795BFBCF4B78D725701D922A644BB8A20F1FC593FC775A89125D31C0954E44E9FD
FEF0463B3815D7CA3535B634E410F29B450C9232647910406AFF385001E4922119BC96FE906726DF2BA6A2FD67AE4
6580D21811C601263FCA6C14FAC0EFC87778496AAFCF53947D4FF43E24DDA670249725746D3231E14D4D38728D6F2
D85691527FE575A44E73E35A1BD450D7D2028BDB20F2D9BD90682D5E496455FAF14BC05ED48310CA696A3B918B76
E8A061235F169B718CC6899CC549DBDD0EBC1710A80C34A27E1238EB222205EB2FE0D1B325B2B3DCB4BAB258A382
1344BA6D5935E67439B03131BFAC7227B2FB2A02EA8CEC086FCB24B8DD6AEC360498B0D6C26BA6D9D1BC5C259E02
D25EB882C3E77B99C29D26EBE2FB424F7B63DCAD8E35E399A522C4C71898A88D7DDF230F9881F1AC752978E9DFA7
C42A971E3C0E289777BEA6B16FC10EB216CECA6C5354544728C75E0260AC5D852BAC43EC32519221FF43245F84914
03AFEC6474DE5EDB1332FFCF1BDFBD2D72335ABB4A89AC54BABCE2A9B116638E53E907245718A845A0797885B8A2
5D8B618331FC7C87DA88B42790F9CEF97A8EBC206ABD83E05C7C337434EF73134C4DE0D25CC8FF3954162ECA82B12
DCF916BE90C51E8C359D05EF28134D087D78C517840A65731B7BD4E591CE0FA87F3168A38AFB1AABBCB4CF1E06CD
6E46AB7FEF9981C6DDB350AFD044416FE63FCAC1AD4B8531075CEF05E2FF237FED7051F54899BCB8153EB27BB048B
42ADAEE811BBB49306AAC57A9A1D1A98F40770703B7A88BF8856D70491E84BFB42739A8E6B3A6B67A448037A14FE
6A1B7CDC29040483D454E8E43FD4D00A6E6F2D85691527FE575A44E73E35A1BD45B3980AC2527CD0A298A7823DAE
8CA1EF0C564C36A78BBFB783FE471A1621544B56C19797DDD41751376E5998364083BC60E34269656A17889517BF7
F8436817896612FC645FBAA90BA4D70CF20DC7576",

}
Sample Bill Fetch Failure Response

{
"head": {
"refId": "OU01TESTABILLFETCHREF20190409130502",
"origInst": "OU01",
"ts": "2019-04-09T13:09:55",
"ver": "1.0"
},
"reason": {
"responseReason": "Transaction timed out"",
"complianceRespCd": ""
},
"txn": {
"ts": "2019-04-09T13:05:02+05:30"
},
"additionalInfoList": []
}
Encrypted Response:
{
"responseMsg":
"2946B46F68BB8AB34F3C17ECF76D5E62793A96B427B63154EA86B98395D587C531A44010271647EA208DBCDAF6C
3BF16CF00F5EF37C826373D1028BC5C34762D8EC4895BDD6D7C4A3E83769DD7CEE90521ED94B829175DC07472048
CECA52BD3FDA0CDDA8EDB8D5CF3F4ADAA98E27A7423261E09724EF7BD7950F4F210D48904A04748E47380ADFD71
278ABFA0C152046B7C58471C710FC67C822C2DF7525F64C82F587AF798F854F66EA5080973D39AA071F52E9C681F2
3A6F9F94AE8263A47AE65FBC1B37BA06334E3B73B604B094A33E5AB052A52FC9BD9CCDE31EA37F6C6F57D2530CED
47206CF25847DFF24E1847CED1F44A0EB706F20F6151434A935FEC6CF44A864EB6AF8251057EE406A96FC65E313661
73212B38DA7F379BFAE1C88392023C439662A0E9CF55E52990A06E2",
}

BILL VALIDATION API
Bill Validation Request API helps customer side BBPOU to validate bill details.
Request Parameter for Bill Validate API:
Sr. Mandatory
No. / Optional
Example: OU01
It should be Unique for end-to-end process, ie.
Example:
MAHA00000MUM0108062018165735MCZ1XDK

5 Agentid Character 14 Optional
respective BBPOU
6 billerId Biller by NPCI Character 14 Mandatory
CustomerParams
Pair)
Biller.

Sample Bill Validate Request:
Clear Text Request:

{
"head": {
"ver": "1.0",
"ts": "2019-04-09T13:54:01+05:30",
"origInst": "OU01",
"refId": "OU01TESTABILLVALDNREF20190409140001"
},
"agentId": "OU01OU21MOB527011179",
"billDetails": {
"billerId": "OTNS00005XXZ43",
"customerParams": [
{
"name": "a",
"value": "101"
},
{
"name": "a b",
"value": "102"
},
{
"name": "a b c",
"value": "103"
},
{
"name": "a b c d",
"value": "104"
},
{
"value": "105"
}
]
}
}

Encrypted Request:
{
"requestMsg":
"14A693F86D1604157F6FC23E35D6388B93CE5FF542A6E02CC0F8FADECB69FB35EAB82875ACBED0AF6F9DFBC86359
A0836CAE431AE2763402B196FE0AD2A586D0C2EE41C02939CCC65B721F6F27671F22C7717F9B4338691C1EF572590
1B20AF96DE13CBA2DC84D7486991FA9D194A18D7A176A717147FB4CF02B0098B5DA930F79865FD416ACD543AC4D
FF4E19E344B5E1656290EDCE09D30F65119FD5E23F2F3C165B9FC38AF617D25906B6B3A56775B27B96B8BA26C9CD
02BBBDFBFC604C6167B84C6D858B0FCDCE30372F2E2AAAC3675B67A50B330E21407C1FFD019679D1AD8245FC350
AF566D8C72917B9BFE51430DD0A559C54AF4BED4838B3417CFC61AA7CEF980DF426CA7D17C3C586271B3AE25D67
1051DB9DC2D4851CAF5CBA35ACDD502AE9E2E7234EFB57E981590794763A8588381257FF9C93BA2B5EE6DBCD025
65D57D853AA76BDDD71A5778B23784F4B3D5808350E854CEFC9EA0E725FCE1D624F1D13B43CA7E30248340C4866
3A101D0D1D5CA2D674C0B457729102393FC03A13C14109A96FA3C0982A69A2AC276BB81D9FA4ACD955EF0CF8CC5
B2A7DE0859C2E28BAC886D1F2872DA043265EC41E598B414F40CA27031D236B594C167C706448C687FB34F35AAB8
41D33C926DDEBC4B69DF99F76EE5635C727FF981081050D7E332D561758EA294123C2B18C968B9F77975057768CFF
0DCE6675D0CECC434B3D5808350E854CEFC9EA0E725FCE1D615059F2C070A3A47B6B3C67FA176D351D0D1D5CA2D
674C0B457729102393FC03A13C14109A96FA3C0982A69A2AC276B030D4C3CD6062047766005EE29831574D59E012
D120C282347C44A54C5EB1330C0006E74FE00F926B523F917C833E6F14A9F670FF8B5D59CF6C4B19447218B38DD50
2AE9E2E7234EFB57E981590794763A8588381257FF9C93BA2B5EE6DBCD027A85C4FEC6B67EC30751E7FE10E83AB6C
1F113E4F4F8884F52DC5FD0C41C66608154DDEFAA1AEE04CBE28E66F8EF04F31952EC8AB07AF7BD9206F3926A1C0B
A55B15CDCBFA843CB61BFF0C9F24BCCE00",
}
Bill Validation Response Parameters
Sr. Mandatory
No. / Optional
Example:
MAHA00000MUM0108062018165735MCZ1XDK
Example: OU01


As defined by NPCI BBPOU will pass the refId in
5 ApprovalRefNum Character 35 Optional
ApprovalRefNum field if it is not provided by
the biller.
6 responseCode transaction Character 3 Mandatory
000 for Success
8 complianceRespCd code (Error Code). Refer Attached Error Codes Character 6 Optional
list for details in Annexure I
Reason (Error Reason) which indicates the Min 7
9 complianceReason Character Optional
AdditionalInfo tag tag can be used. Max 5 parameters can be
10 (List of Key Value passed by billers. Character Optional
Pair) Example:
Sample Bill Validate Response:

{
"head": {
"refId": "OU01TESTABILLVALDNREF20190409140001",
"origInst": "BBCU",
"ts": "2019-04-09T14:01:52+05:30",
"ver": "1.0"
},
"reason": {
"approvalRefNum": "AB123456",
"complianceReason": ""
},

}
Encrypted Response:
{
"responseMsg":
"2946B46F68BB8AB34F3C17ECF76D5E621106A1BAD1DEB0B90DB4A6295EC9389868F1726EDA401678426B68990F4
9AFF747E85208D39B05444B6CF57BEAAF6F473E787E113A314B94F50A3272BCCDA4CDBFA71307AD0D00FE87B90B
5CC65129E7E5EAACE3FD4D6189BCBAF6C1810A8AC658E33C9E5AF146F395FDC21EF7F0F4CD4E0F05C64584C879FD
CAEE8BF8B7627A469378E5C4FDC01DB712D6A38F0B2D91A04EE4983D24E4306621FE65C4D33BB1DE92344F09B35
DAEF35F7F64066E190B017FFDAD38161020A4527DEA31A344669FF5764A6AAE717C2F9E5230D2F9EA8565E313661
73212B38DA7F379BFAE1C88392023C439662A0E9CF55E52990A06E2",
}
Sample Bill Validate Failure Response

{
"head": {
"refId": "OU01TESTABILLVALDNREF20190409140002",
"origInst": "OU01",
"ts": "2019-04-09T14:03:27",
"ver": "1.0"
},
"reason": {
"responseCode": "VALIDATION_ERR",
"responseReason": "NPCI Rejected The Request.",
"complianceRespCd": "BLR006",
"complianceReason": " Biller/SubBiller does not accept Validation"
},
}
Encrypted Response:
{
"responseMsg":
"2946B46F68BB8AB34F3C17ECF76D5E621106A1BAD1DEB0B90DB4A6295EC9389868F1726EDA401678426B68990
F49AFF7655B876712CFC1EFFA15151ACC679E4E8EC4895BDD6D7C4A3E83769DD7CEE905E928FDC7BF361DAF9DA
B8DBF8B89DF46AF4837D81340B370C3E94EE639F5C44123261E09724EF7BD7950F4F210D4890473ED6BF1B290AA
C63C66E2EBBF621314B2955C973AEDE75CA2C0E1A1485D0F8921396ABE5F0E89151EAFE9879235B55F331CF585F
7074A8E3AF16758A8110314D2064C40FC681C62CCBA6ECA25C2A3EB5FC63464CCA5C2C2282BC9D7F404D6D8BF1
ECACE27D4DAF699DC6F0D0882F6B25DD47FE547B21B4B45800EC5D70C24291021B4DD3E1EEFF98918647567E9E

70B51DDDEAD0A2C4A7F193A7B40B3AA13855DC67737B666946807357A90BDFF2CE59D6EB5D62097713B910258
53E6B4FD9D96612FC645FBAA90BA4D70CF20DC7576",
}

BILL PAYMENT API
Bill payment API is used for confirmation of the bill payment to the Agent Institution from customer side BBPOU.
Bill Payment Confirmation Parameters
Sr. Mandatory
No. / Optional
Example: OU01
4 refId For both bill fetch/validation and corresponding Character 35 Mandatory
bill pay transaction against the bill fetch
Example:
MAHA00000MUM0108062018165735MCZ1XDK

response.
Example:
Unique Transaction reference (UTR) number
generated by AI/Agent. UTR will be Unique
throughout the BBPS ecosystem. Same will get
displayed on receipt for bill pay transaction.
Logic One:
6 txnReferenceId Format of transaction reference ID will be first Character 12 or 20 Mandatory
four characters as OU ID, followed by 08
random characters.
Example: OU01ABCDEF12
Logic Two:

Format of transaction reference ID will be first

four characters as OU ID, next four characters
as Julian date in ‘YDDD’ format & followed by
12 random characters.
Example: OU019169ABCDEF123456
The type of message will be "Forward" by
7 type Character Mandatory
default
Risk evaluation associated with the transaction
and the related parties in the transaction. The
information passed in this tag will be same as
8 RiskScores Character Mandatory
the example given below example. Change the
OU01 to the BBPOU ID assigned to the linked
OU
Meta data primarily for analytics. The
9 Analytics information passed in this tag will be same as Character Mandatory
the example given below example
Customer mobile number who is requesting the
10 CustomerMobile bill fetch. The mobile number may be same or Character 10 Mandatory
different from the registered mobile number
This tag carries the information provided by the
11 CustomerDetails Character 20 Mandatory
customer. This will be the list of key value pair.
12 AgentID Character 14 Mandatory
respective BBPOU
Details of Device from which the transaction
was initiated. Device details are depending
13 Device upon the initiating channel. The information of Character Mandatory
device details required are given in the
Annexure IV
BBPOU
CustomerParams
Pair)
Biller.

Transaction Amount against the specific

connection ID. The Amount passed in request
should be in paisa format (without decimal or
16 amount commas). Character 20 Mandatory
Example: Transaction Amount is Rs. 36.50 then
the NPCI should pass 3650 as the amount in
response.
Customer convenience fee is Charged by BOU
17 custConvFee to customers directly it is in paisa format passed Character 20 Optional
by BBPOU in response.
Customer convenience fee is Charged by COU to
18 couCustConvFee Character 20 Optional
customers directly it is in paisa format.
Currency of the amount to be paid. By default

19 currency Character 3 Mandatory
currency value will be 356.
Amount paid for the split pay. Allowed only if

splitPay flag is Yes. The Amount passed in
request should be in paise format (without
20 SplitPayAmount decimal or commas). Character 20 Mandatory
Example: Transaction Amount is Rs. 16.50 then
the NPCI should pass 1650 as the amount in
response.
This Flag (Yes/No) will be passed by AI/Agent,

If payment is done without bill fetch or bill
Min 2
21 quickPay validation, then Yes Character Mandatory
Max 3
If payment is done after bill fetch or bill
validation then No
This Flag (Yes/No) will be passed by AI/Agent,

when customer pays the partial bill amount Min 2
22 splitPay Character Mandatory
If partial payment is done then Yes Max 3
If partial payment is not done then No
Min 2
23 OFFUSPay OFFUSPay flag (YES/NO) passed by AI/Agent. Character Mandatory
Max 3
Mode by which payment has been done by the
customer. Valid values are based on initiating
24 paymentMode Character 20 Mandatory
channel and mapping is given in Annexure VI
Example: Credit Card, Debit Card
Payment information of the instrument which is
PaymentInformation used for making the bill payment. Payment
25 (List of Key Value information depends upon the payment mode Character Mandatory
Pair) by which payment is done by the customer. The
list of payment information is given in Annexure

In this agent institution will pass the account

26 debitAccountNo from which the transaction amount will be Character 20 Optional
debited.
Sample Bill Payment Request - Internet Banking Pre-Login
Clear Text Request:

{
"head": {
"ver": "1.0",
"ts": "2019-04-09T14:02:01+05:30",
"origInst": "OU01",
"refId": "OU01TESTABILLPAYMTREF20190409140201"
},
"txn": {
"msgId": "OU01TESTABILLPAYMTMSG20190409140201",
"txnReferenceId": "OU0109140201",
"ts": "2019-04-09T14:02:01+05:30",
"type": "FORWARD TYPE REQUEST",
"riskScores": [
{
"provider": "OU01",
"type": "TXNRISK",
"value": "030"
},
{
"provider": "BBPS",
"type": "TXNRISK",
"value": "030"
}
]
},
"analytics": [
{
"name": "PAYREQUESTSTART",
"value": "2015-02-16T22:02:00+05:30"
},
{
"name": "PAYREQUESTEND",

"value": "2019-04-09T14:02:01+05:30"
}
],
"customer": {
"mobile": "9898990087",
"tags": [
{
"name": "EMAIL",
},
{
"name": "AADHAAR",
"value": "123456789012"
},
{
"name": "PAN",
}
]
},
"agent": {
"id": "OU01OU21MOB527011179",
"device": [
{
"value": "INT"
},
{
"name": "IP",
"value": "124.170.23.24"
},
{
"name": "MAC",
"value": "01-23-45-67-89-ab"
}
]
},
"billDetails": {
"billerId": "OTOE00007XXA63",
"customerParams": [

{
"name": "a",
"value": "101"
},
{
"name": "a b",
"value": "102"
},
{
"name": "a b c",
"value": "103"
},
{
"name": "a b c d",
"value": "104"
},
{
"value": "105"
}
]
},
"amount": {
"amount": "100000",
"custConvFee": "0",
"couCustConvFee": "10",
"currency": "356",
"splitPayAmount": ""
},
"paymentMethod": {
"quickPay": "Yes",
"splitPay": "No",
"offusPay": "Yes"
},
"paymentInformation": [
{
"name": "CardNum|AuthCode",
"value": "4336620020624963|123456"
}

],
"debitAccountNo": "01732090003112"
}
Encrypted Request:
{
"requestMsg":
A083AC6636992E14D95372899D39CAEBCF3D8646015CF6711197550F72A7D24C65B9C7717F9B4338691C1EF572590
1B20AF96DE13CBA2DC84D7486991FA9D194A18D7A176A717147FB4CF02B0098B5DA930FCFC1B7B013800CD9D87D
506731CDF58ECD42AFA0D2BD18F2E3196C301CF8C332FC8A60A4015F61C2AFD9A8DD51B16ED8A17748B475889DB4
F74E008D3918B36B2C495B57540E7901CFAF7D89AF539B28877E4C18BC2F6B8A6A87EA79226E468EDB9C2260BB8DD
2BC1D127C101F35BB4D24350B3DD858DFD3B87F211E579FF3975BAF422E9A7F79C1C9A1038E9D9775F5ED0F61A4D
357F86922826777E9C99FBF27A20D6F0F011BEEF0A23CB00DB520498F4EDE630061EE9A65F44873B47B3EFEC0A3B7F
EC2471FD962C6783F416CA78DFED0158B03C486CFAE08DB13CB9367B589F415CD4E94F6B1E8BB2305A4020016CC99
D361DE4D66037C05D9B3AC8D75B9E6AFA8A9558A78694B030648B3E99B09AF6B5C1261417978E3CEA9715EFF3FF26
DE13CBA2DC84D7486991FA9D194A18D231030AF06A0AE6D57813CC10077185CD8C09F9015D532572D1E635BAA2EE
4357C9899775FE2BBCE8E6434BF1FB72BC409E1CD40E61F80D7DB4A3BD8AD2B6CFC3D3EDC7DCE10677930A42B5BD
F3EB4F46ABE97B5869ED4DB6745D47F2CF54E96E68D25DB33A11EC426254A2D1655F251D3AB25F9BADC647A4B6F9
D0675DD1201B68133E6FDFBEBA219871564BCC0A4461994A66E88BC893036A7E766FFF2C21E2D0A790A26AC0E2AD
952E0F76804B24E3F936D9B2E32F132B7D31C1FAC75BE5474855A4ABFB267D37E7C33EE36014459CA2E3A365072A6
DDBDF6DFAA981BC68B832912E1F12D535F386E627ABD5A7948739F9B216C4E414D9F6DDD4D654D2CF8A544520333
675F76DC92F3141D102AF7BB6B953ACEC472DAD8738D2ABCB6E3E9C727E8C307EACF05056EE0F94A6BA0BD1CA879
66B6ABD0887A800FB34BEE090E624EFD008F45872B4DC38F5813C71399A367C0597005E02D45FDA8553303151460B
2925A951DA3917FE0F192E0876F1313E283C006D5EE96EFCC9B3EB6B4D378FD4C4FE421D311977A2AE08F0C4DC8CF
6EA807383B95905BBDEE6AAB3CCB8C55329CE660F75F3802E8C25C2F44472AC362F2FD8B7FF0E2A6F188ED784CCE1
07857063AFEEB0B948F15A1E57D2733298D8D0E2236C5A348C03D466F331F51059D5CE33E9C33A584937D6BF95352
B41CC00F75CFA9794D742678D4612D2008CE4FC4B69DF99F76EE5635C727FF981081050D7E332D561758EA294123C
2B18C968BDA2303D81F5ABF032BA4C3EDD9557CE64B3D5808350E854CEFC9EA0E725FCE1D1F99978CA95E70224977
7E3112E206644E16D2E102BDBF0CB27543AD8AFD8185166ACE36F9A13AE2A4031AED0D1F2C4E90A1D0F2ADA7205B
52D3FF878BE3792B31606E5F9F8B95523AA749A6B49BA4ED4F3A9215AFFEDB023CEEF822EC33A024FD4C4FE421D31
1977A2AE08F0C4DC8CF78EBFA21E02BA7E4F0B4EFE80E993E033DA6F811045C0698ED7E1507285AEBF6E680E692EED
25A4E8A0659B0BE9D471846164A1727F2F9C3564EF991D888C5A77D5CD1D93624D467FA1A3B141E2B1790FD4C4FE4
21D311977A2AE08F0C4DC8CF170356CE7DB6337CCCAAFCF9D6EFAB28571D28E3DD0DBC0CD0EBBE35B305DC2763B
D00F9E515C029A4831A305C1534C2FA70427E98DA0DB83B081927B985F9B0B27B96B8BA26C9CD02BBBDFBFC604C6
106F7CE3B03BD7EF88E1A635FE68AB1DC66E77CA16246EDDBC0A80250BBA7D11AFEFC46D8316C3EA6BEDDCFFC6A3
75A912254A074C665BF9065FDB28CB032F347E0C1B5B8448DEAA728CED5D6D65E65F55ED5E2B0B19D3C91D00CE58
0399E794B4B3D5808350E854CEFC9EA0E725FCE1D6045AFCDAC72EFDCEC1E12E398D640A89DB323B3C3D79F2BE8A3
1302170928DD604AEA98067D95F8957AC5610BFDB61466973A8F3BA60B3D77C1247D4AB6881D9C2E28BAC886D1F2
872DA043265EC41E6BA74B852AC9446D5F990A76B4F115D89A50BAA9B5EA82B73EA9F1D3589CF0B79DB323B3C3D7

9F2BE8A31302170928DD604AEA98067D95F8957AC5610BFDB614022EFEC51EBDFFB9B99FE784E841466AC1F113E4F
4F8884F52DC5FD0C41C66608400A12847A7A542F055281BEEB99E921A60E6A4A7834DFFA1BA77E1FE5CACFE571D28
E3DD0DBC0CD0EBBE35B305DC2725A0A20552D20248D4D62DC4C3EAAD1BD5735DD5361FEBDDDD0E7EB77DCB696
D9C60D08A50539A8D23DA60387B885C2B5A90B0596FF99B233B6ECCF6BC3DD66252470F45977DAD269CE1EAB329E
9198A2CF86BFE18E87FC52B2AF9250706A66FE680E692EED25A4E8A0659B0BE9D471846164A1727F2F9C3564EF991D
888C5A7A04D5840F8F2259BC7335C82A2E0C536998D86F805D6FDE1B14D5C7D023D68DDFAE6935AEC83A1FD70804
D042964AB76A453BFEE300DB75EC266400A949C478FEA0C4F64D8C740C42A4E9048AB1A5A116714E9A953174C4528
1C986B3EE2235F5C452B417FF6765FDD288716D6567730D13FABC7DFCD947FBF11CF0BBF3196DE166ACE36F9A13AE
2A4031AED0D1F2C4E90A1D0F2ADA7205B52D3FF878BE3792B34B3921C4F8679FFF1F97B6CD0E1AF5AF352419D1CA4
DA256D11FAA603A1FEC5998D86F805D6FDE1B14D5C7D023D68DD8B5AE306701A28B865EC34BAD7382301A453BFE
E300DB75EC266400A949C478FEA0C4F64D8C740C42A4E9048AB1A5A11D4087DBCF2B5C478834AAD0F3E07C29EC1F
113E4F4F8884F52DC5FD0C41C666012B09B77AE20BA437305F488B2CFF3783DA6F811045C0698ED7E1507285AEBF6E
680E692EED25A4E8A0659B0BE9D471846164A1727F2F9C3564EF991D888C5A78F4C6C93CECE5A1211561146C89DE2
49D0E685A011C489D245A1969232210FCA3654BB5A603F904E724ACEED66DEC19EB44D217A0BDB896E327B031699
8C3DB892D15316DB7B569FCA1E140CB19149B4EB21AA7207D8E2794F45FC2C69C52D9D2A755CB1E1276AC5A9F914
479F8A17B0D836075E08512AC268C09B3AE2EEFA48304460A102B7691B619FF4A671F2C9BDC8461015EAE5AC2F7A8
3E2EA9DC226E90525ECA7B7B42DE188514923CAA22A59E07AA3D6433DCD736F7EF09679D1885F5F789ECAD810178
D79152D8BCEBC4F6FB51964E39A41B134F1012F78F9F19F3816F549D431559FD9E1CAAE36EEC48593527084C23DA9
1B2965ACF82A183D9E22B693DB6DAFAACAC28F7C7A9864F0599A41E7EE8997079E01AEC6B6111F680341976CEB116
924AD4951E2CE59B9BC3494E05BE78277ACD2D3EF8DF215D622F0682D5091404E56D332B73C1D29B954AA1E69FEC
FE0A16781C8992E48659D4EDD8BAFC1C433A498D0F8BE8499BC686299B7CC0B3582733ACD8E0AFF0DBE312C1B496
D5F2B7682965A574E425AC70C2CDD0D4582893294D49EB84E2ED384DE6FB430F0199858CF378AC9AE307A32EFE9A2
BB46164A1727F2F9C3564EF991D888C5A7A66F664F7465C161E3EC51B4E6548B139A86B4FDF03147ED396FA39A9EC
D0B1AE611C341497493A2062102D56426C845FD34BF253EB831E92B39F0C81E568FBAB18362A2C518285973D5CFFF
3345DE8C6EC653C70C7B46C2AFF33660F3FE4845F943E260DC50332E1FA5824CC9F7C5266BFDF67DF66156B82C6A11
EDE4AD3D20",
}
Sample Bill Payment Request - Internet Banking Post-Login
Clear Text Request:

{
"head": {
"ver": "1.0",
"ts": "2019-04-09T14:02:01+05:30",
"origInst": "OU01",
"refId": "OU01RUCHIhILLFETCHRwF36690409130501"
},

"txn": {
"msgId": "OU01RUCHIBILLPAYMTMSG20652409140201",
"ts": "2019-04-09T14:02:01+05:30",
"riskScores": [
{
"provider": "OU01",
"type": "TXNRISK",
"value": "030"
},
{
"provider": "BBPS",
"type": "TXNRISK",
"value": "030"
}
]
},
"analytics": [
{
"value": "2015-02-16T22:02:00+05:30"
},
{
"value": "2019-04-09T14:02:01+05:30"
}
],
"customer": {
"mobile": "7466598082",
"tags": [
{
"name": "EMAIL",
},
{
"name": "AADHAAR",
"value": "123456789012"
},
{

"name": "PAN",
}
]
},
"agent": {
"id": "AU01AU02INB529957923",
"device": [
{
"value": "INTB"
},
{
"name": "IP",
"value": "124.170.23.24"
},
{
"name": "MAC",
"value": "01-23-45-67-89-ab"
}
]
},
"billDetails": {
"customerParams": [
{
"name": "a",
"value": "101"
},
{
"name": "a b",
"value": "102"
},
{
"name": "a b c",
"value": "103"
},
{
"name": "a b c d",
"value": "104"

},
{
"value": "105"
}
]
},
"amount": {
"amount": "100000",
"custConvFee": "0",
"currency": "356",
"splitPayAmount": "",
"tags": null
},
"paymentMethod": {
"quickPay": "Yes",
"splitPay": "No",
"offusPay": "Yes"
},
{
"value": "4336620020624963|123456"
}
],
}
Encrypted Request:
{
"requestMsg":


EDE4AD3D20",
}
Sample Bill Payment Request - Mobile Banking Post-Login
Clear Text Request:

{
"head": {
"ver": "1.0",
"ts": "2019-04-09T13:05:01+05:30",
"origInst": "OU01",
"refId": "OU01RUCHIBILLFETCHREF20190409130698"
},
"txn": {
"msgId": "OU01RUCHIBILLPAYMTMSG20690409140658",
"ts": "2019-04-09T14:02:01+05:30",
"riskScores": [
{
"provider": "OU01",
"type": "TXNRISK",
"value": "030"
},
{
"provider": "BBPS",
"type": "TXNRISK",

"value": "030"
}
]
},
"analytics": [
{
"value": "2016-12-21T11:43:10+05:30"
},
{
"value": "2016-12-21T11:43:10+05:30"
}
],
"customer": {
"mobile": "7466598086",
"tags": [
{
"name": "EMAIL",
},
{
"name": "AADHAAR",
"value": "499118665246"
},
{
"name": "PAN",
}
]
},
"agent": {
"id": "OU01AU02INB529957923",
"device": [
{
"value": "MOBB"
},
{
"name": "IMEI",

"value": "448674528976410"
},
{
"name": "OS",
"value": "android"
},
{
"name": "IP",
"value": "124.170.23.28"
},
{
"name": "APP",
"value": "NPCIAPP"
}
]
},
"billDetails": {
"customerParams": [
{
"name": "a",
"value": "101"
},
{
"name": "a b",
"value": "102"
},
{
"name": "a b c",
"value": "103"
},
{
"name": "a b c d",
"value": "104"
},
{
"value": "105"

}
]
},
"amount": {
"amount": "100000",
"custConvFee": "0",
"currency": "356",
"tags": null
},
"paymentMethod": {
"quickPay": "No",
"splitPay": "No",
"offusPay": "Yes"
},
{
"value": "4336620020624963|123456"
}
],
}
Encrypted Request:
{
"requestMsg":


EDE4AD3D20",
}
Sample Bill Payment Request – Bank Branch
Clear Text Request:
{
"head": {
"ver": "1.0",
"ts": "2019-04-09T14:02:01+05:30",
"origInst": "OU01",
"refId": "OU01RUCHIBILLFETCHRE440190409130509"
},
"txn": {
"msgId": "OU01RUCHIBILLPAYMTMSGll690409140209",
"txnReferenceId": "OU01081nm209",
"ts": "2019-04-09T14:02:01+05:30",
"riskScores": [
{
"provider": "OU01",
"type": "TXNRISK",
"value": "030"
},
{
"provider": "BBPS",

"type": "TXNRISK",
"value": "030"
}
]
},
"analytics": [
{
"value": "2016-12-21T11:43:10+05:30"
},
{
"value": "2016-12-21T11:43:10+05:30"
}
],
"customer": {
"mobile": "9898990089",
"tags": [
{
"name": "EMAIL",
"value": "mk.chekuri@gmail.com"
},
{
"name": "AADHAAR",
"value": "499118665246"
},
{
"name": "PAN",
"value": "BCJPC8549Q"
}
]
},
"agent": {
"device": [
{
"value": "BNKBRNCH"
},
{
"name": "MOBILE",

"value": "9845784654"
},
{
"name": "GEOCODE",
"value": "28.6139,78.5555"
},
{
"name": "POSTAL_CODE",
"value": "600001"
},
{
"name": "IFSC",
"value": "ABCD0001243"
}
],
"id": "OU01OU02BNK525314030"
},
"billDetails": {
"customerParams": [
{
"name": "a",
"value": "10"
},
{
"name": "a b",
"value": "20"
},
{
"name": "a b c",
"value": "30"
},
{
"name": "a b c d",
"value": "40"
},
{
"value": "50"
}

]
},
"amount": {
"amount": "100000",
"custConvFee": "0",
"currency": "356",
"tags": null
},
"paymentMethod": {
"quickPay": "No",
"splitPay": "No",
"offusPay": "Yes"
},
{
"value": "4336620020624963|123456"
}
],
Encrypted Request:
{
"requestMsg":


EDE4AD3D20",
}
Bill Payment Response Parameters
Sr. Mandatory
No. / Optional
Example:
MAHA00000MUM0108062018165735MCZ1XDK
Example: OU01
000 for Success


As defined by NPCI BBPOU will pass the refId in Min 8
7 ApprovalRefNum Character Mandatory
ApprovalRefNum field if it is not passed by the Max 100
biller.
8 complianceRespCd code (Error Code). Refer Attached Error Codes Character 6 Optional
list for details in Annexure I
Reason (Error Reason) which indicates the Min 7
9 complianceReason Character Optional
Unique identification generated by Agent to

response.
Example:

generated by Agent. UTR will be Unique
11 txnReferenceId throughout the BBPS Ecosystem. Same will get Character 12 Mandatory
Example: KM01TESTA001
12 billerId Biller by NPCI Character 14 Mandatory

CustomerParams
Pair)
Biller.
Customer Name which was received in Bill

Min 2
14 customerName Fetch Response from biller (Only English text is Character Optional
Max 100
allowed)
Amount against the specific connection ID. The
Amount passed in response should be in paise
15 amount format (without decimal or commas). Numeric 20 Mandatory
Example: Amount is Rs. 36.50 then the biller
should pass 3650 as the amount in response.

Due date against the specific connection ID

16 dueDate It should be in yyyy-mm-dd format. Date 10 Mandatory
Example: 1999-12-31
The date from which customer can pay the bills.

Bill date against the specific connection ID.
17 billDate Date 10 Mandatory
It should be in yyyy-mm-dd format.
Example: 1999-12-31
Unique identification Number of the bill in the

18 billNumber Character 20 Mandatory
biller system
Billing period of the bill.
19 billPeriod Example: January, Jan2019, Quarter1, First Character 20 Mandatory
Cycle, Year2019.
Sample Bill Payment Success Response

{
"head": {
"refId": "OU01TESTABILLPAYMTREF20190409140201",
"origInst": "BBCU",
"ts": "2019-04-09T14:15:48+05:30",
"ver": "1.0"
},
"reason": {
"approvalRefNum": "12345037"
},
"txn": {
"ts": "2019-04-09T14:15:43+05:30"
},
"billDetails": {
"billerId": "OTOE00007XXA63"
"customerParams": [
{
"name": "a",
"value": "10"

},
{
"name": "a b",
"value": "20"
},
{
"name": "a b c",
"value": "30"
},
{
"name": "a b c d",
"value": "40"
},
{
"value": "50"
}
]
},
"billerResponse": {
"customerName": "Ashish",
"amount": "100000",
"dueDate": "2016-07-30",
"billDate": "2016-07-01",
"billPeriod": "Jul",
"tags": [{
"name": "Late Payment Fee",
"value": "40"
}]
}
}
Encrypted Response:
{
"responseMsg":
"2946B46F68BB8AB34F3C17ECF76D5E62793A96B427B63154EA86B98395D587C531A44010271647EA208DBCDAF6C3
BF16A330A9D08C7D86B10EAFDCA830B5E8143E787E113A314B94F50A3272BCCDA4CD74579F80C68C8CABFD3A7E8D
66556D18DFB3E20772AD9C5AE14D1246D8B8DB0F58E33C9E5AF146F395FDC21EF7F0F4CD4E0F05C64584C879FDCAE
E8BF8B7627A469378E5C4FDC01DB712D6A38F0B2D91A04EE4983D24E4306621FE65C4D33BB1FF82CDC7D2679405C5
03AA8B783AB5FB7A6C0A156BB8B9DE23541E42F1B997121FCC88618E1FDDBE5B7F7495D4C45181F15D4F012C9A4D

7D085A0EEF11F73C4933DBBB38AD727F61DB64D0FCB60B493ABB4EC4B4797BA47FF76D6557E6F9BF6DE24A29B85A
A542BD969276B369BC641B4E410F29B450C9232647910406AFF385001E4922119BC96FE906726DF2BA6A2FD67AE46
580D21811C601263FCA6C14FAC0EFC87778496AAFCF53947D4FF43E24DDA670249725746D3231E14D4D38728D6F2D
85691527FE575A44E73E35A1BD450D7D2028BDB20F2D9BD90682D5E496455FAF14BC05ED48310CA696A3B918B76E
8A061235F169B718CC6899CC549DBDD0EBC1710A80C34A27E1238EB222205EB2FE0D1B325B2B3DCB4BAB258A3821
344BA6D5935E67439B03131BFAC7227B2FB2A02EA8CEC086FCB24B8DD6AEC360498B0D6C26BA6D9D1BC5C259E02D
25EB882C3E77B99C29D26EBE2FB424F7B63DCAD8E35E399A522C4C71898A88D7DDF230F9881F1AC752978E9DFA7C
42A971E3C0E289777BEA6B16FC10EB216CECA6C5354544728C75E0260AC5D852BAC43EC32519221FF43245F8491403
AFEC6474DE5EDB1332FFCF1BDFBD2D72335ABB4A89AC54BABCE2A9B116638E53E907245718A845A0797885B8A25D
8B618331FC7C87DA88B42790F9CEF97A8EBC206ABD83E05C7C337434EF73134C4DE0D25CC8FF3954162ECA82B12DC
F916BE90C51E8C359D05EF28134D087D78C517840A65731B7BD4E591CE0FA87F3168A38AFB1AABBCB4CF1E06CD6E4
6AB7FEF9981C6DDB350AFD044416FE63FCAC1AD4B8531075CEF05E2FF237FED7051F54899BCB8153EB27BB048B42A
DAEE811BBB49306AAC57A9A1D1A98F40770703B7A88BF8856D70491E84BFB42739A8E6B3A6B67A448037A14FE6A1
B7CDC29040483D454E8E43FD4D00A6E6F2D85691527FE575A44E73E35A1BD45B3980AC2527CD0A298A7823DAE8CA
1EF0C564C36A78BBFB783FE471A1621544B56C19797DDD41751376E5998364083BC60E34269656A17889517BF7F843
6817896612FC645FBAA90BA4D70CF20DC7576",
}
Sample Bill Payment Failure Response

{
"head": {
"refId": "OU01TESTABILLPAYMTREF20190409140202",
"origInst": "OU01",
"ts": "2019-04-09T14:17:57",
"ver": "1.0"
},
"reason": {
"responseCode": "VALIDATION_ERR",
"responseReason": "NPCI Rejected The Request.",
"complianceRespCd": "DEV006",
"complianceReason": "Init Channel for Payment Mode Cash must be within [MPOS, BNKBRNCH, BSC, POS, KIOSK,
AGT] value"
},
"txn": {
"ts": "2019-04-09T14:02:01+05:30"
}
}

Encrypted Response:
{
"responseMsg":
"2946B46F68BB8AB34F3C17ECF76D5E62B5B33D6721DB0DF3B0F7F4A6016B6CD261C43A8198ABDD975888DF3FB39
54F24F053E90F1D11D06A2F5909ED10408E0B8EC4895BDD6D7C4A3E83769DD7CEE9057238C65EE1DCD03487C6673
CEE891ADA42C2A393B59B4FBC8B1E731BAE82FE3A23261E09724EF7BD7950F4F210D4890473ED6BF1B290AAC63C6
6E2EBBF621314B2955C973AEDE75CA2C0E1A1485D0F8921396ABE5F0E89151EAFE9879235B55F331CF585F7074A8E
3AF16758A8110314D2064C40FC681C62CCBA6ECA25C2A3EB50AD2A9FA4EA8A652DD3D08F7AB4AF17BF1ECACE27D
4DAF699DC6F0D0882F6B23245991E83120E1ABBBF717938F4EBEAF88025A1587BB16EE668B106A8CF61339F006043
51CD45EB4284AE9C87D64AE77E1672502A73C9AB7E9CA7859C2DEC794839DFBDDC70FC6481B3168DD93BBA46737
12B1305246AEA1C9EFBA1841369CED7E532C76342C9D39C40F6298D135765AE65FBC1B37BA06334E3B73B604B094
A211B13297AC7D89E82E4D3505E64B6479296B77024B99745C6C29142E91A4AD37CED1F44A0EB706F20F6151434A
935FE674689A464FB50126AB89E637BA1BAA21D37147DA8D02F3CE789BF03C448E2E2",
}

TRANSACTION STATUS
USING REFERENCE ID
Transaction Status using Reference ID API helps customer side BBPOU to check the transaction status using reference ID.
Request Parameter for Transaction Status using Reference ID API:
Sr. Mandatory
No. / Optional

Example:
MAHA00000MUM0108062018165735MCZ1XDK

Example: OU01

5 msgId Character 35 Mandatory
Example:
Identification of the type of the request –

transaction status (401), complaint registration
6 xchangeId Character 3 Mandatory
(501), complaint re-assignment (502), complaint
status (506) or complaint closure (507)
7 txnReferenceId throughout the BBPS Ecosystem. Same will get Character 12 Mandatory
OTP for the registration of complaint to identify
8 otp Character 10 Optional
the valid mobile no.

Sample Transaction Status using Reference ID Request:
Clear Text Request:

{
"head": {
"refId": "OU01TESTATXNSTATUSREF20190409171801",
"origInst": "OU01",
"ts": "2019-04-09T14:28:01+05:30",
"ver": "1.0"
},
"txn": {
"msgId": "OU01TESTATXNSTATUSMSG20190409171801",
"ts": "2019-04-09T14:28:01+05:30",
"xchangeId": "401"
},
"transactionDetails": {
"txnReferenceId": "OU0109140201"
},
"otp": null
}
Encrypted Request:
{
"requestMsg":
"14A693F86D1604157F6FC23E35D6388B3C07883C3DF9C4EF7B00C1ED515A3B8A23A9E4B4EA9ED7862DA23DA6541
2EE2D269203DFB59691808F32CCD7B90EF70C39347F73DCCB3A241D683A7F1B221DCC451D6FB94319515FD82D081
F69C855CE7C755927992F32D496457BA5C7DB0571AD870A6B65F39D700CE88E936A61BB211449C92CE2EF90BC98F
4B73DFC4623FAEF26D4BF8B311974FED86526BB6E5087CE37472CD94C3885905F974A2F3A00FF8ED1E604178319B3
7E5A7BAE5B88A4BC905F93AC2C5944A104846CBA39311A0FC93A2760E2FBE8B6D77D99E9C1B2208667DD028027C
26D9C2C1BA3185739E12E79455BD81C2F100B3AFD7DDB8401A595C551CD69F6B2892B86923CBED0BE43FA55AFCC
F33D894847DA284FC74D7F8687198C2FFD8EB788A19D85C68BF76AC14183F64B2AE40447E6399457E45CEA7E80C4
BC32840EE11CB3E6D5E4A3282A6DE8E0B800EE32DBB636B848A57FA13A9109281CA44F6F7ECFAC58ADCD17CA3A2
4D341BA4162BF580975CC148D31D29DE1DD",
}

Response Parameters for Transaction Status using Reference ID
Sr. Mandatory
No. / Optional

Example:
MAHA00000MUM0108062018165735MCZ1XDK

Example: OU01
000 for Success
Biller should pass the description of the min 8
response code, as "Successful" or "Failure" max 10

Example:

List of transactions against a particular search
9 TxnList Character Mandatory
criteria
Details of the customer for a successful
10 CustomerDetails Character Mandatory
transaction search (401) response

Sample Transaction Status using Reference ID Response:

{
"head": {
"origInst": "BBCU",
"ts": "2019-04-09T17:20:10+05:30",
"ver": "1.0"
},
"reason": {
"responseReason": "SUCCESS"
},
"txn": {
"ts": "2019-04-09T17:20:10+05:30",
"xchangeId": "401"
},
"txnList": [
{
"amount": "100000",
"txnDate": "2019-04-09T14:15:43+05:30",
"txnStatus": "SUCCESS"
}
],
"customerDetails": {
"mobile": "9898990087"
}
}
Encrypted Response:
{
"responseMsg":
"2946B46F68BB8AB34F3C17ECF76D5E6226002736BDF8D12B706B506B85CBA7E4E4081B98F3B894AF73933F65F89B
4E3E23D0A6B6A3D342583E60AD6B0A49FC133E787E113A314B94F50A3272BCCDA4CD61F3F67F58D54B308147FBF5
B9F7291DE70AE49C6035401294C29DA0ED05106958E33C9E5AF146F395FDC21EF7F0F4CD4E0F05C64584C879FDCAE
E8BF8B7627A469378E5C4FDC01DB712D6A38F0B2D91AA1CCAEB423E8B5A34CE159208884F67B02E293A85BA2C077
0A1599D3F02A0ED26002736BDF8D12B706B506B85CBA7E4AA9FA079B2DDAFED15949E24AC911E5F2A5BB43D5739

AB3F4D8A1F07C962C26E01CF0334368245E38BE948F234917E1CB94D4D62F09B4EBEB818D7B6B5D3F5789F495606A
10A02153D8261C4B7B767DC57BCA8A4A87CDA28B2199687C2F8AE938DACA096682DC21D8A24F80D045791D719B
691A4FB357951BF17569AD560A032AF625C919CB38161E79D43B495935AA0C34F0F324BD142FBBA96C8A003CBC13
B5EBFB321B5E3D1D80D44CBE2E8031A0A59F08663B23F92F91B94D2768B12EEB58BA5F1DCAA106B87F35E8D4A69A
457A3CEAFE1695191C66397271F778100E09FCA9CBD07F0A0BEDB3ECBA9F443CDBCA0AB184619CA106BADD05576
80536E038A169D6062F4746F056549B64E7B2EA0AD2ADAEE7AE7B32EDA01862EE0B927AE9CA9FBF2FC7676B95423
23F461CEA47B5B",
}
Sample Failure Transaction Status Response:

{
"head": {
"origInst": "OU01",
"ts": "2019-04-10T11:26:05",
"ver": "1.0"
},
"reason": {
"responseReason": "No Transaction found"
},
"txn": {
"ts": "2019-04-09T14:28:01+05:30",
"xchangeId": "401"
}
}
Encrypted Response:
{
"responseMsg":
"2946B46F68BB8AB34F3C17ECF76D5E6226002736BDF8D12B706B506B85CBA7E41F7043BDB8C52CB67B79075230EC
1748BE53B0DBA45D5872C88B404FBCA2E0908EC4895BDD6D7C4A3E83769DD7CEE905D195E26719FCC0C1C146D1C
CE6E3D62889FE626E750BEB76EF176229E781314F23261E09724EF7BD7950F4F210D48904D053134664D6C7F1AEEDF
177F89E004A6B7C58471C710FC67C822C2DF7525F6475949C0E830D614214B9F17DD31500B80A7D20994F5706DAB7
798027BA75D2C4C4BB4DA44AFE0BAB1FE224B6D20E0479D9A4E7433B8C43ACF946ACE1D5A56BFD4460B24A8CABB
D79767B06F4E121780ABE17DD893D634B497C8B622DFA5414216AFBB09C5BD7F3465154E7A604528046CF5D50E32
324985D0D85D087F067E1A1DA54BF8872FC022EDAC52DF55E91B4E1",

USING MOBILE NUMBER
Transaction Status using Reference ID API helps customer side BBPOU to check the transaction status using mobile
number.
Request Parameter for Transaction Status using Mobile Number API:
Sr. Mandatory /
No. Optional

Example:
MAHA00000MUM0108062018165735MCZ1XDK

Example: OU01

Example:

7 Mobile Mobile number against which the transaction Character 10 Mandatory

status is to be searched
From date for the transaction whose status
want to check. It should be in yyyy-mm-dd
8 fromDate Date 10 Mandatory
format.
Example: 1999-12-31

To date for the transaction whose status want

9 toDate to check. It should be in yyyy-mm-dd format. Date 10 Mandatory
Example: 1999-12-31

Sample Transaction Status using Mobile Number Request:
Clear Text Request:

{
"head": {
"origInst": "OU01",
"ts": "2019-04-09T14:28:01+05:30",
"ver": "1.0"
},
"txn": {
"ts": "2019-04-09T14:28:01+05:30",
"xchangeId": "401"
},
"transactionDetails": {
"mobile": "9898990087",
"fromDate" : "2019-04-08",
"toDate" : "2019-04-09"
},
"otp": null
}
Encrypted Request:
{
"requestMsg":
"14A693F86D1604157F6FC23E35D6388B890B4F2A2A4140FF6DC01F0F862BF9097310FFD30638DEF5A0FB33D0B443
FF05926B7FF3D6BCABCE82B22E16EEB174807277A9006356AA158A49B42935C2EBCAE369850FB59820C95FB11373C
A4A9B80ED0F61A4D357F86922826777E9C99FBF8AFF609816E5269F45F6A55A435A211C8F4EDE630061EE9A65F448
73B47B3EFE02971ACE49586CAE5FC155D138E0B1E2FC8A60A4015F61C2AFD9A8DD51B16ED8A17748B475889DB4F7
4E008D3918B36B5A5425707CE91E5782ACBF6010504825AA9FA079B2DDAFED15949E24AC911E5F51C18D9A75D5C
B68908BC62AFC4A9478C23CC8C3B31D36D9A80398C46DD9D392944EA5B8C1DAE8961BC3F5B38D92B2932F031FBE
EDAE70F06B39E41329C6749BC50BF30134CF986FC79DC30E9B8177FE9CD5AC10A50D13365DCD07B1D376E2628623
8064FC433D4AA688CBF34B63FF516A96783140AA7CF37EBADE76A8BA23C508498267EB5430CE7C44959B4CB7A478
3E835C66D6BD67DF49CC10D82349DF1C5107730D0ABE3BB230A8D603661C13FEAFA31E05B9903C62F7861463BD9

A0954E92257D171CDF4A2F0E1E6A37F7DBD78FB33C724C71632324EB5E5BFFF0034B2E465F75E6279206E755C4165
3EE4D16E",
}
Response Parameters for Transaction Status using Mobile Number
Sr. Mandatory
No. / Optional

Example:
MAHA00000MUM0108062018165735MCZ1XDK

Example: OU01

Example:

000 for Success
Biller should pass the description of the min 8
response code, as "Successful" or "Failure" max 10

List of transactions against a particular search

9 TxnList criteria such as mobile or transaction reference Character Mandatory
ID
Details of the customer for a successful
10 CustomerDetails Character Mandatory
transaction search (401) response
Sample Transaction Status using Mobile Number Response:

{
"head": {
"origInst": "BBCU",
"ts": "2019-04-09T17:24:34+05:30",
"ver": "1.0"
},
"reason": {
},
"txn": {
"ts": "2019-04-09T17:24:34+05:30",
"xchangeId": "401"
},
"txnList": [
{
"amount": "100000",
"txnDate": "2019-04-09T14:15:43+05:30",
"txnStatus": "SUCCESS"
}
],
"customerDetails": {
"mobile": "9898990087"
}
}

Encrypted Response:
{
"responseMsg":
"2946B46F68BB8AB34F3C17ECF76D5E6226002736BDF8D12B706B506B85CBA7E4E4081B98F3B894AF73933F65F89B
4E3E1CDFC41841A333195E22C539761BBF6E3E787E113A314B94F50A3272BCCDA4CDB012312DF7F311F6A589398B0
1CF730E222EAB84C188139D5F37AA7181DA29F058E33C9E5AF146F395FDC21EF7F0F4CD4E0F05C64584C879FDCAEE
8BF8B7627A469378E5C4FDC01DB712D6A38F0B2D91AA1CCAEB423E8B5A34CE159208884F67B02E293A85BA2C0770
A1599D3F02A0ED26002736BDF8D12B706B506B85CBA7E4AA9FA079B2DDAFED15949E24AC911E5F87C4D2F86B228F
9F5B2909E77B534D859270EB250DDBC9E8654DCD375EC0DFD7B94D4D62F09B4EBEB818D7B6B5D3F5789F495606A1
0A02153D8261C4B7B767DC57BCA8A4A87CDA28B2199687C2F8AE938DACA096682DC21D8A24F80D045791D719B69
1A4FB357951BF17569AD560A032AF625C919CB38161E79D43B495935AA0C34F0F324BD142FBBA96C8A003CBC13B5
EBFB321B5E3D1D80D44CBE2E8031A0A59F08663B23F92F91B94D2768B12EEB58BA5F1DCAA106B87F35E8D4A69A45
7A3CEAFE1695191C66397271F778100E09FCA9CBD07F0A0BEDB3ECBA9F443CDBCA0AB184619CA106BADD05576805
36E038A169D6062F4746F056549B64E7B2EA0AD2ADAEE7AE7B32EDA01862EE0B927AE9CA9FBF2FC7676B9542323F4
61CEA47B5B",
}
Sample Failure Transaction Status Response:

{
"head": {
"origInst": "OU01",
"ts": "2019-04-10T11:27:41",
"ver": "1.0"
},
"reason": {
"responseReason": "No Transaction found"
},
"txn": {
"ts": "2019-04-09T14:28:01+05:30",
"xchangeId": "401"
}
}

Encrypted Response:
{
"responseMsg":
"2946B46F68BB8AB34F3C17ECF76D5E6226002736BDF8D12B706B506B85CBA7E41F7043BDB8C52CB67B79075230EC
17484A8B4A3E94B6D817FE0DCADA15D4784C8EC4895BDD6D7C4A3E83769DD7CEE9056D277FEA6B329A85E6665B1
DEF2E82F72F58F89372230FCABF7B1363D4E769A523261E09724EF7BD7950F4F210D48904D053134664D6C7F1AEED
F177F89E004A6B7C58471C710FC67C822C2DF7525F6475949C0E830D614214B9F17DD31500B80A7D20994F5706DAB
7798027BA75D2C4C4BB4DA44AFE0BAB1FE224B6D20E0479D9A4E7433B8C43ACF946ACE1D5A56BFDF9DA1F1F1B44
C643D5FF75CDDB7699FFBE17DD893D634B497C8B622DFA5414216AFBB09C5BD7F3465154E7A604528046CF5D50E3
2324985D0D85D087F067E1A1DA54BF8872FC022EDAC52DF55E91B4E1",
}

RAISE COMPLAINT API
Raise Complaint Request API helps customer side BBPOU to raise complaint against the transaction or services.
Request Parameter for Raise Complaint API:
Sr. Mandatory /
No. Optional

1 refId Character 35 Mandatory
It should be Unique for end-to-end
process.MAHA00000MUM0108062018165735MCZ1XDK

Example: OU01
Timestamp of the request and response which will be
updated at each leg of the transaction.
4 ver Version of the API i.e. 1.0 Character Mandatory
Unique identification generated by AI/Agent to relate a

5 msgId request and response message. Character 35 Mandatory
Example: PYZAP08062018165735JXGVSZ4ACFB8MAZS
Identification of the type of the request – transaction

status (401), complaint registration (501), complaint re-
assignment (502), complaint status (506) or complaint
closure (507)
complaintT Type of complaint request – Transaction or Service
7 Character 20 Mandatory
ype based
Last updated additional information provided by the

8 description BBPOU pertaining to the complaint and fetched in the Character 150 Mandatory
complaint status check (506) response
Pre-defined list of dispositions for transaction based

9 disposition Character 55 Mandatory
complaints

Unique Transaction reference (UTR) number generated

by AI/Agent. UTR will be Unique throughout the BBPS
txnReferen
10 Ecosystem. Same will get displayed on receipt for bill Character 12 Mandatory
ceId
pay transaction.
OTP for the registration of complaint to identify the
valid mobile no.
Sample Raise Complaint Against Transaction Request:
Clear Text Request:

{
"head": {
"refId": "OU01TESTARAISECOMPREF20190410113003",
"origInst": "OU01",
"ts": "2019-04-09T14:28:01+05:30",
"ver": "1.0"
},
"txn": {
"msgId": "OU01TESTARAISECOMPMSG20190410113003",
"ts": "2019-04-09T14:28:01+05:30",
"xchangeId": "501"
},
"complaintDetails": {
"complaintType": "Transaction",
"description": "Complaint initiated through API",
"txnReferenceId": "OU018840sj01",
"disposition": "Double payment updated"
},
"otp": null
}
Encrypted Request:
{
"requestMsg":
"14A693F86D1604157F6FC23E35D6388B890B4F2A2A4140FF6DC01F0F862BF90935CB8552A1671F44563FEF159042C
236FE091FEE255008FE2D36D9CF2EBA96BECEF19E944241D22EEF0E4128DA6320F3E369850FB59820C95FB11373CA4
A9B80ED0F61A4D357F86922826777E9C99FBF8AFF609816E5269F45F6A55A435A211C8F4EDE630061EE9A65F44873B
47B3EFE02971ACE49586CAE5FC155D138E0B1E2FC8A60A4015F61C2AFD9A8DD51B16ED8A17748B475889DB4F74E00
8D3918B36B833532FEE7117A6E8037B595D9B2A2A5FA2C64BDE796F99941410E6F1CE72C070476523EC5B83FF2D9A
FD77D29D61F02C23CC8C3B31D36D9A80398C46DD9D392944EA5B8C1DAE8961BC3F5B38D92B2932F031FBEEDAE70F
06B39E41329C6749B838C8C58BFBCE1E080BC5679050001C959ABF11F4CFBDFDB25BBD31444507454C13147446057

0EE867DCBAA6A7E7CC3F86D868A5A4AE5F27086C3AD1A7541E0E58F10B22F960CEE60F5BFF3BAD0C20A987826CB8B
0F8ED6968D7762D37EC692FA0A51CB4D60E202927688BABDA763DF283DC5836262688F12E4C98D1CD869988EC927
742040D093EDFF12A91564FB515DAB148F467B02D8FB2566F297C384B2F4E1BA561795EA45EC5A0FB98F889137C25
91C9B933CA3DE275161A17A78B5204A11EF69C8683A438D47E4EC5EAAE0470E714F338AD2D4E6EDBD44529714A6A
83FF32E746975B1639B3352107583E23D0550B681BF11C406E34F32C07A564760C",
}
Request Parameter for Raise Complaint against Agent API:
Sr. Mandatory
No. / Optional
Example:
MAHA00000MUM0108062018165735MCZ1XDK
Example: OU01
Example:
Type of complaint request – Transaction or
7 complaintType Character 20 Mandatory
Service based
Type of participation of the agency against
8 participationType Character 20 Mandatory
which complaint is lodged – Agent or Biller
Unique identifier (Agent Id assigned by NPCI)
9 agentId allocated to the Agent for service based Character 14 Mandatory
complaints
Pre-defined list of dispositions for service based
10 servReason Character 100 Mandatory
complaints

Last updated additional information provided

by the BBPOU pertaining to the complaint and
11 description Character 55 Mandatory
fetched in the complaint status check (506)
response
Mobile number against which the transaction
12 mobile Character 10 Optional
13 txnReferenceId throughout the BBPS Ecosystem. Same will get Character 12 Optional
Sample Raise Complaint Against Agent Request:
Clear Text Request:

{
"head": {
"origInst": "OU01",
"ts": "2019-04-09T14:28:01+05:30",
"ver": "1.0"
},
"txn": {
"ts": "2019-04-09T14:28:01+05:30",
"xchangeId": "501"
},
"complaintType": "Service",
"participationType": "AGENT",
"agentId": "OU01OU21BNK519290438",
"servReason": "Agent overcharging",
"description": "Complaint initiated through API"
},
"otp": null
}

Encrypted Request:
{
"requestMsg":
236FE091FEE255008FE2D36D9CF2EBA96BECB93EEF08AEFFC854662DA7656B11313E369850FB59820C95FB11373CA4
A9B80ED0F61A4D357F86922826777E9C99FBF8AFF609816E5269F45F6A55A435A211C8F4EDE630061EE9A65F44873B
47B3EFE02971ACE49586CAE5FC155D138E0B1E2FC8A60A4015F61C2AFD9A8DD51B16ED8A17748B475889DB4F74E00
8D3918B36B833532FEE7117A6E8037B595D9B2A2A5FA2C64BDE796F99941410E6F1CE72C07C687C93431551E64D8A
FFA1A556A70B7C23CC8C3B31D36D9A80398C46DD9D392944EA5B8C1DAE8961BC3F5B38D92B2932F031FBEEDAE70F
06B39E41329C6749B838C8C58BFBCE1E080BC5679050001C959ABF11F4CFBDFDB25BBD31444507454C13147446057
0EE867DCBAA6A7E7CC3F86D868A5A4AE5F27086C3AD1A7541E0EDC0D09E2C8CCC70C8CD0CECDA85280CB4DD928E
292E6E76DEF0BF2E1DC26AE58C2B61AFD72EC7E12FD4A4846D0F5941A59A9512F398085279D0D5549DB0FB8194F87
842B661CC0199D8DA3AF762A91E68829D785998094ED1CD3791D43A8ED90924D2AA212BC48A88DCB69999D5744F
E354C22D7DFFA587D1B7647366BC63F625E023921299969888ED52EA2C1B61999A117F5A7291129F8AC4AC04DAD02
5FFC0FA53557688D6055CD06F324B3C9C63695758D004F1B46917BCA998F3E05E10D5F1ACB966BF17CF86EB03F60B0
317A8D0A72E0B8EF0C8E01D4D10E25B6040EA6",
}
Request Parameter for Raise Complaint against Biller API:
Sr. Mandatory
No. / Optional

Example:
MAHA00000MUM0108062018165735MCZ1XDK

Example: OU01



Example:


Service based
Type of participation of the agency against
8 participationType Character 20 Mandatory
which complaint is lodged – Agent or Biller
Unique identifier (Biller ID assigned to NPCI)
9 billerId allocated to the Biller for service based Character 20 Mandatory
complaints
Pre-defined list of dispositions for service based
10 servReason Character 100 Mandatory
complaints
11 description Character 55 Mandatory
response
Mobile number against which the transaction
12 mobile Character 10 Optional

13 txnReferenceId throughout the BBPS Ecosystem. Same will get Character 12 Optional

Sample Raise Complaint against Biller Request:
Clear Text Request:

{
"head": {

"origInst": "OU01",
"ts": "2019-04-09T14:28:01+05:30",
"ver": "1.0"
},
"txn": {
"ts": "2019-04-09T14:28:01+05:30",
"xchangeId": "501"
},
"complaintType": "Service",
"participationType": "BILLER",
"servReason": "Biller available. Unable to transact",
"description": "Complaint initiated through API"
},
"otp": null
}
Encrypted Request:
{
"requestMsg":
236FE091FEE255008FE2D36D9CF2EBA96BE56D8E242D6F42AA5EA7EE2037B98D910E369850FB59820C95FB11373CA
4A9B80ED0F61A4D357F86922826777E9C99FBF8AFF609816E5269F45F6A55A435A211C8F4EDE630061EE9A65F4487
3B47B3EFE02971ACE49586CAE5FC155D138E0B1E2FC8A60A4015F61C2AFD9A8DD51B16ED8A17748B475889DB4F74
E008D3918B36B833532FEE7117A6E8037B595D9B2A2A5FA2C64BDE796F99941410E6F1CE72C07BA46BEF03A946DB
20A91E1B29150F869C23CC8C3B31D36D9A80398C46DD9D392944EA5B8C1DAE8961BC3F5B38D92B2932F031FBEED
AE70F06B39E41329C6749B838C8C58BFBCE1E080BC5679050001C959ABF11F4CFBDFDB25BBD31444507454C13147
4460570EE867DCBAA6A7E7CC3F86D868A5A4AE5F27086C3AD1A7541E0EDC0D09E2C8CCC70C8CD0CECDA85280CB4
DD928E292E6E76DEF0BF2E1DC26AE5859BB1D0382ACAF0A3A43BF9B573CB1B122B0D113D49FE10A4455C76B6EBF
471AFE59204FBA0DA5A87B980FCEE6254E490C63D8C234EE6D9ECEB256079FED0BE9CD40D415FA61F8C696319C71
E381216AA15D25D376BD1A31DDE6B1D2FEC8A0EDDE0390DCDB5082C3CBC14DF7E20DDAE98080D56C9E176AD537
714B13008A034434E20269377FC527EB4B561C5E2148DC7DA49CAA106C9E534B23B54C827A346B8F185887134696
8C8F269A527832D8A483CAE4050AEE76F792C465FA77A8F04CBCE54CFA71B3F4623CD8089500F61040",
}

Raise Complaint Response Parameters
Sr. Mandatory
No. / Optional
Example:
MAHA00000MUM0108062018165735MCZ1XDK
Example: OU01
000 for Success
6 responseReason Character 10 Mandatory
7 msgId Number 35 Mandatory
Example:
9 assigned BBPOU to which the complaint is assigned Character 14 Mandatory
Complaints Approval Reference Number
10 complaintId Character 10 Mandatory
generated by NPCI against the complaint
Current status of the complaint in BBPS
11 complaintStatus Character 10 Optional
ecosystem
Flag indicating if the transaction based
complaint being raised is currently open in the
12 openComplaint Character 1 Optional
system or not – "Y" will show the details for the
complaint raised earlier

Sample Raise Complaint Response:

{
"head": {
"origInst": "BBCU",
"ts": "2019-04-10T11:32:20+05:30",
"ver": "1.0"
},
"reason": {
},
"txn": {
"ts": "2019-04-10T11:32:20+05:30",
"xchangeId": "501"
},
"assigned": "XYZ Bank",
"complaintId": "KP1554876140634"
}
}
Encrypted Response:
{
"responseMsg":
"2946B46F68BB8AB34F3C17ECF76D5E62D8E7886F98E946E3E79458F6BD356A527F1533DE6776C5C79EE4AE937C1718
440CD70A3280167C7059F692676C8881033E787E113A314B94F50A3272BCCDA4CDD22B0D3B836EED990448DEA02D4
BFD8A68529FA297C74620DEC2267D4632B1E658E33C9E5AF146F395FDC21EF7F0F4CD4E0F05C64584C879FDCAEE8BF8
B7627A469378E5C4FDC01DB712D6A38F0B2D91AA1CCAEB423E8B5A34CE159208884F67B02E293A85BA2C0770A1599
D3F02A0EDD8E7886F98E946E3E79458F6BD356A52FA2C64BDE796F99941410E6F1CE72C0732B0273A1FB51C45974DF5
0B281A801A7649376E53FC6A29E966C4622CC45E16B94D4D62F09B4EBEB818D7B6B5D3F5789CDB8416108F7AE63A85
1C5B82D12DE22DC90AFC2710E3001F4AB40F415641FC51AE8FD0B6E3228951F4096B626780AFFB3EE47B414CDB60A4
7D24B4D76D51283E49F1B8DCE68B3E6D9419A8AD5DC60C7CBAC290D5D063E7048E8CF9EDD560EC",
}

CHECK COMPLAINT STATUS
Complaint Status API helps customer side BBPOU to check the complaint status.
Request Parameter for Complaint Status API:
Mandatory
/ Optional
Example:
MAHA00000MUM0108062018165735MCZ1XDK
Example: OU01
Example:

6 xchangeId Character 3
Complaint ID generated by BBPCU to check the
7 complaintId complaint status, reassign or close a complaint Character 20 Mandatory
subsequently
Service based

Sample Transaction Complaint Status Request:
Clear Text Request:

{
"head": {
"refId": "OU01TESTACOMSTATUSREF20190409171801",
"origInst": "OU01",
"ts": "2019-04-09T18:07:00+05:30",
"ver": "1.0"
},
"txn": {
"msgId": "OU01TESTACOMSTATUSMSG20190409171801",
"ts": "2019-04-09T18:07:00+05:30",
"xchangeId": "506"
},
"complaintId": "AP1554115701120",
"complaintType": "Transaction"
}
}
Encrypted Request:
{
"requestMsg":
"14A693F86D1604157F6FC23E35D6388B890B4F2A2A4140FF6DC01F0F862BF909402FB819A03AF181F3DF2409FE0C
A1DF926B7FF3D6BCABCE82B22E16EEB1748072A64D77A5FAF9557F85477521298CDAE369850FB59820C95FB11373
CA4A9B80ED0F61A4D357F86922826777E9C99FBF9D25B3D5FF5F399511EB48A1E9A428B7F47E2D46C0B59F906246
AE1D0AD68B1402971ACE49586CAE5FC155D138E0B1E2FC8A60A4015F61C2AFD9A8DD51B16ED8A17748B475889DB
4F74E008D3918B36BA26939EF3EBB5FD23D4F44A5E26CE673AA9FA079B2DDAFED15949E24AC911E5FB3CF226C8BF
22B024D13079A27555761C23CC8C3B31D36D9A80398C46DD9D392A9E81710953160ED7C15159F7960B9322F031FB
EEDAE70F06B39E41329C6749B9255863AEC101C2E3DEF6AF7C5B367F559ABF11F4CFBDFDB25BBD31444507454C13
1474460570EE867DCBAA6A7E7CC3F7B757820D8D0E25661B7473EF117CC6BE0565C1C57F1E6A4964215E7A43B3F6
C0331AE93F9C1CC3F573B4E84E5A3F939CBBC63F9ADE4693873057304D55EF827CBD0098B0192E3A0EFEE2769B412
A45D",
}

Complaint Status Response Parameters
Sr. Mandatory
No. / Optional
Example:
MAHA00000MUM0108062018165735MCZ1XDK
Example: OU01
000 for Success
6 responseReason Character 10 Mandatory
Example:
9 assigned BBPOU to which the complaint is assigned Character 30 Mandatory
Complaint ID generated by BBPCU to check the
10 complaintId complaint status, reassign or close a complaint Character 20 Mandatory
subsequently
Current status of the complaint in BBPS
11 complaintStatus Character 20 Mandatory
ecosystem
12 remarks Number 100 Optional
response

Sample Transaction Complaint Status Response:

{
"head": {
"origInst": "BBCU",
"ts": "2019-04-10T11:55:36+05:30",
"ver": "1.0"
},
"reason": {
},
"txn": {
"ts": "2019-04-10T11:55:36+05:30",
"xchangeId": "506"
},
"assigned": "Test Bank",
"complaintId": "AP1554115701120",
"complaintStatus": "ESCALATED",
"remarks": "Updated by System"
}
}
Encrypted Response:
{
"responseMsg":
"2946B46F68BB8AB34F3C17ECF76D5E621B6EBA966CDD9591BC1728FFB02506FEE4081B98F3B894AF73933F65F89B
4E3E23D0A6B6A3D342583E60AD6B0A49FC133E787E113A314B94F50A3272BCCDA4CDC9C7F3EAE72D246D6644010
8DD2B495DF952338B1FC1984B5E2D03A4669050F458E33C9E5AF146F395FDC21EF7F0F4CD4E0F05C64584C879FDC
AEE8BF8B7627A469378E5C4FDC01DB712D6A38F0B2D91AA1CCAEB423E8B5A34CE159208884F67B02E293A85BA2C
0770A1599D3F02A0ED1B6EBA966CDD9591BC1728FFB02506FEAA9FA079B2DDAFED15949E24AC911E5F2A5BB43D5
739AB3F4D8A1F07C962C26E1184533279331EF502E0FE117B050C36B94D4D62F09B4EBEB818D7B6B5D3F578367FB
8736E3EB72DC2A2D800B1E3E6532DC90AFC2710E3001F4AB40F415641FCAC71DBE8AE12D1E3512C26884899DAF0
3154120CBE8DE5AE40599459B263E0DC77504DF7F5B0D4D6CB243EF34200AACDF0D2FE272DCDFEC7B320C7BDE64
EB8AC31E88379BCCE9F632019D56D9FB951B76F6B385FA104008345A48F369F348A777C3716AFB158872A1F66E56
DFC400243027D000F394C6B7477F7F9D69959EADE",
}

Sample Failure Complaint Status Response:

{
"head": {
"origInst": "OU01",
"ts": "2019-04-10T11:57:20",
"ver": "1.0"
},
"reason": {
"responseReason": "Complaint not found"
},
"txn": {
"ts": "2019-04-09T18:07:00+05:30",
"xchangeId": "506"
}
}
Encrypted Response:
{
"responseMsg":
"2946B46F68BB8AB34F3C17ECF76D5E621B6EBA966CDD9591BC1728FFB02506FEE4081B98F3B894AF73933F65F89B4
E3E186BB972415A8BB245350161FC26C0178EC4895BDD6D7C4A3E83769DD7CEE905A7A1B000498EDD0A884E2745F
8E5D7BEC230CD072DA1DB1582AD1083FC0668BB23261E09724EF7BD7950F4F210D48904D053134664D6C7F1AEEDF
177F89E004A6B7C58471C710FC67C822C2DF7525F649999A38A29BC1DEB477B6FD99F3769855A338341F0166D1AC8
FD2592D2D854CD242F5B467AEC25874A8724F751A550116B10ABAD6281152537A957DEF799F730C5941FE1EFD09C
89E0D149A4047F9178ECFFE0E17AB3867A83AC71766225162E227BD128047230A298E94CE481F04A0E4F6658925BB
3EF997261A4AD117DFBB11D37147DA8D02F3CE789BF03C448E2E2",
}

ANNEXURE
ANNEXURE I: ERROR CODES
List of Compliance Codes which must be populated at the time of business rejections are as follows:
API Response Code Compliance Code Compliance Description
Bill Fetch Response Code
Fetch 200 BFR001 Incorrect / invalid customer account
Fetch 200 BFR002 Invalid combination of customer parameters
Fetch 200 BFR003 No bill data available
Fetch 200 BFR004 Payment received for the billing period - no bill due
Fetch 200 BFR005 Customer account is blocked / closed
Fetch 200 BFR006 Customer account is not activated
Fetch 200 BFR007 Bill due date has expired - bill details are not available
Bill Pay Response Code
Pay 200 BPR001 Incorrect / invalid customer account
Pay 200 BPR002 Invalid combination of customer parameters
Pay 200 BPR003 Customer account is blocked / closed
Pay 200 BPR004 Customer account is not activated
Pay 200 BPR005 Payment cannot be accepted at this time
Pay 200 BPR006 Payment request has been exceeded for the day
Pay 200 BPR007 Repeat payment request

ANNEXURE II: BOU DECLINE SCENARIOS (EXAMPLES)
Following are few scenarios for the Billers.
MTI Scenario Biller Response Codes
Fetch Customer Customer Name = NA Response Code = 200

account not
Amount = 0 Response Reason = Failure
found
Due Date = 0001-01-01 Compliance Response Code =
BFR001
Bill Date = 0001-01-01
Response Code = Incorrect /
Bill Number = NA invalid customer account
Bill Period = NA
Fetch Customer Customer Name = NA Response Code = 200

account is
Amount = 0 Response Reason = Failure
valid & bill
data is not Due Date = 0001-01-01 Compliance Response Code =
available BFR003
Bill Date = 0001-01-01
Response Code = No bill data
Bill Number = NA available
Bill Period = NA
Fetch Customer Customer Name = As Is (NA if Customer Name in Response Code = 200
account is unavailable)
valid & no bill Response Reason = Failure
Amount = 0
due Compliance Response Code =
Due Date = Previous Due Date (0001-01-01 if Previous BFR004
Due Date is unavailable)
Response Code = Payment
Bill Date = Previous Bill Date (0001-01-01 if Previous Bill received for the billing period
Date is unavailable) - no bill due
Bill Number = Previous Bill Number (NA if Previous Bill

Number is unavailable)

Bill Period = As is (NA if Bill Period is unavailable)
Payment Bill pay Customer Name = As Is (NA if Customer Name in Response Code = 000
without fetch unavailable)
Response Reason = Successful
Amount = Bill Amount
Compliance Response Code =
Due Date = Current Date <blank>
Bill Date = Current Date Response Code = <blank>
Bill Number = NA
Bill Period = NA

ANNEXURE III: BIQ FORM

BBPS Agent Institution Form Biller Category
RM Name Electricity
Email ID Water/ Municipality
Contac t Number Gas Supply
Agent Institution Details Telecom
Agent Institution Name* DTH
Alias Name*
Type of Agent Institution*
Sr. No. Payment Channels
(Bank/Nonbank)
Type of Business* Payment Mode
Internet (Pre- Internet Banking Mobile (Pre- Mobile Banking Business
(Aggregator/Hypermarket/Small ATM Bank Branch Kiosk Agent
Financ ial Bank) login) (Post-login) login) (Post-login) Correspondent
TAN No* 1 Cash N N N N N Y Y Y Y
ROC UIN* 2 Internet Banking Y Y Y Y Y N N N N
Contact Details 3 Credit Card Y Y Y Y Y Y Y Y Y
Registered Address*
4 Debit Card Y Y Y Y Y Y Y Y Y
(City/State/Country/ Pincode)
Communication Address*
5 Prepaid Card Y Y Y Y Y Y Y Y Y
(City/State/Country/ Pincode)
Contact Person Name* 6 IMPS Y Y Y Y N Y N Y Y
Contact Person Mobile* 7 NEFT Y Y Y Y Y Y N Y Y
Contact Person Email* 8 UPI Y Y Y Y N Y N Y Y
URLs 9 Wallet Y Y Y Y N Y Y Y Y
Fetch URL* 10 AEPS N N Y N N Y N Y Y
Pay URL* 11 Account Transfer N N N N N Y N N N
Validation URL* 12 Bharat QR N N Y Y N Y N N Y
Account Details (Payout Account)
Ac c ount Number*
Bank Name*
IFSC Code*
Ac c ount Holder Name
Account Details (Recovery Account)
Ac c ount Number*
Bank Name*
IFSC Code*
Account Details (Real Time Debit Account)
Ac c ount Number*
Bank Name*
IFSC Code*
Payment Details (Select from the list given)
Payment Channel*
Min Amount*
Max Amount*
Payment Mode*
Min Amount*
Max Amount*
Commission Charges
Transaction Type*
(Both/ON-US/OFF-US)
Biller Category
Payment Channel*
Payment Mode*
Slab Upto*
Fixed Amount*
Fixed Percentage (%)*
Charge Type*
(Whic hever Higher/Whic hever Lower/
Both)

ANNEXURE IV: DEVICE DETAILS
Sr. Channel Code in Channel Code in

Initiating Channel Device Block Tags
No. API Agent ID
1 Bank Branch BNKBRNCH BNK IFSC, MOBILE, GEOCODE, POSTAL_CODE
2 Mobile (Pre-login) MOB MOB IP, IMEI, OS, APP
Mobile Banking (Post-
3 MOBB MBB IP, IMEI, OS, APP
login)
4 Internet (Pre-login) INT INT IP, MAC
Internet Banking
5 INTB INB IP, MAC
(Post-login)
6 ATM ATM ATM TERMINAL_ID
7 Kiosk KIOSK KSK TERMINAL_ID
TERMINAL_ID, MOBILE, GEOCODE,
8 Agent AGT AGT
POSTAL_CODE
Business TERMINAL_ID, MOBILE, GEOCODE,
9 BSC BSC
Correspondent POSTAL_CODE
ANNEXURE V: PAYMENT INFORMATION
S. Payment Information
Payment Mode
No. Tag
1 Cash Remarks
2 Internet Banking IFSC|AccountNo
3 Credit Card CardNum|AuthCode
4 Debit Card CardNum|AuthCode
5 Prepaid Card CardNum|AuthCode
6 IMPS MMID|MobileNo
7 NEFT IFSC|AccountNo
8 UPI VPA
9 Wallet WalletName|MobileNo
10 AEPS Aadhaar|IIN
11 Account Transfer IFSC|AccountNo

ANNEXURE VI: PAYMENT MODE COMBINATIONS
Payment Channels
Sr. No. Payment Mode
INT INB MOB MBB ATM BNK KSK AGT BSC
1 Cash N N N N N Y Y Y Y
2 Internet Banking Y Y Y Y Y N N N N
3 Credit Card Y Y Y Y Y Y Y Y Y
4 Debit Card Y Y Y Y Y Y Y Y Y
5 Prepaid Card Y Y Y Y Y Y Y Y Y
6 IMPS Y Y Y Y N Y N Y Y
7 NEFT Y Y Y Y Y Y N Y Y
8 UPI Y Y Y Y N Y N Y Y
9 Wallet Y Y Y Y N Y Y Y Y
10 AEPS N N Y N N Y N Y Y
11 Account Transfer N N N N N Y N N N
GUIDLINE FOR UI DESIGN
 Select Bill payment option on Front End (App/Portal).

 Select the Biller Category of the biller. (Biller Category will be stored by AI as a Master Data.)
 AI should call Biller List API to fetch the biller list. Respective billers will be get fetched basis selected category.
 User will select the biller from the list, basis selected biller respective customer parameters will be fetched. To
get the respective customer parameters AI has to call Biller Details API.
Validations
 If the Fetch Requirement is Mandatory then user is required to do Bill Fetch before Bill Payment, for this
condition Quick-Pay will be No.
 If the Fetch Requirement is Optional then user is highly recommended to do both Bill Fetch and Bill
Payment, for this condition Quick-Pay will be No. But user can also do a direct payment without Bill
Fetch in this case Quick-Pay will be Yes,
 If the Fetch Requirement is Not Supported, the user cannot perform a Bill Fetch in this condition only
direct payments is allowed.

 If the Support Bill Validation is Mandatory then user is required to do Bill validation before Bill Payment,
for this condition Quick-Pay will be No.
 If the Support Bill Validation is Optional then user is highly recommended to do both Bill validation and
Bill Payment, for this condition Quick-Pay will be No. But user can also do a direct payment without Bill
Fetch in this case Quick-Pay will be Yes,
 If the Support Bill Validation is Not Supported, the user cannot perform a Bill validation in this condition
only direct payments is allowed.
 Payment Amount Exactness, if EXACT then for bill payment the transaction amount has to match the Bill
Amount, which is received in Bill Fetch Response.
 Payment Amount Exactness, if EXACT UP then for bill payment the transaction amount can be equal or
above than the Bill Amount, which is received in Bill Fetch Response.
 Payment Amount Exactness, if EXACT DOWN then for bill payment the transaction amount can be equal
or less than the Bill Amount, which is received in Bill Fetch Response.
 When Biller Accepts Adhoc payment (True Flag) and Fetch Requirement is not mandatory and bill
validation is also not mandatory then user is allowed to make quick payment (Quick-Pay=Yes) i.e.
Payment without Bill Fetch or Bill Validation.
 Mobile Number (Payer) is mandatory Field and other customer parameter fields may be mandatory or optional.
 AI should validate Data Type of customer parameter shared in Biller Details.

 AI should validate Min Length & Max Length of customer parameter shared in Biller Details.
 AI should validate REGX of customer parameter shared in Biller Details.

BBPS Agent Institution Integration Toolkit

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

BBPS Agent Institution Integration Toolkit

Uploaded by

Copyright:

Available Formats

Integration Kit-BBPS Agent Institution

BBPS- Agent Institution

Private & Confidential Page 1

Document Release Note

Document Name Integration Toolkit Document – API

Release Date: 20-Dec-2019

Prepared by: Kishor Singh Date: 20-Dec-2019

Reviewed by: Riyaz Parve Date: 20-Dec-2019

Approved by: Saurabh R Date: 20-Dec-2019

Document Revision History

1 19-Dec-2018 First version 21-Dec-2018

2 05-Jan-2019 1) Added description of the API parameters 07-Jan-2019

3 08-Apr-2019 1) Updated the API parameters and API 11-Apr-2019

4 16-Nov-2019 Added Guidelines for UI Design 16-Nov-2019

5 20-Dec-2019 Updated API Specs as per NPCI Guidelines 20-Dec-2019

Private & Confidential Page 2

BBPS Introduction ........................................................................................................................................................ 5

Assumptions and Prerequisites .................................................................................................................................... 5

API Integration Approach ............................................................................................................................................. 6

Encryption Decryption logic ......................................................................................................................................... 9

API List ............................................................................................................................................................................10

API Specification .............................................................................................................................................................11

Biller List API ...............................................................................................................................................................11

Biller Details API ..........................................................................................................................................................16

Bill Fetch API ...............................................................................................................................................................39

Bill validation API ........................................................................................................................................................51

Bill Payment API ..........................................................................................................................................................57

Using Reference ID ..................................................................................................................................................85

Using Mobile Number .............................................................................................................................................90

Raise Complaint API ....................................................................................................................................................96

Check Complaint Status.............................................................................................................................................105

Annexure I: Error Codes ............................................................................................................................................110

Annexure II: BOU Decline Scenarios (Examples).........................................................................................................111

Annexure III: BIQ Form ..............................................................................................................................................113

Annexure IV: Device Details ......................................................................................................................................114

Annexure V: Payment Information ............................................................................................................................114

Private & Confidential Page 3

Annexure VI: Payment Mode Combinations ..............................................................................................................115

Guidline for UI Design ...................................................................................................................................................115

Private & Confidential Page 4

Participants in Customer Operating Unit Side

ASSUMPTIONS AND PRER EQUISITES

The following are the pre-requites for BBPS integration:

 Agent Institution should be able to develop API’s in JSON.

Private & Confidential Page 5

API INTEGRATION APPROACH

Steps to generate request & read response messages

Clear Text Request:

"name": "CA Number",

Private & Confidential Page 6

 URL: https://127.0.0.1:9080/<Refer service name at each API section>

Response Message Format (JSON Format)

Private & Confidential Page 7

"customerName": "Arnab Moitra",

"custConvDesc": "Customer service fee",

Private & Confidential Page 8

ENCRYPTION DECRYPTION LOGIC

Sample PVT_KEY = abcedf12345ABCDEF67890abcDEF123

Sample Code snippet:

Private & Confidential Page 9

BBPS platform provides the following API to the agent institution

Sr. No API Name Description Description

Private & Confidential Page 10