Skip to content
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.

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

Updating bridge v2 docs #239

Open
wants to merge 3 commits into
base: staging
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
433 changes: 433 additions & 0 deletions content/dev-tools/bridge/analytics-and-reports.mdx

Large diffs are not rendered by default.

66 changes: 66 additions & 0 deletions content/dev-tools/bridge/explore-and-configure-products.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
---
sidebar_title: Explore and configure products
page_title: Bridge explore and configure products
order: 2
visible_in_sidebar: true
---

## Explore and configure products

Use **Home or Product store** to see all the products that you can configure with Setu. Select any one, and start setting up your product integration.

<img src="https://storage.googleapis.com/strapi-assets/latest/bridge-v2-docs/Configure%20products/Product%20Store.png" alt="" />

##### 1. Create a child sub-org account
The first step is to set up a child sub-org account, which contains context about a product category and the organisation that can legally use this product. There are different types of legal entities allowed to use different product categories. For example, you will set up an FIU to use Account Aggregator, or set up a merchant to use UPI products.

<Badge type="tip"> ADDITIONAL INFORMATION </Badge>

While this is rarely needed, you can also create multiple child sub-org accounts for the same product category. This is useful in the following situations:
- If you want to use the same product category for another subsidiary of your parent company, for which fresh KYC is needed.
- If you want to use the same product category but for a different purpose, which results in a change in pricing or other agreements.

<Callout type="tip">Consider creating another product instance for your chosen product before creating a new child sub-org account. This approach helps in easily reusing KYC and other common product details, and it results in a faster review process for the new instance to go live.</Callout>


<img src="https://storage.googleapis.com/strapi-assets/latest/bridge-v2-docs/Configure%20products/create-a-child-sub-org.gif" alt="Creating a sub child organisation" />

##### 2. Set up product instance
Depending on the product you choose, you need to fill in different details to start using the product. At times, our products also allow you to directly use the APIs for our products, by generating test credentials and using the “Product ID” in the `product-instance-id` header field.

Usually, the details you need to fill out for a product instance include the following categories:

- **Basic details** — Basic details required for testing, used on sandbox with test API keys and product ID to authenticate API requests.

- **Production specific details** — Additional details needed, only if you intend to go live with the product. These additional details are used in combination with the basic details used on sandbox, when you eventually go live with the product.

- **KYC details** — Mandatory details as per government regulations, needed and reviewed by Setu only if you intend to go live with a product. These might include PAN, GST, certificates, and other relevant information.

<img src="https://storage.googleapis.com/strapi-assets/latest/bridge-v2-docs/Configure%20products/Setup%20product%20instance.gif" alt="Setup product instance" />

##### 3. Submit all the details
Finally, check and verify all the details you have provided, and submit them. A Setu admin will verify all details and if everything looks good, approve your config. This typically takes 2-5 days and you can start transacting on production after approval.

<img src="https://storage.googleapis.com/strapi-assets/latest/bridge-v2-docs/Configure%20products/configure%20products.gif" alt="Configure products " />

<Badge type="tip">UPI Setu</Badge> &nbsp;
<Badge type="tip">KYC</Badge> &nbsp;
<Badge type="tip">eSign</Badge> &nbsp;
<Badge type="tip">AA Gateway</Badge> &nbsp;
<Badge type="tip">BBPS BillCollect</Badge> &nbsp;
<Badge type="tip">BBPS BillPay</Badge> &nbsp;

##### 4. Edit configurations
You can change the configuration provided before you complete the final step of any configuration, which is reviewing the details you have provided. Once you click on the "submit to go live" button, you will not be able to change the details you have provided for the product. The details will first be reviewed by Setu. Once the review is complete, and if any changes are required, you will be able to edit the steps that remain or require changes.

<img src="https://storage.googleapis.com/strapi-assets/latest/bridge-v2-docs/Configure%20products/Edit%20config.gif" alt="Edit configuration" />

<NextPage
info={{
description: "See how the analytics and reporsts are show on the bridge",
slug: "/dev-tools/bridge/analytics-and-reports",
title: "Analytics and reports",
}}
/>

<WasPageHelpful />
72 changes: 72 additions & 0 deletions content/dev-tools/bridge/glossary.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
---
sidebar_title: Glossary
page_title: Bridge glossary
order: 0
visible_in_sidebar: true
---

## Glossary

### Accounts

This is any organisation using the Bridge, and will always be one of the following types:

