Skip to content

Commit 43c4f23

Browse files
Fix link access issue on COU Quickstart (#204)
* Fix link access issue on COU Quickstart * Update Quickstart --------- Co-authored-by: kavya100491 <kavya@setu.co>
1 parent a27a2fa commit 43c4f23

File tree

1 file changed

+92
-66
lines changed

1 file changed

+92
-66
lines changed

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

+92-66
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,16 @@ This page covers how you can integrate with our APIs, develop corresponding scre
1616
### How to integrate
1717

1818
<p>
19-
Use provided{" "}
20-
<a href="/payments/billpay/api-integration/api-reference" target="_blank">
21-
API reference
22-
</a>{" "}
23-
to start integration. Request for a detailed API run through from Setu team,
24-
if needed. Contact us at{" "}
25-
<a href="https://setu.co/support" target="_blank">
26-
Setu Support
27-
</a>
28-
, should you need any help during integration.
19+
Use provided{" "}
20+
<a href="/payments/billpay/api-integration/api-reference" target="_blank">
21+
API reference
22+
</a>{" "}
23+
to start integration. Request for a detailed API run through from Setu team,
24+
if needed. Contact us at{" "}
25+
<a href="https://setu.co/support" target="_blank">
26+
Setu Support
27+
</a>
28+
, should you need any help during integration.
2929
</p>
3030

3131
A summary of the integration process—
@@ -83,42 +83,42 @@ Reach out to <a href="">onboarding@setu.co</a> to get a list of business details
8383

8484
It is recommended that you set up a callback URL to receive notifications for various types of events, while using—
8585

86-
- APIs to fetch bill for a customer
87-
- APIs to validate customer identifier with a biller
88-
- APIs to for completing a bill payment
89-
- APIs to raise disputes against a payment
90-
- APIs to receive an automatic bill due notification
86+
- APIs to fetch bill for a customer
87+
- APIs to validate customer identifier with a biller
88+
- APIs to for completing a bill payment
89+
- APIs to raise disputes against a payment
90+
- APIs to receive an automatic bill due notification
9191

9292
When this is enabled by you, any successful `fetch`, `validate`, `payment` or `dispute` event gets posted to your callback URL.
9393

9494
You may specify only one callback URL. **This should be a valid URI string that starts with either `https://` or `http://` scheme.**. For e.g., `https://my-billpay-callback.com`.
9595

9696
Setu will append the following default paths to this callback URL, to alert your on specific events—
9797

98-
| Event type | Path |
99-
|-------------------------|-----------------------------|
100-
| `fetch` a bill | `/bills/fetch/response` |
101-
| `validate` bill details | `/bills/validate/response` |
102-
| `payment` of bill | `/bills/payment/response` |
103-
| `dispute` against bill | `/bills/dispute/response` |
98+
| Event type | Path |
99+
| ----------------------- | -------------------------- |
100+
| `fetch` a bill | `/bills/fetch/response` |
101+
| `validate` bill details | `/bills/validate/response` |
102+
| `payment` of bill | `/bills/payment/response` |
103+
| `dispute` against bill | `/bills/dispute/response` |
104104

105105
<br />
106106
<br />
107107

108108
<Callout type="tip">
109-
You may also <em>optionally</em> choose to specify custom paths or URLs for{" "}
110-
<code>fetch</code>/<code>validate</code>/<code>payment</code>/
111-
<code>dispute</code> events too.{" "}
112-
<strong>
113-
The URL may be relative (a path, without a host) or absolute (starting
114-
with a scheme)
115-
</strong>
116-
.
117-
<br />
118-
<br />
119-
In case you specify a path, it will get appended to the{" "}
120-
<code>callbackURL</code> value. If you specify a URL, it will simply
121-
override the callback URL value for that particular event.
109+
You may also <em>optionally</em> choose to specify custom paths or URLs for{" "}
110+
<code>fetch</code>/<code>validate</code>/<code>payment</code>/
111+
<code>dispute</code> events too.{" "}
112+
<strong>
113+
The URL may be relative (a path, without a host) or absolute (starting with
114+
a scheme)
115+
</strong>
116+
.
117+
<br />
118+
<br />
119+
In case you specify a path, it will get appended to the{" "}
120+
<code>callbackURL</code> value. If you specify a URL, it will simply override
121+
the callback URL value for that particular event.
122122
</Callout>
123123
&nbsp;
124124

@@ -138,58 +138,84 @@ Once you have received your API keys and agent ID for testing, you can integrati
138138

139139
The screens you build as part of your app needs to conform to BBPS guidelines. You should submit a document with screenshots for the following screens—
140140

141-
- **Category list screen**, on which all BBPS categories are listed.
142-
- **Biller list screen**, on which all billers under a selected category are listed.
143-
- **Customer input screen**, where a customer enters identifiers specific to a selected biller, before their bill can be fetched.
144-
- **Payment confirmation screen**, on which the customer confirms bill amount and proceeds with payment.
145-
- **Payment status screen**, when payment is being processed and is finally either successful or failed.
146-
- **Confirmation SMS**, this is the text that is sent after a payment is successful or failed.
147-
- **Bill receipt screen**, through which a customer can view and download receipt for a successful transaction.
148-
- **Raise complaint screen**, where a customer can raise complaint. Complaints are raised against specific transaction IDs.
149-
- **Complaint status screen**, where a customer can see the latest status associated with registered complaint.
141+
- **Category list screen**, on which all BBPS categories are listed.
142+
- **Biller list screen**, on which all billers under a selected category are listed.
143+
- **Customer input screen**, where a customer enters identifiers specific to a selected biller, before their bill can be fetched.
144+
- **Payment confirmation screen**, on which the customer confirms bill amount and proceeds with payment.
145+
- **Payment status screen**, when payment is being processed and is finally either successful or failed.
146+
- **Confirmation SMS**, this is the text that is sent after a payment is successful or failed.
147+
- **Bill receipt screen**, through which a customer can view and download receipt for a successful transaction.
148+
- **Raise complaint screen**, where a customer can raise complaint. Complaints are raised against specific transaction IDs.
149+
- **Complaint status screen**, where a customer can see the latest status associated with registered complaint.
150150

151151
<Callout type="tip">
152-
You may use the BBPS logo and branding guidelines provided{" "}
153-
<a
154-
href="https://drive.google.com/drive/folders/1CVgy1xuxHKlqnw5BtN4reCaYh13NmGqK?usp=sharing"
155-
target="blank"
156-
>
157-
here
158-
</a>
159-
.{" "}
152+
You may use the BBPS branding guidelines provided{" "}
153+
<a
154+
href="https://www.bharat-connect.com/assets/images/pages/brand-centre/media-kit/Bharat_Connect_Brand_Guidelines_11-09-24.pdf"
155+
target="blank"
156+
>
157+
here
158+
</a>
159+
. BBPS logo assets can be downloaded <a href="https://www.bharat-connect.com/assets/images/pages/brand-centre/media-kit/Bharat-Connect-MediaKit.zip">
160+
here
161+
</a>.
160162
</Callout>
161163

162164
<br />
163165

164166
<p>
165-
Here is a{" "}
166-
<a
167-
href="https://billpay.setu.co/10285899791456"
168-
target="_blank"
169-
>
170-
BBPS-compliant UX flow
171-
</a>{" "}
172-
and a quick summary of BBPS guidelines to keep in mind—,
167+
Here is a{" "}
168+
<a href="https://setu.co/pay" target="_blank">
169+
BBPS-compliant UX flow
170+
</a>{" "}
171+
and a quick summary of BBPS guidelines to keep in mind—
173172
</p>
174173

175-
- The app / website UI must contain a button for “Pay bills” with the BBPS logo shown.
176-
- 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.
177-
- BBPS assured logo must always be shown on the payment sucessful and payment receipt pages. The regular BBPS logo can be removed from these.
174+
- The app / website UI must contain a button for “Pay bills” with the BBPS logo shown.
175+
- 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.
176+
- BBPS assured logo must always be shown on the payment sucessful and payment receipt pages. The regular BBPS logo can be removed from these.
178177

179178
<hr class="primary" />
180179

181180
### Step 5 — Run and submit test cases
182181

183-
Run test cases mentioned in <a href="https://docs.google.com/spreadsheets/d/1h774FCseJKlxYpB2nflN-ONnmEZQiMoF6Ufpiyz0dxA/edit#gid=0" target="_blank"> this document </a> and submit documented results using a copy of the provided file. The results will verified by Setu and the bank to generate production credentials.
182+
Copy the below table in an Excel or Google sheet and run all test cases. Submit documented results in the same format. The results will verified by Setu and the bank to generate production credentials.
184183

185184
<Callout type="warning">
186-
Postman logs not considered valid. Share results only once screen
187-
integration is complete.{" "}
185+
Postman logs not considered valid. Share results only once screen integration
186+
is complete.{" "}
188187
</Callout>
188+
<br />
189+
190+
| Case ID | Business scenario | Test case description | Positive/Negative | Expected result format | Logs | Result |
191+
| ------- | ----------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ----------------- | -------------------------------------------------------------------------------- | ---- | ------ |
192+
| CL1 | Listing of categories | Call the get categories API. The API will return a list of category codes. | Positive | Attach log file containing URL and response | | |
193+
| BL1 | List of billers in categories | Call the biller list API and make sure you are able to see a list of billers. | Positive | Attach log file containing URL, Request and Response for at least 3 categories | | |
194+
| BL2 | List of billers in categories | Call the biller list API for a category code that does not exist. | Negative | Attach log file containing URL, Request and Response | | |
195+
| BF1 | Bill fetch - step 1 | Call the bill fetch register API. | Positive | Attach log file containing URL, Request and Response | | |
196+
| BF2 | Bill fetch - step 2 | Call the get fetched bill API with the right context from bill fetch register API. Assert that the bill is returned. | Positive | Attach log file containing URL, Request and Response | | |
197+
| BF3 | Bill fetch - step 1 (invalid param) | Call bill fetch API with wrong customer parameters for the biller. This will give error. | Negative | Attach log file containing URL, Request and Response | | |
198+
| BF4 | Bill fetch - step 1 (invalid regex) | Call bill fetch API with wrong customer parameters with invalid regex. This will give error. | Negative | Attach log file containing URL, Request and Response | | |
199+
| BF5 | Bill fetch - ADHOC | Call bill fetch API register and get fetched bill API for DTH. Assert that amount is not returned. | Negative | Attach log file containing URL, Request and Response | | |
200+
| BF6 | Bill fetch - Wrong customer value | Call bill fetch API by entering wrong customer parameter input. Assert that you get an error for invalid customer parameter. | Negative | Attach log file containing URL, Request and Response | | |
201+
| BP1 | Bill payment - step 1 | Call bill payment API for a successful bill fetch. | Positive | Attach log file containing URL, Request and Response | | |
202+
| BP2 | Bill payment - step 2 | Call get payment status API after a successful bill payment. | Positive | Attach log file containing URL, Request and Response | | |
203+
| BP3 | Bill payment - Adhoc - step 1 | Call bill payment API for a successful bill fetch for DTH. | Positive | Attach log file containing URL, Request and Response | | |
204+
| BP4 | Bill payment - Adhoc - step 2 | Call get payment status API after a successful bill payment. | Positive | Attach log file containing URL, Request and Response | | |
205+
| BF7 | Bill fetch for zero amount | Call bill fetch API 1 day after you have made payment. Assert that you get the “no bill due” error. | Negative | Attach log file containing URL, Request and Response | | |
206+
| CT1 | Raise dispute | Call raise complaint API after you have successfully completed payment. | Positive | Attach log file containing URL, Request and Response | | |
207+
| CT2 | Get dispute status | Call complaint status API after you have successfully completed payment. | Positive | Attach log file containing URL, Request and Response | | |
208+
| BD1 | Get biller details | Call the biller details API with a valid biller and category code to see biller fields. | Positive | Attach log file containing URL, Request and Response for at least 3 combinations | | |
209+
| BD2 | Get biller details | Call the biller details API with an invalid biller or category code which does not exist. This will give error. | Negative | Attach log file containing URL, Request and Response for at least 3 combinations | | |
210+
| FD1 | Get biller fields | Call the biller fields API with a valid biller and category code to see biller fields. | Positive | Attach log file containing URL, Request and Response for at least 3 combinations | | |
211+
| FD2 | Get biller fields | Call the biller fields API with an invalid biller or category code which does not exist. This will give error. | Negative | Attach log file containing URL, Request and Response for at least 3 combinations | | |
212+
| AI1 | Amount limitation | Make a payment of Rs. 49999. | Positive | Attach log file containing URL, Request and Response | | |
213+
| AI2 | Amount limitation | Make a payment of Rs. 50000. | Negative | Attach log file containing URL, Request and Response | | |
214+
| AI3 | Amount limitation | Test all payment modes with limits. | Positive | Attach log file containing URL, Request and Response | | |
189215

190216
<hr class="primary" />
191217

192-
#### Step 6 — Get Production credentials and go live
218+
### Step 6 — Get production credentials and go live
193219

194220
You will receive production credentials once all the approvals and agreements are done. On receiving the production credentials, you can verify your integration and go live.
195221

0 commit comments

Comments
 (0)