README

This file describes the Yodlee Platform APIs using the swagger notation. You can use this swagger file to generate client side SDKs to the Yodlee Platform APIs for many different programming languages. Yodlee API v1.1 - Overview.

You will have to set the header before making the API call. The following headers apply to all the APIs:

Authorization: This header holds the access token
Api-Version: 1.1

Note: If there are any API-specific headers, they are mentioned explicitly in the respective API's description.

Installation & Usage

Requirements

PHP 8.1 and later.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');




$apiInstance = new RewardsWise\Yodlee\OpenAPI\Client\Api\AccountTokenApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$token_request = new \RewardsWise\Yodlee\OpenAPI\Client\Model\PaymentProcessorTokenRequest(); // \RewardsWise\Yodlee\OpenAPI\Client\Model\PaymentProcessorTokenRequest | account information

try {
    $result = $apiInstance->generatePaymentProcessorToken($token_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountTokenApi->generatePaymentProcessorToken: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
AccountTokenApi	generatePaymentProcessorToken	POST /paymentProcessor/token	Create Account Token
AccountTokenApi	revokePaymentProcessorToken	DELETE /paymentProcessor/token	Delete Account Token
AccountsApi	createManualAccount	POST /accounts	Add Manual Account
AccountsApi	deleteAccount	DELETE /accounts/{accountId}	Delete Account
AccountsApi	evaluateAddress	POST /accounts/evaluateAddress	Evaluate Address
AccountsApi	getAccount	GET /accounts/{accountId}	Get Account Details
AccountsApi	getAllAccounts	GET /accounts	Get Accounts
AccountsApi	getAssociatedAccounts	GET /accounts/associatedAccounts/{providerAccountId}	Associated Accounts
AccountsApi	getHistoricalBalances	GET /accounts/historicalBalances	Get Historical Balances
AccountsApi	getLatestBalances	GET /accounts/latestBalances	Get Latest Balances
AccountsApi	migrateAccounts	PUT /accounts/migrateAccounts/{providerAccountId}	Migrate Accounts
AccountsApi	updateAccount	PUT /accounts/{accountId}	Update Account
AuthApi	deleteApiKey	DELETE /auth/apiKey/{key}	Delete API Key
AuthApi	deleteToken	DELETE /auth/token	Delete Token
AuthApi	generateAccessToken	POST /auth/token	Generate Access Token
AuthApi	generateApiKey	POST /auth/apiKey	Generate API Key
AuthApi	getApiKeys	GET /auth/apiKey	Get API Keys
CobrandApi	cobrandLogin	POST /cobrand/login	Cobrand Login
CobrandApi	cobrandLogout	POST /cobrand/logout	Cobrand Logout
CobrandApi	createSubscriptionEvent	POST /cobrand/config/notifications/events/{eventName}	Subscribe Event
CobrandApi	deleteSubscribedEvent	DELETE /cobrand/config/notifications/events/{eventName}	Delete Subscription
CobrandApi	getPublicKey	GET /cobrand/publicKey	Get Public Key
CobrandApi	getSubscribedEvents	GET /cobrand/config/notifications/events	Get Subscribed Events
CobrandApi	updateSubscribedEvent	PUT /cobrand/config/notifications/events/{eventName}	Update Subscription
ConfigsApi	createSubscriptionNotificationEvent	POST /configs/notifications/events/{eventName}	Subscribe For Notification Event
ConfigsApi	deleteSubscribedNotificationEvent	DELETE /configs/notifications/events/{eventName}	Delete Notification Subscription
ConfigsApi	getPublicEncryptionKey	GET /configs/publicKey	Get Public Key
ConfigsApi	getSubscribedNotificationEvents	GET /configs/notifications/events	Get Subscribed Notification Events
ConfigsApi	updateSubscribedNotificationEvent	PUT /configs/notifications/events/{eventName}	Update Notification Subscription
ConsentsApi	createConsent	POST /consents	Post Consent
ConsentsApi	getConsentDetails	GET /consents/{consentId}	Get Authorization Details
ConsentsApi	getConsentHistory	GET /consents/history	Get Consent History
ConsentsApi	getConsentHistoryCount	GET /consents/history/count	Get Consent History Count
ConsentsApi	getConsentPreferences	GET /consents/preferences	Get Consents Preferences
ConsentsApi	getConsents	GET /consents	Get Consents
ConsentsApi	renewConsent	PUT /consents/{consentId}/renewal	Renew Consent
ConsentsApi	updateConsent	PUT /consents/{consentId}	Put Consent
DataExtractsApi	getDataExtractsEvents	GET /dataExtracts/events	Get Events
DataExtractsApi	getDataExtractsUserData	GET /dataExtracts/userData	Get userData
DerivedApi	getHoldingSummary	GET /derived/holdingSummary	Get Holding Summary
DerivedApi	getNetworth	GET /derived/networth	Get Networth Summary
DerivedApi	getTransactionSummary	GET /derived/transactionSummary	Get Transaction Summary
DocumentsApi	deleteDocument	DELETE /documents/{documentId}	Delete Document
DocumentsApi	downloadDocument	GET /documents/{documentId}	Download a Document
DocumentsApi	getDocuments	GET /documents	Get Documents
HoldingsApi	addHolding	POST /holdings	Add Holding
HoldingsApi	getAssetClassificationList	GET /holdings/assetClassificationList	Get Asset Classification List
HoldingsApi	getHoldingTypeList	GET /holdings/holdingTypeList	Get Holding Type List
HoldingsApi	getHoldings	GET /holdings	Get Holdings
HoldingsApi	getSecurities	GET /holdings/securities	Get Security Details
InstitutionsApi	getInstitutions	GET /institutions	Get institutions
PaymentProcessorApi	getVerifiedAccount	GET /partner/paymentProcessor/account	Get Account Details
PaymentProcessorApi	getVerifiedAccountBalance	GET /partner/paymentProcessor/account/balance	Get Account Balance
PaymentProcessorApi	getVerifiedAccountHolder	GET /partner/paymentProcessor/account/holder	Get Account Holder Details
ProviderAccountsApi	deleteProviderAccount	DELETE /providerAccounts/{providerAccountId}	Delete Provider Account
ProviderAccountsApi	editCredentialsOrRefreshProviderAccount	PUT /providerAccounts	Update Account
ProviderAccountsApi	getAllProviderAccounts	GET /providerAccounts	Get Provider Accounts
ProviderAccountsApi	getProviderAccount	GET /providerAccounts/{providerAccountId}	Get Provider Account Details
ProviderAccountsApi	getProviderAccountProfiles	GET /providerAccounts/profile	Get User Profile Details
ProviderAccountsApi	linkProviderAccount	POST /providerAccounts	Add Account
ProviderAccountsApi	refreshProviderAccount	PUT /providerAccounts/refresh	Refresh Provider Account
ProviderAccountsApi	updatePreferences	PUT /providerAccounts/{providerAccountId}/preferences	Update Preferences
ProvidersApi	getAllProviders	GET /providers	Get Providers
ProvidersApi	getProvider	GET /providers/{providerId}	Get Provider Details
ProvidersApi	getProvidersCount	GET /providers/count	Get Providers Count
StatementsApi	getStatements	GET /statements	Get Statements
TransactionsApi	createOrRunTransactionCategorizationRules	POST /transactions/categories/rules	Create or Run Transaction Categorization Rule
TransactionsApi	createTransactionCategory	POST /transactions/categories	Create Category
TransactionsApi	deleteTransactionCategorizationRule	DELETE /transactions/categories/rules/{ruleId}	Delete Transaction Categorization Rule
TransactionsApi	deleteTransactionCategory	DELETE /transactions/categories/{categoryId}	Delete Category
TransactionsApi	getTransactionCategories	GET /transactions/categories	Get Transaction Category List
TransactionsApi	getTransactionCategorizationRules	GET /transactions/categories/txnRules	Get Transaction Categorization Rules
TransactionsApi	getTransactionCategorizationRulesDeprecated	GET /transactions/categories/rules	Get Transaction Categorization Rules
TransactionsApi	getTransactions	GET /transactions	Get Transactions
TransactionsApi	getTransactionsCount	GET /transactions/count	Get Transactions Count
TransactionsApi	runTransactionCategorizationRule	POST /transactions/categories/rules/{ruleId}	Run Transaction Categorization Rule
TransactionsApi	updateTransaction	PUT /transactions	Update Transaction for Transaction Source ID
TransactionsApi	updateTransaction1	PUT /transactions/{transactionId}	Update Transaction
TransactionsApi	updateTransactionCategorizationRule	PUT /transactions/categories/rules/{ruleId}	Update Transaction Categorization Rule
TransactionsApi	updateTransactionCategory	PUT /transactions/categories	Update Category
UserApi	getAccessTokens	GET /user/accessTokens	Get Access Tokens
UserApi	getUser	GET /user	Get User Details
UserApi	registerUser	POST /user/register	Register User
UserApi	samlLogin	POST /user/samlLogin	Saml Login
UserApi	unregister	DELETE /user/unregister	Delete User
UserApi	updateUser	PUT /user	Update User Details
UserApi	userLogout	POST /user/logout	User Logout
UserDocumentsApi	deleteuserdocuments	DELETE /documents	Delete User Documents
UserDocumentsApi	getuserdocuments	POST /documents/search	Get User Documents
VerificationApi	getClassificationSummary	GET /verification/classification/summary	Get Classification Summary
VerificationApi	getHolderProfile	GET /verification/holderProfile	Get Holder Profile
VerificationApi	getVerificationStatus	GET /verification	Get Verification Status
VerificationApi	getVerifiedAccounts	GET /verification/verifiedAccounts	Get Verified Accounts
VerificationApi	initiateMatchingOrChallengeDepositeVerification	POST /verification	Initiaite Challenge Deposit
VerificationApi	verifyChallengeDeposit	PUT /verification	Verify Challenge Deposit
VerifyAccountApi	initiateAccountVerification	POST /verifyAccount/{providerAccountId}	Verify Accounts Using Transactions

Models

Authorization

Endpoints do not require authorization.

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

developer@yodlee.com

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

API version: 1.1.0
- Generator version: 7.13.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

rewardswise / yodlee-sdk-php

Maintainers

Details