| **Account type** | **About** |
|:-------|:------------------------------------------------------------------------|
| **Parent Bridge account** | When you sign up on the Bridge, you provide an organisation name and create an account against it—this becomes the parent account within which you can integrate with multiple Setu products. |
| **Child sub-org account** | Child sub-org accounts always belong to a parent organisation’s account. When you want to use any product, such as KYC, eNACH, Account Aggregator, or UPI Setu, you need to set up a child sub-org account that contains details for: <br/> <br/> 1. Your organisation, either reused from sign-up or a relevant subsidiary, for which KYC will be done. <br/><br/> 2. The product category you want to use. <br/> <br/> Here are a few examples: <br/> <br/> • **Account Aggregator FIUs (Financial Information Users):** In the AA ecosystem, entities using financial information, such as personal finance apps or loan providers. <br/> <br/> • **UPI merchants:** In the UPI ecosystem, entities collecting payments through UPI. <br/> <br/> • **BBPS BOU billers:** Entities collecting repeat payments for their services via BBPS-enabled apps. <br/> <br/> • **BBPS COU agents:**Entities offering BBPS-enabled platforms to collect bill payments for BBPS billers. |
| **Aggregator account (coming soon)** | This is a type of parent Bridge account, that is allowed to resell Setu products to its business customers. The Bridge allows additional features for an aggregator—like viewing combined reports and analytics for all their business customers, or managing their corresponding Parent Bridge accounts with a single login. <br/><br/> If you want to become an aggregator, please contact <a href="mailto:[email protected]">[email protected]</a> for more details.|

<img src="https://storage.googleapis.com/strapi-assets/latest/bridge-v2-docs/Glossary/Organisation%20hierarchy.png" alt="" />

<hr class="primary" />

### Product categories, and products
Whenever you set up a child sub-org account, you also choose the product category you want to use it for. Setu’s product categories include Account Aggregator, UPI, BBPS BOU and COU, KYC suite and eSign. These categories have multiple product offerings under them and basically, and you can use the same child org account for using one or more products.

-- Discuss about the asset --

<hr class="tertiary" />

### Product instance
If you want to go live with any product, you can set up a product instance, which is basically a set of forms to collect some details we need to enable your integration, along with the child org’s KYC details, that let’s us asses.

-- Discuss about the assest --

<hr class="tertiary" />

### Good to know

##### Go live process

The go live process is consistent across product categories and includes the following steps:

1. Sign up and create Bridge parent account.
2. Set up child sub-org for product.
3. Set up product instance and fill in details.
4. Submit instance to go live.
5. Sign agreements with Setu for pricing and services.
6. Get approved and start transacting on production using live credentials.


##### Test and live credentials

As the name suggests, Test credentials are used on sandbox for testing your integration. These are made available to you after you set up a child org account. You can integrate with any required APIs and use Test credentials for authenticating your API requests, along with the instance ID.

You also have access to Live credentials, but you can only use them for production API calls with a LIVE product instance—that is, an instance ID for which your KYC and integration details have been approved by a Setu admin. These credentials are used for live transactions that you will be charged for as per the pricing agreement signed during on-boarding.

##### 2-factor-authentication (2FA)

2FA makes your account more secure, with a 2-step login process (password and OTP sent to registered email). This can be enabled for your account in two ways:
- During sign up, where you are shown the option to enable to enable 2FA for all users of the org and/or just for yourself.
- After sign up, you can enable 2FA for your organisation, by accessing **Settings → Org preferences** or for yourself by accessing **Settings → Your profile.**

<NextPage
info={{
description: "Know how to get started with bridge",
slug: "/dev-tools/bridge/overview",
title: "Overview",
}}
/>

<WasPageHelpful />
80 changes: 45 additions & 35 deletions content/dev-tools/bridge/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,63 +1,73 @@
---
sidebar_title: Overview
page_title: Bridge overview
order: 0
order: 1
visible_in_sidebar: true
---

## The Bridge
## Overview

The Bridge is a single web portal that lets you pick, configure and go live with your Setu integrations, generate and download transaction and settlement reports, invite users from your organisation to use our platform—with more features on the way.
Bridge is a free self-serve platform provided by Setu, where you can explore and use multiple products provided by Setu—fill in details to go live with products, manage user access to those products, and also check reports and analytics related to your configured products, on a single platform.

<p>
<a href="https://bridge.setu.co/signup" target="_blank">
Sign up on The Bridge
</a>{" "}
to get started if you haven’t already.
</p>
<img src="https://storage.googleapis.com/strapi-assets/latest/bridge-v2-docs/Overview/Home.png" alt="Bridge home" />

<MainImage
src="https://storage.googleapis.com/strapi-assets/latest/Screenshot_2021_03_19_at_3_39_31_PM_ccd1f16be5/Screenshot_2021_03_19_at_3_39_31_PM_ccd1f16be5.png"
alt="Bridge"
/>

This is intended to be an entirely a self-serve console, with all your information related to your Setu integration available in just a few clicks. Of course, some workflows are still dependent on offline methods, but we are working hard to provide a seamless, fully-online experience for all of our financial integrations.
**Explore the platform and get started with <a href="https://bridge.setu.co/v2">Setu Bridge</a> **

<hr className="primary" />
<hr class="primary" />

