Git Product home page Git Product logo

yodlee-api's Introduction

Yodlee API SDK for PHP

A library for accessing financial data from Yodlee API. Built for easier integration with Laravel PHP Framework as a dependency.

The code is from progknife/yodlee-api.

Code Example

<?php
// NOTE: This script assumes installation with composer and using composer's autoloader.
require_once 'vendor/autoload.php';

// Minimum required Yodlee credentials.
$yodleeApiUrl = 'https://developer.api.yodlee.com/ysl/restserver/v1';
$yodleeApiCobrandLogin = 'johndoe';
$yodleeApiCobrandPassword = 'johndoe#123';

// Create a new instance of the SDK.
$yodleeApi = new \YodleeApi\Client($yodleeApiUrl);

// Login the cobrand.
$yodleeApi->cobrand()->login($yodleeApiCobrandLogin, $yodleeApiCobrandPassword);

// Fetch all available banks, institutions etc. that are supported by Yodlee.
$providers = $yodleeApi->providers()->get();

Check the examples/ directory for sample scripts.

Installation with Composer

composer require progknife/yodlee-api

API Reference

cobrand()

Return Method Description
bool login(string $username, string $password) Authenticates the cobrand.
void logout() Ends the authenticated cobrand's session from Yodlee.

user()

Return Method Description
bool login(string $username, string $password) Authenticates the user.
void logout() Ends the authenticated user's session.
int|bool register(string $username, string $password, string $email) Register and authenticates the user to Yodlee.
void unregister() Deletes the authenticated user's data from Yodlee.
array|bool accessTokensIputs(int appId) Get inputs for FastLink integration. Look at Yodlee API Documentation for details.

providers()

Return Method Description
array get([array $filters]) Fetch all providers supported by Yodlee. Refer to Yodlee API Documentation for filters parameter.
object getDetail(int $providerId) Fetch the provider details including the login form.

providerAccounts()

Return Method Description
object find(int $providerAccountId) Fetch the provider account by ID.
array get() Fetch all provider accounts added by the authenticated user.
object add(int $providerId, array $fields) Add a provider to user. Refer to Yodlee API Documentation for more details on $fields parameter.
object update(string $providerAccountIds, array $credentialsParam) Update one or multiple provider account.
void delete(int $providerAccountId) Delete the provider account.

statements()

Return Method Description
array get([array $filters]) Fetch all statements of the authenticated user. Refer to Yodlee API Documentation for filters parameter.

transactions()

Return Method Description
array get([array $filters]) Fetch all transactions of the authenticated user. Refer to Yodlee API Documentation for filters parameter.

yodlee-api's People

Contributors

kmanuzon avatar jonathanlaflamme avatar francoisxr avatar mike-movem avatar mike-polatoglou avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.