Download the PHP package stallion/finfactor without Composer
On this page you can find all versions of the php package stallion/finfactor. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download stallion/finfactor
More information about stallion/finfactor
Files in stallion/finfactor
Package finfactor
Short Description PHP client for the Finfactor WealthScape API. Handles authentication, user subscription, AA consent flow, and financial data retrieval.
License proprietary
Informations about the package finfactor
stallion/finfactor
PHP client for the Finfactor WealthScape API. Handles authentication, user subscription, AA consent flow, and financial data retrieval for mutual funds and equities via the RBI Account Aggregator framework.
Requirements
- PHP 8.1 or higher
- Composer
Installation
Quick Start
After the user approves consent on the AA portal and is redirected back to your app:
Configuration
Pass a configuration array to the Client constructor.
| Key | Required | Description |
|---|---|---|
pfm_base_url |
Yes | WealthScape PFM API base URL (provided by Finfactor) |
pfm_user_id |
Yes | WealthScape PFM API user ID |
pfm_password |
Yes | WealthScape PFM API password |
finsense_base_url |
Yes | Finsense API base URL (provided by Finfactor) |
finsense_user_id |
Yes | Finsense layer user ID |
finsense_password |
Yes | Finsense layer password |
redirect_url |
No | URL to redirect the user to after AA consent |
consent_template |
No | Consent template name. Default: bank_statement_sebi |
consent_description |
No | Consent description. Default: PFM |
aa_id |
No | Account Aggregator ID. Default: [email protected] |
customer_id_suffix |
No | Suffix appended to mobile for AA customer ID. Default: @finvu |
timeout |
No | Request timeout in seconds. Default: 30 |
connect_timeout |
No | Connection timeout in seconds. Default: 10 |
Token Storage
By default the package stores the auth token in a temp file. You can provide a custom storage path or use a database-backed store for multi-server setups.
File store with custom path
Database store
The database store requires a finfactor_tokens table (the table name is configurable):
To use a custom table name:
Custom store
Implement Stallion\Finfactor\TokenStore\TokenStoreInterface:
API Reference
Subscription
Consent
Financial Data
Exceptions
All exceptions extend Stallion\Finfactor\Exceptions\ApiException.
| Exception | When thrown |
|---|---|
ApiException |
Any API error (4xx, 5xx, network) |
AuthException |
Authentication failure |
\InvalidArgumentException |
Missing required config keys |
Testing
Set the following environment variables and run the test suite:
License
Proprietary. All rights reserved. Stallion Asset Private Limited.