Giter Club home page Giter Club logo

dwolla-php's Introduction

dwolla-php: PHP Wrapper for Dwolla's API

=================================================================================

Version

1.2.0

Requirements

Installation

The recommended way to install dwolla-php is through composer. Just create a composer.json file and run the php composer.phar install command to install it:

{
    "require": {
        "dwolla/dwolla-php": "1.1.0"
    }
}

Alternatively, you can simply include dwolla.php in your PHP code

Usage

require 'dwolla.php';
$Dwolla = new DwollaRestClient();
$Dwolla->setToken('[OAuth Token Goes Here]');

// Send money to a given Dwolla ID
$transactionId = $Dwolla->send('[PIN]', '812-734-7288', 1.00);

Examples / Quickstart

This repo includes various usage examples, including:

  • Authenticating with OAuth [oauth.php]
  • Sending money [send.php]
  • Fetching account information [accountInfo.php]
  • Grabbing a user's contacts [contacts.php]
  • Listing a user's funding sources [fundingSources.php]
  • Creating offsite gateway sessions [offsiteGateway.php]

Methods

Authentication Methods:

getAuthUrl()        ==> (string) OAuth permissions page URL
requestToken($code) ==> (string) a never-expiring OAuth access token
setToken($token)    ==> (bool) was token saved?
getToken()          ==> (string) current OAuth token

Users Methods:

me()                ==> (array) the user entity associated with the token
getUser($user_id)   ==> (array) the user entity for {$user_id}

Register Methods:

register($email, $password, $pin, $firstName, $lastName, $address, $address2, $city, $state, $zip, $phone, $dateOfBirth, $acceptTerms[, $type, $organization, $ein])    ==> (array) the newly created user record

Contacts Methods:

contacts([$search, $types, $limit])         ==> (array) list of contacts matching the search criteria
nearbyContacts([$search, $types, $limit])   ==> (array) list of nearby spots matching the search criteria

Funding Sources Methods:

fundingSources()    ==> (array) a list of funding sources associated with the token
fundingSource($id)  ==> (array) information about the {$id} funding source

Balance Methods:

balance()           ==> (string) the Dwolla balance of the account associated with the token

Transactions Methods:

send($pin, $destinationId, $amount[, $destinationType, $notes, $facilitatorAmount, $assumeCosts])   ==> (string) transaction ID
request($pin, $sourceId, $amount[, $sourceType, $notes, $facilitatorAmount])                        ==> (string) request ID
transaction($transactionId)                     ==> (array) transaction details
listings([$sinceDate, $types, $limit, $skip])   ==> (array) a list of recent transactions matching the search criteria
stats([$types, $sinceDate, $endDate])           ==> (array) statistics about the account associated with the token

Offsite Gateway Methods:

startGatewaySession()                                           ==> (bool) did session start?
addGatewayProduct($name, $amount[, $description, $quantity])    ==> (bool) was product added?
verifyGatewaySignature($signature, $checkoutId, $amount)        ==> (bool) is signature valid?
getGatewayURL($destinationId[, $orderId, $discount, $shipping, $tax, $notes, $callback])    ==> (string) checkout URL

Helper Methods:

getError()          ==> (string) error message
parseDwollaID($id)  ==> (bool) is valid Dwolla ID?
setMode($mode)      ==> (bool) did mode change?

Changelog

1.2.0 (Thanks to Jeremy Kendall!)

  • Major code refactor, reformat to PSR
  • Changed license to MIT License
  • Added register user example

1.1.0 (Thanks to Jeremy Kendall!)

  • Added tests
  • Added support for composer
  • Renamed _keys.php to _keys.dist.php

1.0.0

  • Added support for Dwolla's offsite gateway
  • Refactored methods
  • Extended documentation

Credits

Support

References / Documentation

http://developers.dwolla.com/dev

License

(The MIT License)

Copyright (c) 2012 Dwolla <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

dwolla-php's People

Contributors

jeremykendall avatar dwollaapi avatar schonfeld avatar minicodemonkey avatar

Watchers

James Cloos 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.