Skip to content

Commit 1c35d68

Browse files
tanmay-dixittanmay-dixit
authored
Merge pull request #378 from SetuHQ/COU-3218-webhook-doc-update
removed fields which are not sent in API
2 parents 0640fd6 + 5cfe3cf commit 1c35d68

File tree

2 files changed

+12
-237
lines changed

2 files changed

+12
-237
lines changed

‎content/payments/billpay/pre-built-screens/webhooks.mdx‎

Lines changed: 6 additions & 120 deletions
Original file line numberDiff line numberDiff line change
@@ -299,12 +299,11 @@ Below are the parameter tables and sample payloads for the listed events. Note t
299299
{`{
300300
"mobileNumber": "9481773053",
301301
"status": "FETCH_FAILURE",
302-
"billId": "",
303302
"billerId": "MAHI00000NATIC",
304303
"billerName": "Mahindra Rural Housing Finance Ltd",
305304
"billerCategory": "Loan-Repayment",
306305
"sessionId": "1272707270496486911",
307-
"customerId": "cust@1234" // if available
306+
"customerId": "cust@1234", // if available
308307
"event": "bill_fetch_failure",
309308
"refId": "CMA0I65RCU2I32C3L0H0KNYQYAG40021831",
310309
"fetchErrorCode": "ERR001",
@@ -337,18 +336,6 @@ Below are the parameter tables and sample payloads for the listed events. Note t
337336
<code>FETCH_FAILURE</code>
338337
</td>
339338
</tr>
340-
<tr>
341-
<td>billId</td>
342-
<td>String</td>
343-
<td>
344-
Unique identifier for the bill. It is generated by the
345-
biller. Also called as billNumber. Not applicable where
346-
there is no bill.
347-
</td>
348-
<td>
349-
<code>69a1fbc0-b5d1-4cbf-ac6d-c4244e3e7e0c</code>
350-
</td>
351-
</tr>
352339
<tr>
353340
<td>billerId</td>
354341
<td>String</td>
@@ -677,10 +664,8 @@ Below are the parameter tables and sample payloads for the listed events. Note t
677664
"billerName": "Mahindra Rural Housing Finance Ltd",
678665
"billerCategory": "Loan-Repayment",
679666
"sessionId": "1272707270496486911",
680-
"customerId": "cust@1234" // if available
667+
"customerId": "cust@1234", // if available
681668
"orderId": "Q00ABCDEFGHZOQ",
682-
"billAmount": "105.0",
683-
"dueDate": "2021-05-23", // if available
684669
"amountPaid": "601.00",
685670
"event": "bill_payment_failure",
686671
"refId": "CMA0I65RCU2I32C3L0H0KNYQYAG40021831"
@@ -788,22 +773,6 @@ Below are the parameter tables and sample payloads for the listed events. Note t
788773
<code>Q00ABCDEFGHZOQ</code>
789774
</td>
790775
</tr>
791-
<tr>
792-
<td>billAmount</td>
793-
<td>String (Number)</td>
794-
<td>Amount of the bill in rupees (INR)</td>
795-
<td>
796-
<code>101.55</code>
797-
</td>
798-
</tr>
799-
<tr>
800-
<td>dueDate</td>
801-
<td>String (Date)</td>
802-
<td>Due date of the bill. Format is YYYY-MM-DD.</td>
803-
<td>
804-
<code>2023-05-02</code>
805-
</td>
806-
</tr>
807776
<tr>
808777
<td>amountPaid</td>
809778
<td>String (Number)</td>
@@ -847,19 +816,14 @@ Below are the parameter tables and sample payloads for the listed events. Note t
847816
</summary>
848817
<CodeBlockWithCopy language="json">
849818
{`{
850-
"txnId": null,
851819
"mobileNumber": "9481773053",
852820
"status": "COLLECTION_FAILURE",
853-
"billId": "dfeeaf14-e43a-4196-90d0-41089e979ad5",
854821
"billerId": "MAHI00000NATIC",
855822
"billerName": "Mahindra Rural Housing Finance Ltd",
856823
"billerCategory": "Loan-Repayment",
857-
"billAmount": "105.0",
858-
"dueDate": "2021-05-23", // if available
859824
"sessionId": "1272707270496486911",
860-
"customerId": "cust@1234" // if available
825+
"customerId": "cust@1234", // if available
861826
"amountPaid": 601.0,
862-
"amount": null,
863827
"event": "bill_collection_failure",
864828
"refId": "CMA0I65RCU2I32C3L0H0KNYQYAG40021831"
865829
}`}
@@ -871,18 +835,6 @@ Below are the parameter tables and sample payloads for the listed events. Note t
871835
<td>Description</td>
872836
<td>Example</td>
873837
</tr>
874-
<tr>
875-
<td>txnId</td>
876-
<td></td>
877-
<td>
878-
Unique identifier for the transaction generated by COU. Not
879-
generated here because Setu does not post the bill-payment
880-
request to BBPS.
881-
</td>
882-
<td>
883-
<code>null</code>
884-
</td>
885-
</tr>
886838
<tr>
887839
<td>mobileNumber</td>
888840
<td>String (Number)</td>
@@ -899,18 +851,6 @@ Below are the parameter tables and sample payloads for the listed events. Note t
899851
<code>COLLECTION_FAILURE</code>
900852
</td>
901853
</tr>
902-
<tr>
903-
<td>billId</td>
904-
<td>String</td>
905-
<td>
906-
Unique identifier for the bill. It is generated by the
907-
biller. Also called as billNumber. Not applicable where
908-
there is no bill.
909-
</td>
910-
<td>
911-
<code>dfeeaf14-e43a-4196-90d0-41089e979ad5</code>
912-
</td>
913-
</tr>
914854
<tr>
915855
<td>billerId</td>
916856
<td>String</td>
@@ -941,22 +881,6 @@ Below are the parameter tables and sample payloads for the listed events. Note t
941881
<code>Loan-Repayment</code>
942882
</td>
943883
</tr>
944-
<tr>
945-
<td>billAmount</td>
946-
<td>String (Number)</td>
947-
<td>Amount of the bill in rupees (INR)</td>
948-
<td>
949-
<code>101.55</code>
950-
</td>
951-
</tr>
952-
<tr>
953-
<td>dueDate</td>
954-
<td>String (Date)</td>
955-
<td>Due date of the bill. Format is YYYY-MM-DD.</td>
956-
<td>
957-
<code>2023-05-02</code>
958-
</td>
959-
</tr>
960884
<tr>
961885
<td>sessionId</td>
962886
<td>String</td>
@@ -968,7 +892,7 @@ Below are the parameter tables and sample payloads for the listed events. Note t
968892
<tr>
969893
<td>customerId</td>
970894
<td>String</td>
971-
<td>Unique identifier for the customerId used for this session</td>
895+
<td>Unique identifier for the customerId used for this session (if available)</td>
972896
<td>
973897
<code>cust@1234</code>
974898
</td>
@@ -985,14 +909,6 @@ Below are the parameter tables and sample payloads for the listed events. Note t
985909
<code>601.75</code>
986910
</td>
987911
</tr>
988-
<tr>
989-
<td>amount</td>
990-
<td></td>
991-
<td></td>
992-
<td>
993-
<code>null</code>
994-
</td>
995-
</tr>
996912
<tr>
997913
<td>event</td>
998914
<td>String</td>
@@ -1030,14 +946,11 @@ Below are the parameter tables and sample payloads for the listed events. Note t
1030946
"txnId": "AXO101557980",
1031947
"mobileNumber": "9481773053",
1032948
"status": "PAYMENT_REFUNDED",
1033-
"billId": "dfeeaf14-e43a-4196-90d0-41089e979ad5",
1034949
"billerId": "MAHI00000NATIC",
1035950
"billerName": "Mahindra Rural Housing Finance Ltd",
1036951
"billerCategory": "Loan-Repayment",
1037952
"sessionId": "1272707270496486911",
1038-
"customerId": "cust@1234" // if available
1039-
"billAmount": "105.0",
1040-
"dueDate": "2021-05-23", // if available
953+
"customerId": "cust@1234", // if available
1041954
"orderId": "H001234566666",
1042955
"amountPaid": "601.00",
1043956
"event": "bill_payment_refunded",
@@ -1075,17 +988,6 @@ Below are the parameter tables and sample payloads for the listed events. Note t
1075988
<code>PAYMENT_REFUNDED</code>
1076989
</td>
1077990
</tr>
1078-
<tr>
1079-
<td>billId</td>
1080-
<td>String</td>
1081-
<td>
1082-
Unique identifier for the bill. It is generated by the
1083-
biller. Also called as billNumber
1084-
</td>
1085-
<td>
1086-
<code>dfeeaf14-e43a-4196-90d0-41089e979ad5</code>
1087-
</td>
1088-
</tr>
1089991
<tr>
1090992
<td>billerId</td>
1091993
<td>String</td>
@@ -1127,27 +1029,11 @@ Below are the parameter tables and sample payloads for the listed events. Note t
11271029
<tr>
11281030
<td>customerId</td>
11291031
<td>String</td>
1130-
<td>Unique identifier for the customerId used for this session</td>
1032+
<td>Unique identifier for the customerId used for this session (if available)</td>
11311033
<td>
11321034
<code>cust@1234</code>
11331035
</td>
11341036
</tr>
1135-
<tr>
1136-
<td>billAmount</td>
1137-
<td>String (Number)</td>
1138-
<td>Amount of the bill in rupees (INR)</td>
1139-
<td>
1140-
<code>601.75</code>
1141-
</td>
1142-
</tr>
1143-
<tr>
1144-
<td>dueDate</td>
1145-
<td>String (Date)</td>
1146-
<td>Due date of the bill. Format is YYYY-MM-DD.</td>
1147-
<td>
1148-
<code>2023-05-02</code>
1149-
</td>
1150-
</tr>
11511037
<tr>
11521038
<td>orderId</td>
11531039
<td>String</td>

0 commit comments

Comments
 (0)