- Use provided{" "} - - API reference - {" "} - to start integration. Request for a detailed API run through from Setu team, - if needed. Contact us at{" "} - - Setu Support - - , should you need any help during integration. + Use provided{" "} + + API reference + {" "} + to start integration. Request for a detailed API run through from Setu team, + if needed. Contact us at{" "} + + Setu Support + + , should you need any help during integration.
A summary of the integration process— @@ -83,11 +83,11 @@ Reach out to onboarding@setu.co to get a list of business details It is recommended that you set up a callback URL to receive notifications for various types of events, while using— -- APIs to fetch bill for a customer -- APIs to validate customer identifier with a biller -- APIs to for completing a bill payment -- APIs to raise disputes against a payment -- APIs to receive an automatic bill due notification +- APIs to fetch bill for a customer +- APIs to validate customer identifier with a biller +- APIs to for completing a bill payment +- APIs to raise disputes against a payment +- APIs to receive an automatic bill due notification When this is enabled by you, any successful `fetch`, `validate`, `payment` or `dispute` event gets posted to your callback URL. @@ -95,30 +95,30 @@ You may specify only one callback URL. **This should be a valid URI string that Setu will append the following default paths to this callback URL, to alert your on specific events— -| Event type | Path | -|-------------------------|-----------------------------| -| `fetch` a bill | `/bills/fetch/response` | -| `validate` bill details | `/bills/validate/response` | -| `payment` of bill | `/bills/payment/response` | -| `dispute` against bill | `/bills/dispute/response` | +| Event type | Path | +| ----------------------- | -------------------------- | +| `fetch` a bill | `/bills/fetch/response` | +| `validate` bill details | `/bills/validate/response` | +| `payment` of bill | `/bills/payment/response` | +| `dispute` against bill | `/bills/dispute/response` |fetch/validate/payment/
- dispute events too.{" "}
-
- The URL may be relative (a path, without a host) or absolute (starting
- with a scheme)
-
- .
- callbackURL value. If you specify a URL, it will simply
- override the callback URL value for that particular event.
+ You may also optionally choose to specify custom paths or URLs for{" "}
+ fetch/validate/payment/
+ dispute events too.{" "}
+
+ The URL may be relative (a path, without a host) or absolute (starting with
+ a scheme)
+
+ .
+ callbackURL value. If you specify a URL, it will simply override
+ the callback URL value for that particular event.
- Here is a{" "} - - BBPS-compliant UX flow - {" "} - and a quick summary of BBPS guidelines to keep in mind—, + Here is a{" "} + + BBPS-compliant UX flow + {" "} + and a quick summary of BBPS guidelines to keep in mind—,
-- The app / website UI must contain a button for “Pay bills” with the BBPS logo shown. -- BBPS logo must be present on top right corner of all screens used by customer during search of biller or bill and also for screens relating to payment of bill. -- BBPS assured logo must always be shown on the payment sucessful and payment receipt pages. The regular BBPS logo can be removed from these. +- The app / website UI must contain a button for “Pay bills” with the BBPS logo shown. +- BBPS logo must be present on top right corner of all screens used by customer during search of biller or bill and also for screens relating to payment of bill. +- BBPS assured logo must always be shown on the payment sucessful and payment receipt pages. The regular BBPS logo can be removed from these.bill_fetch_success — Notification when bill-fetch
- request is successful
- bill_fetch_success — Notification when bill-fetch request
+ is successful
+ | Parameter | -Data Type | -Description | -Example | -
| mobileNumber | -String (Number) | -Mobile number used to generate the bill-fetch request | -
- 9481773053
- |
-
| status | -String | -Status of the bill-fetch request | -
- FETCH_SUCCESS
- |
-
| billId | -String | -- Unique identifier for the bill. It is generated by the - biller. Not applicable where - there is no bill. - | -
- 490a8940-886e-45ed-bfd1-21dbed064373
- |
-
| billNumber | -String | -- Unique identifier for the bill as sent by NPCI. Not applicable where - there is no bill. - | -
- 490a8940-886e-45ed-bfd1-21dbed064373
- |
-
| billerId | -String | -- Unique identifier (Biller ID in BBPS) allocated to the - Biller - | -
- MAHI00000NATIC
- |
-
| billerName | -String | -Name of the biller as registered with BBPS | -
- Mahindra Rural Housing Finance Ltd
- |
-
| billerCategory | -String | -- Category of the biller as registered with BBPS. There are - more than 25 biller categories. - | -
-
- Loan-Repayment; Electricity; Landline-Postpaid etc.
-
- |
-
| billAmount | -String (Number) | -Amount of the bill in rupees (INR) | -
- 101.55
- |
-
| billDate | -String (Date) | -Date of bill generation. Format is YYYY-MM-DD. | -
- 2023-05-02
- |
-
| dueDate | -String (Date) | -Due date of the bill. Format is YYYY-MM-DD. | -
- 2023-05-20
- |
-
| customerId | -String | -Unique identifier for the customerId used for this session | -
- cust@1234
- |
-
| sessionId | -String | -Unique identifier for the session used for this request | -
- 7f6de02a-0061-403f-bd65-47d4b5f72c87
- |
-
| event | -String | -Name of the event to identify this user event | -
- bill_fetch_success
- |
-
| additionalInfo | -String | -- Additional info available to Agent Institutions basis the - additional info passed by the biller. - | -
- name:"example" value:"ABC"
- |
-
| refId | -String | -BBPS Reference ID | -
- CMA0I65RCU2I32C3L0H0KNYQYAG40021831
- |
-
| Parameter | +Data Type | +Description | +Example | +
| mobileNumber | +String (Number) | +Mobile number used to generate the bill-fetch request | +
+ 9481773053
+ |
+
| status | +String | +Status of the bill-fetch request | +
+ FETCH_SUCCESS
+ |
+
| billId | +String | ++ Unique identifier for the bill. It is generated by the biller. Not + applicable where there is no bill. + | +
+ 490a8940-886e-45ed-bfd1-21dbed064373
+ |
+
| billNumber | +String | ++ Unique identifier for the bill as sent by NPCI. Not applicable where + there is no bill. + | +
+ 490a8940-886e-45ed-bfd1-21dbed064373
+ |
+
| billerId | +String | +Unique identifier (Biller ID in BBPS) allocated to the Biller | +
+ MAHI00000NATIC
+ |
+
| billerName | +String | +Name of the biller as registered with BBPS | +
+ Mahindra Rural Housing Finance Ltd
+ |
+
| billerCategory | +String | ++ Category of the biller as registered with BBPS. There are more than 25 + biller categories. + | +
+ Loan-Repayment; Electricity; Landline-Postpaid etc.
+ |
+
| billAmount | +String (Number) | +Amount of the bill in rupees (INR) | +
+ 101.55
+ |
+
| billDate | +String (Date) | +Date of bill generation. Format is YYYY-MM-DD. | +
+ 2023-05-02
+ |
+
| dueDate | +String (Date) | +Due date of the bill. Format is YYYY-MM-DD. | +
+ 2023-05-20
+ |
+
| customerId | +String | +Unique identifier for the customerId used for this session | +
+ cust@1234
+ |
+
| sessionId | +String | +Unique identifier for the session used for this request | +
+ 7f6de02a-0061-403f-bd65-47d4b5f72c87
+ |
+
| event | +String | +Name of the event to identify this user event | +
+ bill_fetch_success
+ |
+
| additionalInfo | +String | ++ Additional info available to Agent Institutions basis the additional + info passed by the biller. + | +
+ name:"example" value:"ABC"
+ |
+
| refId | +String | +BBPS Reference ID | +
+ CMA0I65RCU2I32C3L0H0KNYQYAG40021831
+ |
+
bill_fetch_failure — Notification when bill-fetch
- request is not successful
- bill_fetch_failure — Notification when bill-fetch request
+ is not successful
+ | Parameter | -Data Type | -Description | -Example | -
| mobileNumber | -String (Number) | -Mobile number used to generate the bill-fetch request | -
- 9481773053
- |
-
| status | -String | -Status of the bill-fetch request | -
- FETCH_FAILURE
- |
-
| billId | -String | -- Unique identifier for the bill. It is generated by the - biller. Also called as billNumber. Not applicable where - there is no bill. - | -
- 69a1fbc0-b5d1-4cbf-ac6d-c4244e3e7e0c
- |
-
| billerId | -String | -- Unique identifier (Biller ID in BBPS) allocated to the - Biller - | -
- MAHI00000NATIC
- |
-
| billerName | -String | -Name of the biller as registered with BBPS | -
- Mahindra Rural Housing Finance Ltd
- |
-
| billerCategory | -String | -- Category of the biller as registered with BBPS. There are - more than 25 biller categories. - | -
- Loan-Repayment
- |
-
| sessionId | -String | -Unique identifier for the session used for this request | -
- 7f6de02a-0061-403f-bd65-47d4b5f72c87
- |
-
| customerId | -String | -Unique identifier for the customerId used for this session | -
- cust@1234
- |
-
| event | -String | -Name of the event to identify this user event | -
- bill_fetch_failure
- |
-
| fetchErrorCode | -String | -Error codes for the failure | -
- ERR001
- |
-
| error | -- | Error array containing details of the error | -- |
| code | -String | -Error code | -
- ERR001
- |
-
| message | -String | -Error description | -
- Unable to get details
- |
-
| refId | -String | -BBPS Reference ID | -
- CMA0I65RCU2I32C3L0H0KNYQYAG40021831
- |
-
| Parameter | +Data Type | +Description | +Example | +
| mobileNumber | +String (Number) | +Mobile number used to generate the bill-fetch request | +
+ 9481773053
+ |
+
| status | +String | +Status of the bill-fetch request | +
+ FETCH_FAILURE
+ |
+
| billId | +String | ++ Unique identifier for the bill. It is generated by the biller. Also + called as billNumber. Not applicable where there is no bill. + | +
+ 69a1fbc0-b5d1-4cbf-ac6d-c4244e3e7e0c
+ |
+
| billerId | +String | +Unique identifier (Biller ID in BBPS) allocated to the Biller | +
+ MAHI00000NATIC
+ |
+
| billerName | +String | +Name of the biller as registered with BBPS | +
+ Mahindra Rural Housing Finance Ltd
+ |
+
| billerCategory | +String | ++ Category of the biller as registered with BBPS. There are more than 25 + biller categories. + | +
+ Loan-Repayment
+ |
+
| sessionId | +String | +Unique identifier for the session used for this request | +
+ 7f6de02a-0061-403f-bd65-47d4b5f72c87
+ |
+
| customerId | +String | +Unique identifier for the customerId used for this session | +
+ cust@1234
+ |
+
| event | +String | +Name of the event to identify this user event | +
+ bill_fetch_failure
+ |
+
| fetchErrorCode | +String | +Error codes for the failure | +
+ ERR001
+ |
+
| error | ++ | Error array containing details of the error | ++ |
| code | +String | +Error code | +
+ ERR001
+ |
+
| message | +String | +Error description | +
+ Unable to get details
+ |
+
| refId | +String | +BBPS Reference ID | +
+ CMA0I65RCU2I32C3L0H0KNYQYAG40021831
+ |
+
bill_payment_success — Notification when
- bill-payment request is successful
- bill_payment_success — Notification when bill-payment
+ request is successful
+ | Parameter | -Data Type | -Description | -Example | -
| txnId | -String | -- Unique identifier for the transaction generated by COU, here - Setu. Also known as BBPS transaction ID. - | -
- AXO101557980
- |
-
| mobileNumber | -String (Number) | -Mobile number used to generate the bill-payment request | -
- 9481773053
- |
-
| status | -String | -Status of the bill-payment request | -
- PAYMENT_SUCCESS
- |
-
| billId | -String | -- Unique identifier for the bill. It is generated by the - biller. Also called as billNumber. Not applicable where - there is no bill. - | -
- dfeeaf14-e43a-4196-90d0-41089e979ad5
- |
-
| billerId | -String | -- Unique identifier (Biller ID in BBPS) allocated to the - Biller - | -
- MAHI00000NATIC
- |
-
| billerName | -String | -Name of the biller as registered with BBPS | -
- Mahindra Rural Housing Finance Ltd
- |
-
| billerCategory | -String | -- Category of the biller as registered with BBPS. There are - more than 25 biller categories. - | -
- Loan-Repayment
- |
-
| sessionId | -String | -Unique identifier for the session used for this request | -
- 7f6de02a-0061-403f-bd65-47d4b5f72c87
- |
-
| customerId | -String | -Unique identifier for the customerId used for this session | -
- cust@1234
- |
-
| billAmount | -String (Number) | -Amount of the bill in rupees (INR) | -
- 601.75
- |
-
| dueDate | -String (Date) | -Due date of the bill. Format is YYYY-MM-DD. | -
- 2023-05-02
- |
-
| amountPaid | -String (Number) | -- Amount paid by the user in rupees (INR). This is especially - applicable for billers where there is no billAmount, eg. - Fastag - | -
- 601.75
- |
-
| orderId | -String | -- Unique identifier for a payment request. Generated by Setu. - | -
- H001234566666
- |
-
| event | -String | -Name of the event to identify this user event | -
- bill_payment_success
- |
-
| paidOn | -String (DateTime) | -Time of transaction | -
- 02-01-2006 15:04:05
- |
-
| refId | -String | -BBPS Reference ID | -
- CMA0I65RCU2I32C3L0H0KNYQYAG40021831
- |
-
| Parameter | +Data Type | +Description | +Example | +
| txnId | +String | ++ Unique identifier for the transaction generated by COU, here Setu. + Also known as BBPS transaction ID. + | +
+ AXO101557980
+ |
+
| mobileNumber | +String (Number) | +Mobile number used to generate the bill-payment request | +
+ 9481773053
+ |
+
| status | +String | +Status of the bill-payment request | +
+ PAYMENT_SUCCESS
+ |
+
| billId | +String | ++ Unique identifier for the bill. It is generated by the biller. Also + called as billNumber. Not applicable where there is no bill. + | +
+ dfeeaf14-e43a-4196-90d0-41089e979ad5
+ |
+
| billerId | +String | +Unique identifier (Biller ID in BBPS) allocated to the Biller | +
+ MAHI00000NATIC
+ |
+
| billerName | +String | +Name of the biller as registered with BBPS | +
+ Mahindra Rural Housing Finance Ltd
+ |
+
| billerCategory | +String | ++ Category of the biller as registered with BBPS. There are more than 25 + biller categories. + | +
+ Loan-Repayment
+ |
+
| sessionId | +String | +Unique identifier for the session used for this request | +
+ 7f6de02a-0061-403f-bd65-47d4b5f72c87
+ |
+
| customerId | +String | +Unique identifier for the customerId used for this session | +
+ cust@1234
+ |
+
| billAmount | +String (Number) | +Amount of the bill in rupees (INR) | +
+ 601.75
+ |
+
| dueDate | +String (Date) | +Due date of the bill. Format is YYYY-MM-DD. | +
+ 2023-05-02
+ |
+
| amountPaid | +String (Number) | ++ Amount paid by the user in rupees (INR). This is especially applicable + for billers where there is no billAmount, eg. Fastag + | +
+ 601.75
+ |
+
| orderId | +String | +Unique identifier for a payment request. Generated by Setu. | +
+ H001234566666
+ |
+
| event | +String | +Name of the event to identify this user event | +
+ bill_payment_success
+ |
+
| paidOn | +String (DateTime) | +Time of transaction | +
+ 02-01-2006 15:04:05
+ |
+
| refId | +String | +BBPS Reference ID | +
+ CMA0I65RCU2I32C3L0H0KNYQYAG40021831
+ |
+
bill_payment_failure — Notification when
- bill-payment request is not successful
- bill_payment_failure — Notification when bill-payment
+ request is not successful
+ | Parameter | -Data Type | -Description | -Example | -
| txnId | -String | -- Unique identifier for the transaction generated by COU, here - Setu. Also known as BBPS transaction ID. - | -
- AX0101557980
- |
-
| mobileNumber | -String (Number) | -Mobile number used to generate the bill-payment request | -
- 9481773053
- |
-
| status | -String | -Status of the bill-payment request | -
- PAYMENT_FAILED
- |
-
| billId | -String | -- Unique identifier for the bill. It is generated by the - biller. Also called as billNumber. Not applicable where - there is no bill. - | -
- dfeeaf14-e43a-4196-90d0-41089e979ad5
- |
-
| billerId | -String | -- Unique identifier (Biller ID in BBPS) allocated to the - Biller - | -
- MAHI00000NATIC
- |
-
| billerName | -String | -Name of the biller as registered with BBPS | -
- Mahindra Rural Housing Finance Ltd
- |
-
| billerCategory | -String | -- Category of the biller as registered with BBPS. There are - more than 25 biller categories. - | -
- Loan-Repayment
- |
-
| sessionId | -String | -Unique identifier for the session used for this request | -
- 7f6de02a-0061-403f-bd65-47d4b5f72c87
- |
-
| customerId | -String | -Unique identifier for the customerId used for this session | -
- cust@1234
- |
-
| orderId | -String | -- Unique identifier for a payment request. Generated by Setu. - | -
- Q00ABCDEFGHZOQ
- |
-
| billAmount | -String (Number) | -Amount of the bill in rupees (INR) | -
- 101.55
- |
-
| dueDate | -String (Date) | -Due date of the bill. Format is YYYY-MM-DD. | -
- 2023-05-02
- |
-
| amountPaid | -String (Number) | -- Amount paid by the user in rupees (INR). This is applicable - for billers where there is no bill generated, eg. Fastag - | -
- 601.75
- |
-
| event | -String | -Name of the event to identify this user event | -
- bill_payment_failure
- |
-
| refId | -String | -BBPS Reference ID | -
- CMA0I65RCU2I32C3L0H0KNYQYAG40021831
- |
-
| Parameter | +Data Type | +Description | +Example | +
| txnId | +String | ++ Unique identifier for the transaction generated by COU, here Setu. + Also known as BBPS transaction ID. + | +
+ AX0101557980
+ |
+
| mobileNumber | +String (Number) | +Mobile number used to generate the bill-payment request | +
+ 9481773053
+ |
+
| status | +String | +Status of the bill-payment request | +
+ PAYMENT_FAILED
+ |
+
| billId | +String | ++ Unique identifier for the bill. It is generated by the biller. Also + called as billNumber. Not applicable where there is no bill. + | +
+ dfeeaf14-e43a-4196-90d0-41089e979ad5
+ |
+
| billerId | +String | +Unique identifier (Biller ID in BBPS) allocated to the Biller | +
+ MAHI00000NATIC
+ |
+
| billerName | +String | +Name of the biller as registered with BBPS | +
+ Mahindra Rural Housing Finance Ltd
+ |
+
| billerCategory | +String | ++ Category of the biller as registered with BBPS. There are more than 25 + biller categories. + | +
+ Loan-Repayment
+ |
+
| sessionId | +String | +Unique identifier for the session used for this request | +
+ 7f6de02a-0061-403f-bd65-47d4b5f72c87
+ |
+
| customerId | +String | +Unique identifier for the customerId used for this session | +
+ cust@1234
+ |
+
| orderId | +String | +Unique identifier for a payment request. Generated by Setu. | +
+ Q00ABCDEFGHZOQ
+ |
+
| billAmount | +String (Number) | +Amount of the bill in rupees (INR) | +
+ 101.55
+ |
+
| dueDate | +String (Date) | +Due date of the bill. Format is YYYY-MM-DD. | +
+ 2023-05-02
+ |
+
| amountPaid | +String (Number) | ++ Amount paid by the user in rupees (INR). This is applicable for + billers where there is no bill generated, eg. Fastag + | +
+ 601.75
+ |
+
| event | +String | +Name of the event to identify this user event | +
+ bill_payment_failure
+ |
+
| refId | +String | +BBPS Reference ID | +
+ CMA0I65RCU2I32C3L0H0KNYQYAG40021831
+ |
+
bill_collection_failure — Notification when
- bill-collection from the user's account is not successful
- bill_collection_failure — Notification when bill-collection
+ from the user's account is not successful
+ | Parameter | -Data Type | -Description | -Example | -
| txnId | -- | - Unique identifier for the transaction generated by COU. Not - generated here because Setu does not post the bill-payment - request to BBPS. - | -
- null
- |
-
| mobileNumber | -String (Number) | -Mobile number used to generate the bill-payment request | -
- 9481773053
- |
-
| status | -String | -Status of the bill-payment request | -
- COLLECTION_FAILURE
- |
-
| billId | -String | -- Unique identifier for the bill. It is generated by the - biller. Also called as billNumber. Not applicable where - there is no bill. - | -
- dfeeaf14-e43a-4196-90d0-41089e979ad5
- |
-
| billerId | -String | -- Unique identifier (Biller ID in BBPS) allocated to the - Biller - | -
- MAHI00000NATIC
- |
-
| billerName | -String | -Name of the biller as registered with BBPS | -
- Mahindra Rural Housing Finance Ltd
- |
-
| billerCategory | -String | -- Category of the biller as registered with BBPS. There are - more than 25 biller categories. - | -
- Loan-Repayment
- |
-
| billAmount | -String (Number) | -Amount of the bill in rupees (INR) | -
- 101.55
- |
-
| dueDate | -String (Date) | -Due date of the bill. Format is YYYY-MM-DD. | -
- 2023-05-02
- |
-
| sessionId | -String | -Unique identifier for the session used for this request | -
- 7f6de02a-0061-403f-bd65-47d4b5f72c87
- |
-
| customerId | -String | -Unique identifier for the customerId used for this session | -
- cust@1234
- |
-
| amountPaid | -String (Number) | -- Amount paid by the user in rupees (INR). This is applicable - for billers where there is no bill generated, eg. Fastag. - Will be null for this event. - | -
- 601.75
- |
-
| amount | -- | - |
- null
- |
-
| event | -String | -Name of the event to identify this user event | -
- bill_collection_failure
- |
-
| refId | -String | -BBPS Reference ID | -
- CMA0I65RCU2I32C3L0H0KNYQYAG40021831
- |
-
| Parameter | +Data Type | +Description | +Example | +
| txnId | ++ | + Unique identifier for the transaction generated by COU. Not generated + here because Setu does not post the bill-payment request to BBPS. + | +
+ null
+ |
+
| mobileNumber | +String (Number) | +Mobile number used to generate the bill-payment request | +
+ 9481773053
+ |
+
| status | +String | +Status of the bill-payment request | +
+ COLLECTION_FAILURE
+ |
+
| billId | +String | ++ Unique identifier for the bill. It is generated by the biller. Also + called as billNumber. Not applicable where there is no bill. + | +
+ dfeeaf14-e43a-4196-90d0-41089e979ad5
+ |
+
| billerId | +String | +Unique identifier (Biller ID in BBPS) allocated to the Biller | +
+ MAHI00000NATIC
+ |
+
| billerName | +String | +Name of the biller as registered with BBPS | +
+ Mahindra Rural Housing Finance Ltd
+ |
+
| billerCategory | +String | ++ Category of the biller as registered with BBPS. There are more than 25 + biller categories. + | +
+ Loan-Repayment
+ |
+
| billAmount | +String (Number) | +Amount of the bill in rupees (INR) | +
+ 101.55
+ |
+
| dueDate | +String (Date) | +Due date of the bill. Format is YYYY-MM-DD. | +
+ 2023-05-02
+ |
+
| sessionId | +String | +Unique identifier for the session used for this request | +
+ 7f6de02a-0061-403f-bd65-47d4b5f72c87
+ |
+
| customerId | +String | +Unique identifier for the customerId used for this session | +
+ cust@1234
+ |
+
| amountPaid | +String (Number) | ++ Amount paid by the user in rupees (INR). This is applicable for + billers where there is no bill generated, eg. Fastag. Will be null for + this event. + | +
+ 601.75
+ |
+
| amount | ++ | + |
+ null
+ |
+
| event | +String | +Name of the event to identify this user event | +
+ bill_collection_failure
+ |
+
| refId | +String | +BBPS Reference ID | +
+ CMA0I65RCU2I32C3L0H0KNYQYAG40021831
+ |
+
bill_payment_refunded — Notification when
- bill-payment has to be refunded. This event is invoked when
- bill-payment request to BBPS has failed, after collection of
- funds from the user.
- bill_payment_refunded — Notification when bill-payment has
+ to be refunded. This event is invoked when bill-payment request to BBPS
+ has failed, after collection of funds from the user.
+ | Parameter | -Data Type | -Description | -Example | -
| txnId | -String | -Unique identifier for the transaction generated by COU. | -
- AX0101557980
- |
-
| mobileNumber | -String (Number) | -Mobile number used to generate the bill-payment request | -
- 9481773053
- |
-
| status | -String | -Status of the bill-payment request | -
- PAYMENT_REFUNDED
- |
-
| billId | -String | -- Unique identifier for the bill. It is generated by the - biller. Also called as billNumber - | -
- dfeeaf14-e43a-4196-90d0-41089e979ad5
- |
-
| billerId | -String | -- Unique identifier (Biller ID in BBPS) allocated to the - Biller - | -
- MAHI00000NATIC
- |
-
| billerName | -String | -Name of the biller as registered with BBPS | -
- Mahindra Rural Housing Finance Ltd
- |
-
| billerCategory | -String | -- Category of the biller as registered with BBPS. There are - more than 25 biller categories. - | -
- Loan-Repayment
- |
-
| sessionId | -String | -Unique identifier for the session used for this request | -
- 7f6de02a-0061-403f-bd65-47d4b5f72c87
- |
-
| customerId | -String | -Unique identifier for the customerId used for this session | -
- cust@1234
- |
-
| billAmount | -String (Number) | -Amount of the bill in rupees (INR) | -
- 601.75
- |
-
| dueDate | -String (Date) | -Due date of the bill. Format is YYYY-MM-DD. | -
- 2023-05-02
- |
-
| orderId | -String | -- Unique identifier for a payment request. Generated by Setu. - | -
- H001234566666
- |
-
| amountPaid | -String (Number) | -- Amount paid by the user in rupees (INR). This is applicable - for billers where there is no bill generated, eg. Fastag - | -
- 601.75
- |
-
| event | -String | -Status to identify this user event | -
- bill_payment_refunded
- |
-
| refId | -String | -BBPS Reference ID | -
- CMA0I65RCU2I32C3L0H0KNYQYAG40021831
- |
-
| Parameter | +Data Type | +Description | +Example | +
| txnId | +String | +Unique identifier for the transaction generated by COU. | +
+ AX0101557980
+ |
+
| mobileNumber | +String (Number) | +Mobile number used to generate the bill-payment request | +
+ 9481773053
+ |
+
| status | +String | +Status of the bill-payment request | +
+ PAYMENT_REFUNDED
+ |
+
| billId | +String | ++ Unique identifier for the bill. It is generated by the biller. Also + called as billNumber + | +
+ dfeeaf14-e43a-4196-90d0-41089e979ad5
+ |
+
| billerId | +String | +Unique identifier (Biller ID in BBPS) allocated to the Biller | +
+ MAHI00000NATIC
+ |
+
| billerName | +String | +Name of the biller as registered with BBPS | +
+ Mahindra Rural Housing Finance Ltd
+ |
+
| billerCategory | +String | ++ Category of the biller as registered with BBPS. There are more than 25 + biller categories. + | +
+ Loan-Repayment
+ |
+
| sessionId | +String | +Unique identifier for the session used for this request | +
+ 7f6de02a-0061-403f-bd65-47d4b5f72c87
+ |
+
| customerId | +String | +Unique identifier for the customerId used for this session | +
+ cust@1234
+ |
+
| billAmount | +String (Number) | +Amount of the bill in rupees (INR) | +
+ 601.75
+ |
+
| dueDate | +String (Date) | +Due date of the bill. Format is YYYY-MM-DD. | +
+ 2023-05-02
+ |
+
| orderId | +String | +Unique identifier for a payment request. Generated by Setu. | +
+ H001234566666
+ |
+
| amountPaid | +String (Number) | ++ Amount paid by the user in rupees (INR). This is applicable for + billers where there is no bill generated, eg. Fastag + | +
+ 601.75
+ |
+
| event | +String | +Status to identify this user event | +
+ bill_payment_refunded
+ |
+
| refId | +String | +BBPS Reference ID | +
+ CMA0I65RCU2I32C3L0H0KNYQYAG40021831
+ |
+
dispute_raised — Notification when
- dispute/complaint is raised from the user
- dispute_raised — Notification when dispute/complaint is
+ raised from the user
+ | Parameter | -Data Type | -Description | -Example | -
| txnId | -String | -- Unique identifier for the transaction generated by COU, here - Setu. Also known as BBPS transaction ID. - | -
- AX0198058515
- |
-
| txnDate | -String (Date) | -Date of the transaction. Format is YYYY-MM-DD. | -
- 2021-06-24
- |
-
| issueType | -String | -- |
- 1
- |
-
| description | -String | -Description as entered by the user. | -
- Message entered by the user
- |
-
| mobileNumber | -String (Number) | -Mobile number used to generate the dispute | -
- 8971302465
- |
-
| referenceId | -String | -- Unique identifer for the dispute raised, generated by Setu. - | -
- ksyTnYVLor/YQ6IRBxzbYp88LuknxVT/2021-06-24
- |
-
| status | -String | -Status of the dispute | -
- submitted
- |
-
| event | -String | -Status to identify this user event | -
- dispute_raised
- |
-
| refId | -String | -BBPS Reference ID | -
- CMA0I65RCU2I32C3L0H0KNYQYAG40021831
- |
-
| Parameter | +Data Type | +Description | +Example | +
| txnId | +String | ++ Unique identifier for the transaction generated by COU, here Setu. + Also known as BBPS transaction ID. + | +
+ AX0198058515
+ |
+
| txnDate | +String (Date) | +Date of the transaction. Format is YYYY-MM-DD. | +
+ 2021-06-24
+ |
+
| issueType | +String | ++ |
+ 1
+ |
+
| description | +String | +Description as entered by the user. | +
+ Message entered by the user
+ |
+
| mobileNumber | +String (Number) | +Mobile number used to generate the dispute | +
+ 8971302465
+ |
+
| referenceId | +String | +Unique identifer for the dispute raised, generated by Setu. | +
+ ksyTnYVLor/YQ6IRBxzbYp88LuknxVT/2021-06-24
+ |
+
| status | +String | +Status of the dispute | +
+ submitted
+ |
+
| event | +String | +Status to identify this user event | +
+ dispute_raised
+ |
+
| refId | +String | +BBPS Reference ID | +
+ CMA0I65RCU2I32C3L0H0KNYQYAG40021831
+ |
+
dispute_status_change — Notification when the
- status of a dispute has changed
- dispute_status_change — Notification when the status of a
+ dispute has changed
+ | Parameter | -Data Type | -Description | -Example | -
| txnId | -String | -- Unique identifier for the transaction generated by COU, here - Setu. Also known as BBPS transaction ID. - | -
- AX0198058515
- |
-
| txnDate | -String (Date) | -Date of the transaction. Format is YYYY-MM-DD. | -
- 2023-05-02
- |
-
| issueType | -String | -- |
- 1
- |
-
| description | -String | -Description as entered by the user. | -
- Message entered by the user
- |
-
| mobileNumber | -String (Number) | -Mobile number used to generate the dispute | -
- 8971302465
- |
-
| referenceId | -String | -- Unique identifer for the dispute raised, generated by Setu. - | -
- ksyTnYVLor/YQ6IRBxzbYp88LuknxVT/2021-06-24
- |
-
| status | -String | -Status of the dispute | -
- closed/unknown
- |
-
| event | -String | -Status to identify this user event | -
- dispute_status_change
- |
-
| refId | -String | -BBPS Reference ID | -
- CMA0I65RCU2I32C3L0H0KNYQYAG40021831
- |
-
| Parameter | +Data Type | +Description | +Example | +
| txnId | +String | ++ Unique identifier for the transaction generated by COU, here Setu. + Also known as BBPS transaction ID. + | +
+ AX0198058515
+ |
+
| txnDate | +String (Date) | +Date of the transaction. Format is YYYY-MM-DD. | +
+ 2023-05-02
+ |
+
| issueType | +String | ++ |
+ 1
+ |
+
| description | +String | +Description as entered by the user. | +
+ Message entered by the user
+ |
+
| mobileNumber | +String (Number) | +Mobile number used to generate the dispute | +
+ 8971302465
+ |
+
| referenceId | +String | +Unique identifer for the dispute raised, generated by Setu. | +
+ ksyTnYVLor/YQ6IRBxzbYp88LuknxVT/2021-06-24
+ |
+
| status | +String | +Status of the dispute | +
+ closed/unknown
+ |
+
| event | +String | +Status to identify this user event | +
+ dispute_status_change
+ |
+
| refId | +String | +BBPS Reference ID | +
+ CMA0I65RCU2I32C3L0H0KNYQYAG40021831
+ |
+