Skip to content

Commit 79eddc5

Browse files
author
tanmay
committed
update references to api and webhook
1 parent f4eb218 commit 79eddc5

File tree

2 files changed

+24
-15
lines changed

2 files changed

+24
-15
lines changed

content/payments/billpay/api-integration/upms.mdx

+14-14
Original file line numberDiff line numberDiff line change
@@ -121,10 +121,9 @@ You must set up and provide us with a secure HTTPS webhook endpoint URL. This en
121121

122122
### 3.1 Creating a Registration (Combined with Bill Fetch)
123123

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.
125125

126-
**Endpoint:** `POST /api/v2/bbps/bills/fetch/request`
127-
[See standard Bill Fetch API Reference](/content/payments/billpay/api-integration/apis.mdx#fetch-bill)
126+
**Endpoint:** `POST /api/v2/bbps/bills/fetch/request` <a href="/payments/billpay/api-integration/api-reference#/category~Fetch/operation~FetchRequestV2">(See API Reference)</a>
128127

129128
**Type:** Asynchronous
130129

@@ -274,7 +273,7 @@ Two independent callbacks can be triggered following this API call:
274273

275274
- **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.
276275

277-
**`CREATE_UPMS_REGISTRATION` Callback:**
276+
**`CREATE_UPMS_REGISTRATION` Callback:** <a href="/payments/billpay/api-integration/webhooks#create-upms-registration-webhook">(See Webhook Reference)</a>
278277

279278
- **Event Type:** `event: "CREATE_UPMS_REGISTRATION"`
280279
- **Timestamp:** `timeStamp` (ISO 8601 format)
@@ -415,7 +414,7 @@ Two independent callbacks can be triggered following this API call:
415414

416415
This synchronous endpoint allows you to retrieve the current status and details of a specific, existing UPMS registration immediately.
417416

418-
**Endpoint:** `GET /api/v2/upms/registrations/{upmsRegistrationRefID}`
417+
**Endpoint:** `GET /api/v2/upms/registrations/{upmsRegistrationRefID}` <a href="/payments/billpay/api-integration/api-reference#/category~UPMS/operation~ViewUPMSRegistration">(See API Reference)</a>
419418

420419
**Purpose:** To check the details and current status of a UPMS registration.
421420

@@ -559,7 +558,7 @@ This synchronous endpoint allows you to retrieve the current status and details
559558

560559
This asynchronous endpoint allows modification of certain fields of an active UPMS registration.
561560

562-
**Endpoint:** `PATCH /api/v2/upms/registrations/{upmsRegistrationRefID}`
561+
**Endpoint:** `PATCH /api/v2/upms/registrations/{upmsRegistrationRefID}` <a href="/payments/billpay/api-integration/api-reference#/category~UPMS/operation~UpdateUPMSRegistration">(See API Reference)</a>
563562

564563
**Purpose:** To modify specific details of an existing, active UPMS registration.
565564

@@ -698,7 +697,7 @@ Confirms receipt and basic validation of the update request.
698697

699698
You will receive an `UPDATE_UPMS_REGISTRATION` callback with the final outcome.
700699

701-
**`UPDATE_UPMS_REGISTRATION` Callback:**
700+
**`UPDATE_UPMS_REGISTRATION` Callback:** <a href="/payments/billpay/api-integration/webhooks#update-upms-registration-webhook">(See Webhook Reference)</a>
702701

703702
- **Event Type:** `event: "UPDATE_UPMS_REGISTRATION"`
704703
- **Timestamp:** `timeStamp`
@@ -801,7 +800,7 @@ You will receive an `UPDATE_UPMS_REGISTRATION` callback with the final outcome.
801800

802801
This asynchronous endpoint permanently cancels an existing UPMS registration.
803802

804-
**Endpoint:** `DELETE /api/v2/upms/registrations/{upmsRegistrationRefID}`
803+
**Endpoint:** `DELETE /api/v2/upms/registrations/{upmsRegistrationRefID}` <a href="/payments/billpay/api-integration/api-reference#/category~UPMS/operation~CancelUPMSRegistration">(See API Reference)</a>
805804

806805
**Purpose:**
807806

@@ -934,7 +933,7 @@ Confirms receipt of the cancellation request.
934933

935934
You will receive a `CANCEL_UPMS_REGISTRATION` callback confirming the outcome.
936935

937-
**`CANCEL_UPMS_REGISTRATION` Callback Details:**
936+
**`CANCEL_UPMS_REGISTRATION` Callback Details:** <a href="/payments/billpay/api-integration/webhooks#cancel-upms-registration-webhook">(See Webhook Reference)</a>
938937

939938
- **Event Type:** `event: "CANCEL_UPMS_REGISTRATION"`
940939
- **Timestamp:** `timeStamp`
@@ -1022,7 +1021,7 @@ When a new bill is available for a registered customer, the flow is:
10221021
1. **Bill Generation**: The biller generates a new bill for the customer.
10231022
2. **Push to BBPS**: The biller pushes the bill to the BBPS Central Unit.
10241023
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. (<a href="/payments/billpay/api-integration/webhooks#bill-fetch-webhook">See Webhook Reference</a>)
10261025
5. **Your Processing**:
10271026
- Acknowledge with HTTP `200 OK`.
10281027
- Parse the JSON payload.
@@ -1093,7 +1092,7 @@ Note the presence of `upmsRegistrationRefId` indicating this is for a registered
10931092

10941093
When a user opts to pay a presented bill:
10951094

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. (<a href="/payments/billpay/api-integration/api-reference#/category~Pay/operation~PaymentRequestV2">See API Reference</a>)
10971096
2. **Follow Payment Flow**: Handle the response and subsequent steps (e.g., status checks, notifications) as defined in the Payment API documentation.
10981097

10991098
## 6. Handling Skipped Payments
@@ -1102,7 +1101,7 @@ Sometimes, a user might pay a bill through a different channel (e.g., directly o
11021101

11031102
### 6.1 SKIP_PAYMENT Callback Flow
11041103

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: <a href="/payments/billpay/api-integration/webhooks#skip-payment-webhook">(See Webhook Reference)</a>
11061105

11071106
1. **Payment Elsewhere**: User pays via another BBPS channel.
11081107
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
11731172

11741173
This asynchronous API allows you to manually trigger a `BILL_FETCH` callback for a specific, active UPMS registration.
11751174

1176-
**Endpoint:** `POST /api/v2/upms/simulate/{upmsRegistrationRefID}/callbacks/bill`
1175+
**Endpoint:** `POST /api/v2/upms/simulate/{upmsRegistrationRefID}/callbacks/bill` <a href="/payments/billpay/api-integration/api-reference#/category~UPMS/operation~SimulateBillNotification">(See API Reference)</a>
11771176

11781177
**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.
11791178

@@ -1311,7 +1310,7 @@ Shortly after receiving the 200 OK acknowledgment, your configured webhook liste
13111310

13121311
This asynchronous API allows you to manually trigger a `SKIP_PAYMENT` callback for a specific bill reference ID.
13131312

1314-
**Endpoint:** `POST /api/v2/upms/simulate/{billRefId}/callbacks/skip-payment`
1313+
**Endpoint:** `POST /api/v2/upms/simulate/{billRefId}/callbacks/skip-payment` <a href="/payments/billpay/api-integration/api-reference#/category~UPMS/operation~SimulateSkipPaymentNotification">(See API Reference)</a>
13151314

13161315
**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.
13171316

@@ -1459,3 +1458,4 @@ This concludes the guide on integrating with Setu's UPMS APIs.
14591458

14601459
<WasPageHelpful />
14611460

1461+

content/payments/billpay/api-integration/webhooks.mdx

+10-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,8 @@ URL : To be provided by partner`}</CodeBlockWithCopy>
5757
"billerRefId": "9540207519",
5858
"exactness": "Exact",
5959
"refId": "CJLJBQK91PA0FD9MPMK0W75BD9M32391709",
60-
"status": "Success"
60+
"status": "Success",
61+
"upmsRegistrationRefId": "CJLJBQK91PA0FD9MPMK0W75BD9M32391709"
6162
}
6263
}
6364
`}
@@ -458,6 +459,8 @@ URL : To be provided by partner (Registration Callback URL)`}</CodeBlockWithC
458459
</details>
459460
</Card>
460461

462+
<br />
463+
461464
<Card padding="nano" shape="rounded">
462465
<details>
463466
<summary>
@@ -480,6 +483,8 @@ URL : To be provided by partner (Registration Callback URL)`}</CodeBlockWithC
480483
</details>
481484
</Card>
482485

486+
<br />
487+
483488
<Card padding="nano" shape="rounded">
484489
<details>
485490
<summary>
@@ -570,6 +575,8 @@ URL : To be provided by partner (Registration Callback URL)`}</CodeBlockWithC
570575
</details>
571576
</Card>
572577

578+
<br />
579+
573580
<Card padding="nano" shape="rounded">
574581
<details>
575582
<summary>
@@ -630,6 +637,8 @@ URL : To be provided by partner (Registration Callback URL)`}</CodeBlockWithC
630637
</details>
631638
</Card>
632639

640+
<br />
641+
633642
<Card padding="nano" shape="rounded">
634643
<details>
635644
<summary>

0 commit comments

Comments
 (0)