Skip to content

Add COU v2 docs #211

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Nov 18, 2024
Merged

Add COU v2 docs #211

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c14c5b0
Add COU v2 docs
GnaneshKunal Nov 13, 2024
df89ea7
Fix v2 billpay spec
GnaneshKunal Nov 14, 2024
0bc1384
Merge branch 'main' into add-cou-v2-docs
aditya-67 Nov 18, 2024
ecd04e6
Update menu items
aditya-67 Nov 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/menuItems.json
View file
Open in desktop

Large diffs are not rendered by default.

148 changes: 75 additions & 73 deletions content/payments/billpay/v1/api-integration/apis.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,22 +22,22 @@ The <a href="/payments/billpay/api-integration/api-reference#/category~Fetch_bil
For e.g., if your customer wants to pay their phone bill for Vodafone Postpaid, you will need to provide—

<ul>
<li>
<p>the customer’s identifier (mobile number in this case)</p>
</li>
<li>
<p>the business’s identifier (BBPS ID for Vodafone, in this case)</p>
</li>
<li>
<p>the customer’s identifier (mobile number in this case)</p>
</li>
<li>
<p>the business’s identifier (BBPS ID for Vodafone, in this case)</p>
</li>
</ul>

<Card padding="nano" shape="rounded">
<details>
<summary>
<Text as="h6" marginBottom="none" marginTop="none">
Detailed sample request body
</Text>
</summary>
<CodeBlockWithCopy language="json">{`
<details>
<summary>
<Text as="h6" marginBottom="none" marginTop="none">
Detailed sample request body
</Text>
</summary>
<CodeBlockWithCopy language="json">{`
{
"customer": {
"mobile": "9505987798",
Expand Down Expand Up @@ -75,7 +75,7 @@ For e.g., if your customer wants to pay their phone bill for Vodafone Postpaid,
}
}
`}</CodeBlockWithCopy>
</details>
</details>
</Card>

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

<Card padding="nano" shape="rounded">
<details>
<summary>
<Text as="h6" marginBottom="none" marginTop="none">
Sample response
</Text>
</summary>
<CodeBlockWithCopy language="json">{`
<details>
<summary>
<Text as="h6" marginBottom="none" marginTop="none">
Sample response
</Text>
</summary>
<CodeBlockWithCopy language="json">{`
{
"data": {
"additionalInfo": [
Expand Down Expand Up @@ -215,12 +215,11 @@ In the response you either get the bill details, or “Processing” status if t
"traceId": "C51JQCUD608P36RN28H0"
}
`}</CodeBlockWithCopy>
</details>
</details>
</Card>

<hr class="tertiary" />


<hr class="primary" />

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

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—

- <a
target="_blank"
href="/payments/billpay/api-integration/api-reference#/category~Take_bulk_actions/operation~getCategories"
>
List categories
</a>
—lists all categories on BBPS.
- <a
target="_blank"
href="/payments/billpay/api-integration/api-reference#/category~Take_bulk_actions/operation~getBillers"
>
List billers
</a>
—lists all billers on BBPS.
- <a
target="_blank"
href="/payments/billpay/api-integration/api-reference#/category~Take_bulk_actions/operation~getDisputes"
>
List disputes
</a>
—lists all the raised disputes using the <a
target="_blank"
href="/payments/billpay/api-integration/api-reference#/category~Manage_Dispute/operation~DisputeRequest"
>
Dispute API
</a>.
- <a
target="_blank"
href="/payments/billpay/api-integration/api-reference#/category~Take_bulk_actions/operation~getFetchedBills"
>
List fetched Bills
</a>
—lists all the fetched bills that were fetched using <a
target="_blank"
href="/payments/billpay/api-integration/api-reference#/category~Fetch_bill/operation~FetchRequest"
>
Fetch API
</a>.
- <a
target="_blank"
href="/payments/billpay/api-integration/api-reference#/category~Take_bulk_actions/operation~getTxns"
>
List paid bills
</a>
—lists all the bill pay transactions paid using <a
target="_blank"
href="/payments/billpay/api-integration/api-reference#/category~Pay_bill/operation~PaymentRequest"
>
Pay API
</a>.
- <a
target="_blank"
href="/payments/billpay/api-integration/api-reference#/category~Take_bulk_actions/operation~getCategories"
>
List categories
</a>
—lists all categories on BBPS.
- <a
target="_blank"
href="/payments/billpay/api-integration/api-reference#/category~Take_bulk_actions/operation~getBillers"
>
List billers
</a>
—lists all billers on BBPS.
- <a
target="_blank"
href="/payments/billpay/api-integration/api-reference#/category~Take_bulk_actions/operation~getDisputes"
>
List disputes
</a>
—lists all the raised disputes using the <a
target="_blank"
href="/payments/billpay/api-integration/api-reference#/category~Manage_Dispute/operation~DisputeRequest"
>
Dispute API
</a>
.
- <a
target="_blank"
href="/payments/billpay/api-integration/api-reference#/category~Take_bulk_actions/operation~getFetchedBills"
>
List fetched Bills
</a>
—lists all the fetched bills that were fetched using <a
target="_blank"
href="/payments/billpay/api-integration/api-reference#/category~Fetch_bill/operation~FetchRequest"
>
Fetch API
</a>
.
- <a
target="_blank"
href="/payments/billpay/api-integration/api-reference#/category~Take_bulk_actions/operation~getTxns"
>
List paid bills
</a>
—lists all the bill pay transactions paid using <a
target="_blank"
href="/payments/billpay/api-integration/api-reference#/category~Pay_bill/operation~PaymentRequest"
>
Pay API
</a>
.

<hr class="primary" />

Expand Down
11 changes: 6 additions & 5 deletions content/payments/billpay/v1/api-integration/objects.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -382,6 +382,7 @@ Maxium amount accepted by the biller for the [Payment Channel](#payment-channel)
| plans | [Biller-Plan-Information](#biller-plan-information)`[]` | Plans provided by the biller. |
| enforcesSameDayFetchPay | `bool` | Whether the biller requires bill payment to be on the same calendar day as bill fetch. |
| bbpsUpdateTimestamp | `date-time` | Last updated date-time of the Biller accurate to the nearest day. |

<hr class="primary" />

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

### Request Body

| parameter | type | description |
| --------- | --------------------- | ------------------------------------------------------------------- |
| customer | [Customer](#customer) | Customer Object |
| biller | [Biller](#biller) | Biller Object |
| Agent | [Agent](#agent) | Agent Object |
| parameter | type | description |
| --------- | --------------------- | --------------- |
| customer | [Customer](#customer) | Customer Object |
| biller | [Biller](#biller) | Biller Object |
| Agent | [Agent](#agent) | Agent Object |

<hr class="primary" />

Expand Down
125 changes: 61 additions & 64 deletions content/payments/billpay/v1/api-integration/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,16 @@ This page covers how you can integrate with our APIs, develop corresponding scre
### How to integrate

<p>
Use provided{" "}
<a href="/payments/billpay/api-integration/api-reference" target="_blank">
API reference
</a>{" "}
to start integration. Request for a detailed API run through from Setu team,
if needed. Contact us at{" "}
<a href="https://setu.co/support" target="_blank">
Setu Support
</a>
, should you need any help during integration.
Use provided{" "}
<a href="/payments/billpay/api-integration/api-reference" target="_blank">
API reference
</a>{" "}
to start integration. Request for a detailed API run through from Setu team,
if needed. Contact us at{" "}
<a href="https://setu.co/support" target="_blank">
Setu Support
</a>
, should you need any help during integration.
</p>

A summary of the integration process—
Expand Down Expand Up @@ -83,42 +83,42 @@ Reach out to <a href="">onboarding@setu.co</a> 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.

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

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` |

<br />
<br />

<Callout type="tip">
You may also <em>optionally</em> choose to specify custom paths or URLs for{" "}
<code>fetch</code>/<code>validate</code>/<code>payment</code>/
<code>dispute</code> events too.{" "}
<strong>
The URL may be relative (a path, without a host) or absolute (starting
with a scheme)
</strong>
.
<br />
<br />
In case you specify a path, it will get appended to the{" "}
<code>callbackURL</code> value. If you specify a URL, it will simply
override the callback URL value for that particular event.
You may also <em>optionally</em> choose to specify custom paths or URLs for{" "}
<code>fetch</code>/<code>validate</code>/<code>payment</code>/
<code>dispute</code> events too.{" "}
<strong>
The URL may be relative (a path, without a host) or absolute (starting with
a scheme)
</strong>
.
<br />
<br />
In case you specify a path, it will get appended to the{" "}
<code>callbackURL</code> value. If you specify a URL, it will simply override
the callback URL value for that particular event.
</Callout>
&nbsp;

Expand All @@ -138,43 +138,40 @@ Once you have received your API keys and agent ID for testing, you can integrati

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—

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

<Callout type="tip">
You may use the BBPS logo and branding guidelines provided{" "}
<a
href="https://drive.google.com/drive/folders/1CVgy1xuxHKlqnw5BtN4reCaYh13NmGqK?usp=sharing"
target="blank"
>
here
</a>
.{" "}
You may use the BBPS logo and branding guidelines provided{" "}
<a
href="https://drive.google.com/drive/folders/1CVgy1xuxHKlqnw5BtN4reCaYh13NmGqK?usp=sharing"
target="blank"
>
here
</a>
.{" "}
</Callout>

<br />

<p>
Here is a{" "}
<a
href="https://billpay.setu.co/10285899791456"
target="_blank"
>
BBPS-compliant UX flow
</a>{" "}
and a quick summary of BBPS guidelines to keep in mind—,
Here is a{" "}
<a href="https://billpay.setu.co/10285899791456" target="_blank">
BBPS-compliant UX flow
</a>{" "}
and a quick summary of BBPS guidelines to keep in mind—,
</p>

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

<hr class="primary" />

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

<Callout type="warning">
Postman logs not considered valid. Share results only once screen
integration is complete.{" "}
Postman logs not considered valid. Share results only once screen integration
is complete.{" "}
</Callout>

<hr class="primary" />
Expand Down
Loading