You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/payments/billpay/api-integration/upms.mdx
+14-14
Original file line number
Diff line number
Diff line change
@@ -121,10 +121,9 @@ You must set up and provide us with a secure HTTPS webhook endpoint URL. This en
121
121
122
122
### 3.1 Creating a Registration (Combined with Bill Fetch)
123
123
124
-
This process leverages the existing **Bill Fetch API** endpoint (`POST /api/v2/bbps/bills/fetch/request`). To initiate a UPMS registration alongside fetching the current bill (if available), you simply include the `mandate` object in the standard Bill Fetch request.
124
+
This process leverages the existing **Bill Fetch API** endpoint. To initiate a UPMS registration alongside fetching the current bill (if available), you simply include the `mandate` object in the standard Bill Fetch request.
[See standard Bill Fetch API Reference](/content/payments/billpay/api-integration/apis.mdx#fetch-bill)
126
+
**Endpoint:**`POST /api/v2/bbps/bills/fetch/request` <ahref="/payments/billpay/api-integration/api-reference#/category~Fetch/operation~FetchRequestV2">(See API Reference)</a>
128
127
129
128
**Type:** Asynchronous
130
129
@@ -274,7 +273,7 @@ Two independent callbacks can be triggered following this API call:
274
273
275
274
-**Registration Status Callback:** For registrations with initial status as `PENDING`, you will receive a `CREATE_UPMS_REGISTRATION` callback to inform you of the final outcome of the registration attempt identified by `upmsRegistration.refId` from the synchronous response.
**Endpoint:**`GET /api/v2/upms/registrations/{upmsRegistrationRefID}` <ahref="/payments/billpay/api-integration/api-reference#/category~UPMS/operation~ViewUPMSRegistration">(See API Reference)</a>
419
418
420
419
**Purpose:** To check the details and current status of a UPMS registration.
421
420
@@ -559,7 +558,7 @@ This synchronous endpoint allows you to retrieve the current status and details
559
558
560
559
This asynchronous endpoint allows modification of certain fields of an active UPMS registration.
**Endpoint:**`PATCH /api/v2/upms/registrations/{upmsRegistrationRefID}` <ahref="/payments/billpay/api-integration/api-reference#/category~UPMS/operation~UpdateUPMSRegistration">(See API Reference)</a>
563
562
564
563
**Purpose:** To modify specific details of an existing, active UPMS registration.
565
564
@@ -698,7 +697,7 @@ Confirms receipt and basic validation of the update request.
698
697
699
698
You will receive an `UPDATE_UPMS_REGISTRATION` callback with the final outcome.
**Endpoint:**`DELETE /api/v2/upms/registrations/{upmsRegistrationRefID}` <ahref="/payments/billpay/api-integration/api-reference#/category~UPMS/operation~CancelUPMSRegistration">(See API Reference)</a>
805
804
806
805
**Purpose:**
807
806
@@ -934,7 +933,7 @@ Confirms receipt of the cancellation request.
934
933
935
934
You will receive a `CANCEL_UPMS_REGISTRATION` callback confirming the outcome.
@@ -1022,7 +1021,7 @@ When a new bill is available for a registered customer, the flow is:
1022
1021
1.**Bill Generation**: The biller generates a new bill for the customer.
1023
1022
2.**Push to BBPS**: The biller pushes the bill to the BBPS Central Unit.
1024
1023
3.**Notification to COU**: BBPS identifies the UPMS registration and notifies us.
1025
-
4.**Callback to You**: We send a `BILL_FETCH` webhook with the bill details. ([See standard BILL_FETCH Callback Structure](/content/payments/billpay/api-integration/webhooks.mdx#bill-fetch-webhook))
1024
+
4.**Callback to You**: We send a `BILL_FETCH` webhook with the bill details. (<ahref="/payments/billpay/api-integration/webhooks#bill-fetch-webhook">See Webhook Reference</a>)
1026
1025
5.**Your Processing**:
1027
1026
- Acknowledge with HTTP `200 OK`.
1028
1027
- Parse the JSON payload.
@@ -1093,7 +1092,7 @@ Note the presence of `upmsRegistrationRefId` indicating this is for a registered
1093
1092
1094
1093
When a user opts to pay a presented bill:
1095
1094
1096
-
1.**Invoke Payment API**: Construct and send a request to our BBPS Payment API endpoint. ([See Pay Bill API Reference](/content/payments/billpay/api-integration/apis.mdx#pay-bill))
1095
+
1.**Invoke Payment API**: Construct and send a request to our BBPS Payment API endpoint. (<ahref="/payments/billpay/api-integration/api-reference#/category~Pay/operation~PaymentRequestV2">See API Reference</a>)
1097
1096
2.**Follow Payment Flow**: Handle the response and subsequent steps (e.g., status checks, notifications) as defined in the Payment API documentation.
1098
1097
1099
1098
## 6. Handling Skipped Payments
@@ -1102,7 +1101,7 @@ Sometimes, a user might pay a bill through a different channel (e.g., directly o
1102
1101
1103
1102
### 6.1 SKIP_PAYMENT Callback Flow
1104
1103
1105
-
If a bill is paid elsewhere after presentation, you'll receive a `SKIP_PAYMENT` callback:
1104
+
If a bill is paid elsewhere after presentation, you'll receive a `SKIP_PAYMENT` callback: <ahref="/payments/billpay/api-integration/webhooks#skip-payment-webhook">(See Webhook Reference)</a>
1106
1105
1107
1106
1.**Payment Elsewhere**: User pays via another BBPS channel.
1108
1107
2.**Notification to Us**: BBPS detects external payment and informs us.
@@ -1173,7 +1172,7 @@ To facilitate this, we provide Simulation APIs that allow you to manually trigge
1173
1172
1174
1173
This asynchronous API allows you to manually trigger a `BILL_FETCH` callback for a specific, active UPMS registration.
**Endpoint:**`POST /api/v2/upms/simulate/{upmsRegistrationRefID}/callbacks/bill` <ahref="/payments/billpay/api-integration/api-reference#/category~UPMS/operation~SimulateBillNotification">(See API Reference)</a>
1177
1176
1178
1177
**Purpose:** To trigger the delivery of a simulated `BILL_FETCH` callback to your configured webhook endpoint for the specified `upmsRegistrationRefID`. This helps test how your system handles incoming bill presentments.
1179
1178
@@ -1311,7 +1310,7 @@ Shortly after receiving the 200 OK acknowledgment, your configured webhook liste
1311
1310
1312
1311
This asynchronous API allows you to manually trigger a `SKIP_PAYMENT` callback for a specific bill reference ID.
**Endpoint:**`POST /api/v2/upms/simulate/{billRefId}/callbacks/skip-payment` <ahref="/payments/billpay/api-integration/api-reference#/category~UPMS/operation~SimulateSkipPaymentNotification">(See API Reference)</a>
1315
1314
1316
1315
**Purpose:** To trigger the delivery of a simulated `SKIP_PAYMENT` callback to your configured webhook endpoint for the specified `billRefId`. This helps test how your system handles notifications that a bill, previously presented, was paid via another channel.
1317
1316
@@ -1459,3 +1458,4 @@ This concludes the guide on integrating with Setu's UPMS APIs.
0 commit comments