PHP Class Dwolla\Account

Inheritance: extends RestClient
Show file Open project: dwolla/dwolla-php

Public Methods

Method Description
balance ( string $alternate_token = false ) : integer Returns balance of the account associated with the current OAuth token.
basic ( $id ) : String[] Returns basic account information for the account associated with the passed account ID.
disableAutoWithdrawal ( string $alternate_token = false ) : string Disables auto-withdrawal status of the account associated with the current OAuth token.
enableAutoWithdrawal ( string $fundingId, string $alternate_token = false ) : string Enables auto-withdrawal status of the account associated with the current OAuth token under the specified funding ID.
full ( string $alternate_token = false ) : String[] Returns full account information for the account associated with the current OAuth token.
getAutoWithdrawalStatus ( string $alternate_token = false ) : String[] Gets auto-withdrawal status of the account associated with the current OAuth token.
nearby ( $lat, $lon ) : String[] Returns users and venues near a location.
toggleAutoWithdrawalStatus ( boolean $status, string $fundingId, string $alternate_token = false ) : string Sets auto-withdrawal status of the account associated with the current OAuth token under the specified funding ID.

Method Details

balance() public method

Returns balance of the account associated with the current OAuth token.
public balance ( string $alternate_token = false ) : integer
$alternate_token string OAuth token value to be used instead of the current setting in the Settings class.
return integer Balance of account.

basic() public method

Returns basic account information for the account associated with the passed account ID.
public basic ( $id ) : String[]
return String[] Array of basic account information.

disableAutoWithdrawal() public method

Disables auto-withdrawal status of the account associated with the current OAuth token.
public disableAutoWithdrawal ( string $alternate_token = false ) : string
$alternate_token string OAuth token value to be used instead of the current setting in the Settings class.
return string Either "Enabled" or "Disabled"

enableAutoWithdrawal() public method

Enables auto-withdrawal status of the account associated with the current OAuth token under the specified funding ID.
public enableAutoWithdrawal ( string $fundingId, string $alternate_token = false ) : string
$fundingId string Funding ID of target account.
$alternate_token string OAuth token value to be used instead of the current setting in the Settings class.
return string Either "Enabled" or "Disabled"

full() public method

Returns full account information for the account associated with the current OAuth token.
public full ( string $alternate_token = false ) : String[]
$alternate_token string OAuth token value to be used instead of the current setting in the Settings class.
return String[] Array of full account information.

getAutoWithdrawalStatus() public method

Gets auto-withdrawal status of the account associated with the current OAuth token.
public getAutoWithdrawalStatus ( string $alternate_token = false ) : String[]
$alternate_token string OAuth token value to be used instead of the current setting in the Settings class.
return String[] Status (with funding id if applicable)

nearby() public method

Returns users and venues near a location.
public nearby ( $lat, $lon ) : String[]
$lat {String} Latitudinal coordinates.
$lon {String} Longitudinal coordinates.
return String[] Array with users, venues, and relevant info.

toggleAutoWithdrawalStatus() public method

Sets auto-withdrawal status of the account associated with the current OAuth token under the specified funding ID.
public toggleAutoWithdrawalStatus ( boolean $status, string $fundingId, string $alternate_token = false ) : string
$status boolean Auto-withdrawal boolean.
$fundingId string Funding ID of target account.
$alternate_token string OAuth token value to be used instead of the current setting in the Settings class.
return string Either "Enabled" or "Disabled"