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.

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

Add FIP success rate field in GET FIP APIs response #235

Merged
merged 1 commit into from
Feb 11, 2025
Merged

Add FIP success rate field in GET FIP APIs response #235

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 5 additions & 1 deletion api-references/data/account-aggregator.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4134,7 +4134,11 @@
"TEMPORARILY_INACTIVE"
],
"description": "Current status of the FIP"
}
},
"successRate": {
"type": "number",
"description": "Data fetch success rate of the FIP in percentage for the last 1 hour"
}
},
"required": [
"fiTypes",
Expand Down
46 changes: 31 additions & 15 deletions content/data/account-aggregator/api-integration/fip-apis.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ The GET Active FIP List API is the new version of our API to call the list of Ac
- Dynamically activates and deactivates FIPs based on performance.
- Can be used to simply check the status of FIPs that are active or inactive on the ecosystem.
- Can be used by FIUs as a mode of selection of FIPs/providers where a user has an account.
- Provides real-time success rates to help FIUs make data-driven decisions about creating consents, allowing them to route users to alternate data collection methods when FIP performance is poor.

#### Details Shared in the FIP List API

Expand All @@ -21,15 +22,15 @@ These key details can be used by you for purposes like - offering a list of FIPs
<table>
<tr>
<th>
<strong>Status</strong>
<strong>Field</strong>
</th>
<th>
<strong>Description</strong>
</th>
</tr>
<tr>
<td>
<code>Name</code>
<code>name</code>
</td>
<td>
The name of the FIP - this is typically their brand name in camel
Expand All @@ -38,7 +39,7 @@ These key details can be used by you for purposes like - offering a list of FIPs
</tr>
<tr>
<td>
<code>FIP ID</code>
<code>fipId</code>
</td>
<td>
The unique identifier for the FIP in the central registry of
Expand All @@ -50,18 +51,18 @@ These key details can be used by you for purposes like - offering a list of FIPs
</tr>
<tr>
<td>
<code>FIP TYPES</code>
<code>fiTypes</code>
</td>
<td>
This refers to the type of data available via the FIP. For example,
an FIP with FIP_Types “DEPOSITS “ will have Savings or Current
an FIP with fiTypes “DEPOSITS “ will have Savings or Current
Accounts available and be able to share bank statements upon user
consent
</td>
</tr>
<tr>
<td>
<code>Status</code>
<code>status</code>
</td>
<td>
The Status field gives you the up-to-date status of the FIP. This
Expand All @@ -70,6 +71,14 @@ These key details can be used by you for purposes like - offering a list of FIPs
statuses in the next section.
</td>
</tr>
<tr>
<td>
<code>successRate</code>
</td>
<td>
The data fetch success rate (in %) for the FIP in the last 1 hour. This can be used by FIUs to make informed decisions about creating consents. A null value indicates insufficient data points in the last hour to calculate the success rate.
</td>
</tr>
</table>

#### Categories of FIP Status
Expand Down Expand Up @@ -146,7 +155,8 @@ Below is the list of statuses for FIPs that you will see in a typical GET FIP Li
"DEPOSIT"
],
"institutionType": "BANK",
"status": "ACTIVE"
"status": "ACTIVE",
"successRate": 98.55
},
{
"name": "Federal Bank",
Expand All @@ -155,7 +165,8 @@ Below is the list of statuses for FIPs that you will see in a typical GET FIP Li
"DEPOSIT"
],
"institutionType": "BANK",
"status": "ACTIVE"
"status": "ACTIVE",
"successRate": 95.25
},
{
"name": "IndusInd Bank Ltd.",
Expand All @@ -166,7 +177,8 @@ Below is the list of statuses for FIPs that you will see in a typical GET FIP Li
"RECURRING_DEPOSIT"
],
"institutionType": "BANK",
"status": "TEMPORARILY_INACTIVE"
"status": "TEMPORARILY_INACTIVE",
"successRate": 45.20
},
{
"name": "HDFC Bank",
Expand All @@ -175,7 +187,8 @@ Below is the list of statuses for FIPs that you will see in a typical GET FIP Li
"DEPOSIT"
],
"institutionType": "BANK",
"status": "INACTIVE"
"status": "INACTIVE",
"successRate": null
}
],
"traceId": "1-64313583-255e3a0705424652664584b2"
Expand Down Expand Up @@ -227,13 +240,14 @@ Below is the list of statuses for FIPs that you will see in a typical GET FIP Li
{`{
"data": [
{
"name": "HDFC Bank",
"fipId": "HDFC-FIP",
"name": "Axis Bank",
"fipId": "AXIS001",
"fiTypes": [
"DEPOSIT"
],
"institutionType": "BANK",
"status": "INACTIVE"
"status": "ACTIVE",
"successRate": 98.55
}
],
"traceId": "1-66ff79c7-46029a1f1aaa59083489fd46"
Expand Down Expand Up @@ -291,7 +305,8 @@ Below is the list of statuses for FIPs that you will see in a typical GET FIP Li
"DEPOSIT"
],
"institutionType": "BANK",
"status": "ACTIVE"
"status": "ACTIVE",
"successRate": 98.55
},
{
"name": "Federal Bank",
Expand All @@ -300,7 +315,8 @@ Below is the list of statuses for FIPs that you will see in a typical GET FIP Li
"DEPOSIT"
],
"institutionType": "BANK",
"status": "ACTIVE"
"status": "ACTIVE",
"successRate": 95.25
}
],
"traceId": "1-64313583-255e3a0705424652664584b2"
Expand Down