Skip to content

removed fields which are not sent in API #378

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tanmay-dixit merged 1 commit into from
Dec 5, 2025
Merged

removed fields which are not sent in API #378

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
126 changes: 6 additions & 120 deletions content/payments/billpay/pre-built-screens/webhooks.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -299,12 +299,11 @@ Below are the parameter tables and sample payloads for the listed events. Note t
{`{
"mobileNumber": "9481773053",
"status": "FETCH_FAILURE",
"billId": "",
"billerId": "MAHI00000NATIC",
"billerName": "Mahindra Rural Housing Finance Ltd",
"billerCategory": "Loan-Repayment",
"sessionId": "1272707270496486911",
"customerId": "cust@1234" // if available
"customerId": "cust@1234", // if available
"event": "bill_fetch_failure",
"refId": "CMA0I65RCU2I32C3L0H0KNYQYAG40021831",
"fetchErrorCode": "ERR001",
Expand Down Expand Up @@ -337,18 +336,6 @@ Below are the parameter tables and sample payloads for the listed events. Note t
<code>FETCH_FAILURE</code>
</td>
</tr>
<tr>
<td>billId</td>
<td>String</td>
<td>
Unique identifier for the bill. It is generated by the
biller. Also called as billNumber. Not applicable where
there is no bill.
</td>
<td>
<code>69a1fbc0-b5d1-4cbf-ac6d-c4244e3e7e0c</code>
</td>
</tr>
<tr>
<td>billerId</td>
<td>String</td>
Expand Down Expand Up @@ -677,10 +664,8 @@ Below are the parameter tables and sample payloads for the listed events. Note t
"billerName": "Mahindra Rural Housing Finance Ltd",
"billerCategory": "Loan-Repayment",
"sessionId": "1272707270496486911",
"customerId": "cust@1234" // if available
"customerId": "cust@1234", // if available
"orderId": "Q00ABCDEFGHZOQ",
"billAmount": "105.0",
"dueDate": "2021-05-23", // if available
"amountPaid": "601.00",
"event": "bill_payment_failure",
"refId": "CMA0I65RCU2I32C3L0H0KNYQYAG40021831"
Expand Down Expand Up @@ -788,22 +773,6 @@ Below are the parameter tables and sample payloads for the listed events. Note t
<code>Q00ABCDEFGHZOQ</code>
</td>
</tr>
<tr>
<td>billAmount</td>
<td>String (Number)</td>
<td>Amount of the bill in rupees (INR)</td>
<td>
<code>101.55</code>
</td>
</tr>
<tr>
<td>dueDate</td>
<td>String (Date)</td>
<td>Due date of the bill. Format is YYYY-MM-DD.</td>
<td>
<code>2023-05-02</code>
</td>
</tr>
<tr>
<td>amountPaid</td>
<td>String (Number)</td>
Expand Down Expand Up @@ -847,19 +816,14 @@ Below are the parameter tables and sample payloads for the listed events. Note t
</summary>
<CodeBlockWithCopy language="json">
{`{
"txnId": null,
"mobileNumber": "9481773053",
"status": "COLLECTION_FAILURE",
"billId": "dfeeaf14-e43a-4196-90d0-41089e979ad5",
"billerId": "MAHI00000NATIC",
"billerName": "Mahindra Rural Housing Finance Ltd",
"billerCategory": "Loan-Repayment",
"billAmount": "105.0",
"dueDate": "2021-05-23", // if available
"sessionId": "1272707270496486911",
"customerId": "cust@1234" // if available
"customerId": "cust@1234", // if available
"amountPaid": 601.0,
"amount": null,
"event": "bill_collection_failure",
"refId": "CMA0I65RCU2I32C3L0H0KNYQYAG40021831"
}`}
Expand All @@ -871,18 +835,6 @@ Below are the parameter tables and sample payloads for the listed events. Note t
<td>Description</td>
<td>Example</td>
</tr>
<tr>
<td>txnId</td>
<td></td>
<td>
Unique identifier for the transaction generated by COU. Not
generated here because Setu does not post the bill-payment
request to BBPS.
</td>
<td>
<code>null</code>
</td>
</tr>
<tr>
<td>mobileNumber</td>
<td>String (Number)</td>
Expand All @@ -899,18 +851,6 @@ Below are the parameter tables and sample payloads for the listed events. Note t
<code>COLLECTION_FAILURE</code>
</td>
</tr>
<tr>
<td>billId</td>
<td>String</td>
<td>
Unique identifier for the bill. It is generated by the
biller. Also called as billNumber. Not applicable where
there is no bill.
</td>
<td>
<code>dfeeaf14-e43a-4196-90d0-41089e979ad5</code>
</td>
</tr>
<tr>
<td>billerId</td>
<td>String</td>
Expand Down Expand Up @@ -941,22 +881,6 @@ Below are the parameter tables and sample payloads for the listed events. Note t
<code>Loan-Repayment</code>
</td>
</tr>
<tr>
<td>billAmount</td>
<td>String (Number)</td>
<td>Amount of the bill in rupees (INR)</td>
<td>
<code>101.55</code>
</td>
</tr>
<tr>
<td>dueDate</td>
<td>String (Date)</td>
<td>Due date of the bill. Format is YYYY-MM-DD.</td>
<td>
<code>2023-05-02</code>
</td>
</tr>
<tr>
<td>sessionId</td>
<td>String</td>
Expand All @@ -968,7 +892,7 @@ Below are the parameter tables and sample payloads for the listed events. Note t
<tr>
<td>customerId</td>
<td>String</td>
<td>Unique identifier for the customerId used for this session</td>
<td>Unique identifier for the customerId used for this session (if available)</td>
<td>
<code>cust@1234</code>
</td>
Expand All @@ -985,14 +909,6 @@ Below are the parameter tables and sample payloads for the listed events. Note t
<code>601.75</code>
</td>
</tr>
<tr>
<td>amount</td>
<td></td>
<td></td>
<td>
<code>null</code>
</td>
</tr>
<tr>
<td>event</td>
<td>String</td>
Expand Down Expand Up @@ -1030,14 +946,11 @@ Below are the parameter tables and sample payloads for the listed events. Note t
"txnId": "AXO101557980",
"mobileNumber": "9481773053",
"status": "PAYMENT_REFUNDED",
"billId": "dfeeaf14-e43a-4196-90d0-41089e979ad5",
"billerId": "MAHI00000NATIC",
"billerName": "Mahindra Rural Housing Finance Ltd",
"billerCategory": "Loan-Repayment",
"sessionId": "1272707270496486911",
"customerId": "cust@1234" // if available
"billAmount": "105.0",
"dueDate": "2021-05-23", // if available
"customerId": "cust@1234", // if available
"orderId": "H001234566666",
"amountPaid": "601.00",
"event": "bill_payment_refunded",
Expand Down Expand Up @@ -1075,17 +988,6 @@ Below are the parameter tables and sample payloads for the listed events. Note t
<code>PAYMENT_REFUNDED</code>
</td>
</tr>
<tr>
<td>billId</td>
<td>String</td>
<td>
Unique identifier for the bill. It is generated by the
biller. Also called as billNumber
</td>
<td>
<code>dfeeaf14-e43a-4196-90d0-41089e979ad5</code>
</td>
</tr>
<tr>
<td>billerId</td>
<td>String</td>
Expand Down Expand Up @@ -1127,27 +1029,11 @@ Below are the parameter tables and sample payloads for the listed events. Note t
<tr>
<td>customerId</td>
<td>String</td>
<td>Unique identifier for the customerId used for this session</td>
<td>Unique identifier for the customerId used for this session (if available)</td>
<td>
<code>cust@1234</code>
</td>
</tr>
<tr>
<td>billAmount</td>
<td>String (Number)</td>
<td>Amount of the bill in rupees (INR)</td>
<td>
<code>601.75</code>
</td>
</tr>
<tr>
<td>dueDate</td>
<td>String (Date)</td>
<td>Due date of the bill. Format is YYYY-MM-DD.</td>
<td>
<code>2023-05-02</code>
</td>
</tr>
<tr>
<td>orderId</td>
<td>String</td>
Expand Down
Loading