Skip to content

Commit 6df5b4e

Browse files
GnaneshKunaladitya-67
GnaneshKunal
and
aditya-67
authored
Add COU v2 docs (#211)
* Add COU v2 docs * Fix v2 billpay spec * Update menu items --------- Co-authored-by: Aditya Gannavarapu <adityagannavarapu.67@gmail.com>
1 parent 5a13704 commit 6df5b4e

File tree

7 files changed

+1282
-1318
lines changed

7 files changed

+1282
-1318
lines changed

‎content/menuItems.json

+1-1
Large diffs are not rendered by default.

‎content/payments/billpay/v1/api-integration/apis.mdx

+75-73
Original file line numberDiff line numberDiff line change
@@ -22,22 +22,22 @@ The <a href="/payments/billpay/api-integration/api-reference#/category~Fetch_bil
2222
For e.g., if your customer wants to pay their phone bill for Vodafone Postpaid, you will need to provide—
2323

2424
<ul>
25-
<li>
26-
<p>the customer’s identifier (mobile number in this case)</p>
27-
</li>
28-
<li>
29-
<p>the business’s identifier (BBPS ID for Vodafone, in this case)</p>
30-
</li>
25+
<li>
26+
<p>the customer’s identifier (mobile number in this case)</p>
27+
</li>
28+
<li>
29+
<p>the business’s identifier (BBPS ID for Vodafone, in this case)</p>
30+
</li>
3131
</ul>
3232

3333
<Card padding="nano" shape="rounded">
34-
<details>
35-
<summary>
36-
<Text as="h6" marginBottom="none" marginTop="none">
37-
Detailed sample request body
38-
</Text>
39-
</summary>
40-
<CodeBlockWithCopy language="json">{`
34+
<details>
35+
<summary>
36+
<Text as="h6" marginBottom="none" marginTop="none">
37+
Detailed sample request body
38+
</Text>
39+
</summary>
40+
<CodeBlockWithCopy language="json">{`
4141
{
4242
"customer": {
4343
"mobile": "9505987798",
@@ -75,7 +75,7 @@ For e.g., if your customer wants to pay their phone bill for Vodafone Postpaid,
7575
}
7676
}
7777
`}</CodeBlockWithCopy>
78-
</details>
78+
</details>
7979
</Card>
8080

8181
<br />
@@ -103,13 +103,13 @@ You may also use the `/bbps/bills/fetch/response` endpoint with above `refId` to
103103
In the response you either get the bill details, or “Processing” status if the bill fetch is still in progress.
104104

105105
<Card padding="nano" shape="rounded">
106-
<details>
107-
<summary>
108-
<Text as="h6" marginBottom="none" marginTop="none">
109-
Sample response
110-
</Text>
111-
</summary>
112-
<CodeBlockWithCopy language="json">{`
106+
<details>
107+
<summary>
108+
<Text as="h6" marginBottom="none" marginTop="none">
109+
Sample response
110+
</Text>
111+
</summary>
112+
<CodeBlockWithCopy language="json">{`
113113
{
114114
"data": {
115115
"additionalInfo": [
@@ -215,12 +215,11 @@ In the response you either get the bill details, or “Processing” status if t
215215
"traceId": "C51JQCUD608P36RN28H0"
216216
}
217217
`}</CodeBlockWithCopy>
218-
</details>
218+
</details>
219219
</Card>
220220

221221
<hr class="tertiary" />
222222

223-
224223
<hr class="primary" />
225224

226225
### Pay bill
@@ -239,56 +238,59 @@ The <a href="/payments/billpay/api-integration/api-reference#/category~Manage_Di
239238

240239
For your convenience, Setu also provides actions to list data in bulk, that can come in handy for keeping your systems up to date with the latest data. The following APIs are available—
241240

242-
- <a
243-
target="_blank"
244-
href="/payments/billpay/api-integration/api-reference#/category~Take_bulk_actions/operation~getCategories"
245-
>
246-
List categories
247-
</a>
248-
—lists all categories on BBPS.
249-
- <a
250-
target="_blank"
251-
href="/payments/billpay/api-integration/api-reference#/category~Take_bulk_actions/operation~getBillers"
252-
>
253-
List billers
254-
</a>
255-
—lists all billers on BBPS.
256-
- <a
257-
target="_blank"
258-
href="/payments/billpay/api-integration/api-reference#/category~Take_bulk_actions/operation~getDisputes"
259-
>
260-
List disputes
261-
</a>
262-
—lists all the raised disputes using the <a
263-
target="_blank"
264-
href="/payments/billpay/api-integration/api-reference#/category~Manage_Dispute/operation~DisputeRequest"
265-
>
266-
Dispute API
267-
</a>.
268-
- <a
269-
target="_blank"
270-
href="/payments/billpay/api-integration/api-reference#/category~Take_bulk_actions/operation~getFetchedBills"
271-
>
272-
List fetched Bills
273-
</a>
274-
—lists all the fetched bills that were fetched using <a
275-
target="_blank"
276-
href="/payments/billpay/api-integration/api-reference#/category~Fetch_bill/operation~FetchRequest"
277-
>
278-
Fetch API
279-
</a>.
280-
- <a
281-
target="_blank"
282-
href="/payments/billpay/api-integration/api-reference#/category~Take_bulk_actions/operation~getTxns"
283-
>
284-
List paid bills
285-
</a>
286-
—lists all the bill pay transactions paid using <a
287-
target="_blank"
288-
href="/payments/billpay/api-integration/api-reference#/category~Pay_bill/operation~PaymentRequest"
289-
>
290-
Pay API
291-
</a>.
241+
- <a
242+
target="_blank"
243+
href="/payments/billpay/api-integration/api-reference#/category~Take_bulk_actions/operation~getCategories"
244+
>
245+
List categories
246+
</a>
247+
—lists all categories on BBPS.
248+
- <a
249+
target="_blank"
250+
href="/payments/billpay/api-integration/api-reference#/category~Take_bulk_actions/operation~getBillers"
251+
>
252+
List billers
253+
</a>
254+
—lists all billers on BBPS.
255+
- <a
256+
target="_blank"
257+
href="/payments/billpay/api-integration/api-reference#/category~Take_bulk_actions/operation~getDisputes"
258+
>
259+
List disputes
260+
</a>
261+
—lists all the raised disputes using the <a
262+
target="_blank"
263+
href="/payments/billpay/api-integration/api-reference#/category~Manage_Dispute/operation~DisputeRequest"
264+
>
265+
Dispute API
266+
</a>
267+
.
268+
- <a
269+
target="_blank"
270+
href="/payments/billpay/api-integration/api-reference#/category~Take_bulk_actions/operation~getFetchedBills"
271+
>
272+
List fetched Bills
273+
</a>
274+
—lists all the fetched bills that were fetched using <a
275+
target="_blank"
276+
href="/payments/billpay/api-integration/api-reference#/category~Fetch_bill/operation~FetchRequest"
277+
>
278+
Fetch API
279+
</a>
280+
.
281+
- <a
282+
target="_blank"
283+
href="/payments/billpay/api-integration/api-reference#/category~Take_bulk_actions/operation~getTxns"
284+
>
285+
List paid bills
286+
</a>
287+
—lists all the bill pay transactions paid using <a
288+
target="_blank"
289+
href="/payments/billpay/api-integration/api-reference#/category~Pay_bill/operation~PaymentRequest"
290+
>
291+
Pay API
292+
</a>
293+
.
292294

293295
<hr class="primary" />
294296

‎content/payments/billpay/v1/api-integration/objects.mdx

+6-5
Original file line numberDiff line numberDiff line change
@@ -382,6 +382,7 @@ Maxium amount accepted by the biller for the [Payment Channel](#payment-channel)
382382
| plans | [Biller-Plan-Information](#biller-plan-information)`[]` | Plans provided by the biller. |
383383
| enforcesSameDayFetchPay | `bool` | Whether the biller requires bill payment to be on the same calendar day as bill fetch. |
384384
| bbpsUpdateTimestamp | `date-time` | Last updated date-time of the Biller accurate to the nearest day. |
385+
385386
<hr class="primary" />
386387

387388
## Dispute Request
@@ -420,11 +421,11 @@ Maxium amount accepted by the biller for the [Payment Channel](#payment-channel)
420421

421422
### Request Body
422423

423-
| parameter | type | description |
424-
| --------- | --------------------- | ------------------------------------------------------------------- |
425-
| customer | [Customer](#customer) | Customer Object |
426-
| biller | [Biller](#biller) | Biller Object |
427-
| Agent | [Agent](#agent) | Agent Object |
424+
| parameter | type | description |
425+
| --------- | --------------------- | --------------- |
426+
| customer | [Customer](#customer) | Customer Object |
427+
| biller | [Biller](#biller) | Biller Object |
428+
| Agent | [Agent](#agent) | Agent Object |
428429

429430
<hr class="primary" />
430431

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

+61-64
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,43 +138,40 @@ 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 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+
.{" "}
160160
</Callout>
161161

162162
<br />
163163

164164
<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—,
165+
Here is a{" "}
166+
<a href="https://billpay.setu.co/10285899791456" target="_blank">
167+
BBPS-compliant UX flow
168+
</a>{" "}
169+
and a quick summary of BBPS guidelines to keep in mind—,
173170
</p>
174171

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

179176
<hr class="primary" />
180177

@@ -183,8 +180,8 @@ The screens you build as part of your app needs to conform to BBPS guidelines. Y
183180
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.
184181

185182
<Callout type="warning">
186-
Postman logs not considered valid. Share results only once screen
187-
integration is complete.{" "}
183+
Postman logs not considered valid. Share results only once screen integration
184+
is complete.{" "}
188185
</Callout>
189186

190187
<hr class="primary" />

0 commit comments

Comments
 (0)