### Basic terminology
### Sign up on the Bridge
You can sign up on the Bridge in a few simple steps:
1. <ins>Provide your e-mail ID.</ins> Ensure that you use an official e-mail where you want access to different API products.
2. <ins>Enter or create your password for Bridge.</ins> Make sure you fulfil all the criteria mentioned on the platform; otherwise, you cannot proceed.
3. <ins>Go to your inbox and confirm your e-mail ID.</ins> We send you an e-mail to verify your ID.
4. <ins>Log in to the Bridge account you created.</ins> Use the same e-mail ID and password again to log in to your account, and complete the sign up process.
5. <ins>Provide your business name.</ins> This should belong to the business you’re setting up the Bridge account for. **Quick note:** You can use a different business name later when you configure the product (say, if you have a subsidiary or a different legal name).
6. <ins>Optionally, set up 2FA (two-factor authentication) for account login.</ins> Enable or disable 2FA, which asks for a password and an OTP sent to your registered e-mail ID whenever you login.

Here are some terms you might see repeated through out these guides—
<img src="https://storage.googleapis.com/strapi-assets/latest/bridge-v2-docs/Overview/Sign%20up.gif" alt="Sign up on the bridge" />

##### Partner
### Log in to Bridge

Any business entity that integrates with Setu to use our platform is called a “partner”. Once sign-up on the Bridge is complete, the entity is given a `partnerID`, that uniquely identifies them on our system, and can now begin using our offerings.
You can log in to the Bridge in a few simple steps:
1. Enter your registered e-mail ID.
2. Enter your password.
3. Enter OTP. **Note**, you need to provide an OTP only if you have enabled 2FA.

##### Product
<img src="https://storage.googleapis.com/strapi-assets/latest/bridge-v2-docs/Overview/Login.gif" alt="Login into the bridge" />

Setu offers multiple financial API integrations, each of them solving for a particular use case. The Collect BBPS product lets you get listed as a biller on the Bharat Bill Payment System, while the FD product lets you embed a full-fledged fixed deposit flow into your app. Each of these discrete, individual offerings is called a “product”.
### Navigating Bridge

##### Product configuration / Configured product
<img src="http://storage.googleapis.com/strapi-assets/latest/bridge-v2-docs/Overview/navigating-bridge.gif" alt="Sidebar navigation" />

These aforementioned products, each need a set of input parameters before you can start using them for your needs. The products come as an empty template, where you can enter the required details before you can test them and go live.
##### Side navigation items
Explore the different sections on the Bridge sidebar.

For example, the Collect BBPS product requires the partner to enter details about where to fetch bills from, how to identify customers on their system, and where to settle the incoming payments. These together, make up the “configuration” required for the Collect BBPS to begin making transactions.
<img src="https://storage.googleapis.com/strapi-assets/latest/bridge-v2-docs/Overview/Side%20nav.gif" alt="Bridge side navigation items" />

Once the configuration has been set, the partner now has a “configured product”, which they can now begin testing. Partners can create as many product configurations as they need, there are no limits.
- The **Home page** is a central view for all products. This is where you can see details of your child accounts, pending integrations, and data on live integrations.

##### Sandbox / production environments
- The **Product store** contains a list of all Setu product categories.

Once a partner is on-boarded, they are given access to a virtual isolated space inside which they can configure and test as many products and configurations as they wish. This is called the “sandbox” environment. Transactions made in sandbox are all mocked, meaning there is no actual movement of money between the involved parties.
- **Settings** provide controls for your organisation, including:
- A list of users, whom you or other administrators can invite or disable, for either the parent Bridge account or specific child accounts.
- Setting option to set up 2FA for all users invited to your Bridge account.
- Common API credentials that you can use for integrations across all child accounts.
- The **“PRODUCTS YOU ARE USNG”** section shows the list of product categories you are using. Clicking any of them takes you to the context of that category, where you can:
- View product-specific reports and analytics.
- Navigate to product instances.
- See child accounts for the product category, if you manage more than one.

Once the partner is satisfied with testing in sandbox, they can now submit their product configuration to Setu for a final round of review, along with the org KYC. Once we verify the configuration and the KYC, the partner is now given access to the “production”, or “prod” environment.

Here, in the production environment, partners can create as many fresh configurations as required, which can be be taken “live”. Transactions made with these configurations would trigger actual movement of money between the parties.
##### Your Profile

Data is not shared between sandbox and production—so configurations exist independently on sandbox and production. You can switch between them easily by hovering over the coloured border on the top of each page. Sandbox is coloured orange, and production is coloured green.
<img src="https://storage.googleapis.com/strapi-assets/latest/bridge-v2-docs/Overview/Profile.gif" alt="User profile on the bridge" />

<MainImage
src="https://storage.googleapis.com/strapi-assets/latest/sandbox_prod_switch_42f516755b/sandbox_prod_switch_42f516755b.gif?1812386"
alt="ENV-switch"
<NextPage
info={{
description: "View all the products and how to set them up",
slug: "/dev-tools/bridge/explore-and-configure-products",
title: "Explore and configure products",
}}
/>

<WasPageHelpful />
<WasPageHelpful />
Loading