Payment Notification API
Last updated
Last updated
After Sending the Payment response to Biller Protocol, The protocol server will send the Status of the Payment to Biller. Billers need to have one endpoint with below parameters. Then protocol will send the notification to that corresponding endpoint
| Parent Property/Element | Property/Element Name | Mandatory | Data Type | Description |
|---|---|---|---|---|
Expected Acknowledgement Parameters
The various parameters are explained below:
| Parent Property/Element | Property/Element Name | Mandatory | Data Type | Description |
|---|---|---|---|---|
Json Formatted Request Example
Json Formatted Response Example
[ROOT] (No parent property / element)
refId
M
String
Unique identification assigned by the initiating BBPOU to unambiguously identify the transaction which is passed on, unchanged, throughout the entire end-to-end chain, binding the Fetch and Payment messages
status
M
String
Status of the bill fetch response Successful/Failure
reason
M
String
In case of failure reason will be provided in this field
ack
M
Object
Acknowledgement from NPCI will be in this field
ack
api
M
String
PAYMENT_RESPONSE
refid
M
String
Refid of the transaction
msgId
M
String
Message id
rspCd
M
String
Response code
ts
M
String
Timestamp
errorMessages
M
Object
Contains the error message and error code
errorMessages
errorCd
C
String
Carries the compliance code indicating the reason for a failed
transaction – not required for a successful transaction
errorDtl
C
String
Description of the compliance code – not required for a
successful transaction
[ROOT] (No parent property / element)
reason
M
String
Min Length – 1, Max Length – 100
Reason of the Status
code
M
Integer Fixed Length 3
Response code for a request
status
M
String Min Length – 1, Max Length – 100
Status of given request