To initiate a PFM (Personal Finance Management) session and render the corresponding UI, follow the steps below.
Step 1: Initiate PFM Request
The API will return a response containing key parameters such as the customer_id, and gatewayToken, which are required to construct the PFM web view URL.
Step 2: Construct the PFM Web View URL
Using the values returned from the API response, construct the PFM URL in the format shown below:
{WEB_VIEW_BASE_URL}/#/pfm/${customer_id}/${txn_id}/${template_id}?token_id=${gatewayToken}
This URL is to be rendered within a web view in your application.
Example
https://enterprise.digio.in/fiu_ui/#/pfm/CUST123XYZ/ABC45678901/TEMPLATE789?token_id=GTOKEN123456 This web view will render the PFM dashboard for the specific user and session using the consented financial data.
Step 3: Load the URL
Once the URL is constructed, embed or redirect to the URL inside a component in your app or front-end.
URL Parameter Reference
Below is a breakdown of the URL parameters and their requirements:
| Attribute | Type | Validations | Description | Required |
|---|---|---|---|---|
| customer_id | String | Not Null | Customer ID provided in the /client/pfm API response. | Mandatory |
| txn_id | String | 11-character random alphanumeric string | A unique transaction identifier used for session tracking. | Mandatory |
| template_id | String | Not Null | Template ID selected or returned as part of the response. | Mandatory |
| gatewayToken | String | Not Null | Token used for authenticating the web view request. Provided in API response. | Mandatory |