PHP Class Bitpay\Payout

Inheritance: implements bitpay\PayoutInterface
Afficher le fichier Open project: bitpay/php-client

Protected Properties

Свойство Type Description
$account_id string
$amount float
$btc float
$currency bitpay\CurrencyInterface
$effectiveDate string
$id string
$instructions array
$notificationEmail string
$notificationUrl string
$pricingMethod string
$rate string
$reference string
$requestDate string
$responseToken string
$status string
$token bitpay\TokenInterface

Méthodes publiques

Méthode Description
addInstruction ( bitpay\PayoutInstructionInterface $instruction ) Add Instruction of PayoutInstructionInterface type Increases $this->amount by value.
getAccountId ( )
getAmount ( )
getBtcAmount ( )
getCurrency ( )
getEffectiveDate ( )
getId ( )
getInstructions ( )
getNotificationEmail ( )
getNotificationUrl ( )
getPricingMethod ( )
getRate ( ) Get rate assigned to payout at effectiveDate
getReference ( )
getRequestDate ( )
getResponseToken ( )
getStatus ( )
getToken ( )
setAccountId ( $id ) Set Account Id - Bitpays account ID for the payout.
setAmount ( $amount ) Sets the amount for this payout.
setBtcAmount ( $amount ) Set the Bitcoin amount for this payout, once set by Bitpay.
setCurrency ( bitpay\CurrencyInterface $currency ) Set Currency
setEffectiveDate ( $effectiveDate ) Set Effective date - date payout should be given to employees.
setId ( $id ) Set the batch ID as assigned from bitpay.
setNotificationEmail ( $notificationEmail ) Set an email address where updates to payout status should be sent.
setNotificationUrl ( $notificationUrl ) Set a notification url - where updated Payout objects will be sent
setPricingMethod ( $pricingMethod ) Set the pricing method for this payout request
setRate ( $rate ) Set the rate in bitcoin for the payouts of this transaction.
setReference ( $reference ) Set the payroll providers reference for this payout
setRequestDate ( $requestDate ) Set
setResponseToken ( $responseToken ) Set Response Token - returned by Bitpay when payout request is created
setStatus ( $status ) Sets the status for the current payout request
setToken ( bitpay\TokenInterface $token ) Set the token to authorize this request.
updateInstruction ( $index, $function, $argument ) Update Instruction - Supply an index of the instruction to update, plus the function and single argument, to do something to an instruction.

Method Details

addInstruction() public méthode

Add Instruction of PayoutInstructionInterface type Increases $this->amount by value.
public addInstruction ( bitpay\PayoutInstructionInterface $instruction )
$instruction bitpay\PayoutInstructionInterface

getAccountId() public méthode

public getAccountId ( )

getAmount() public méthode

public getAmount ( )

getBtcAmount() public méthode

public getBtcAmount ( )

getCurrency() public méthode

public getCurrency ( )

getEffectiveDate() public méthode

public getEffectiveDate ( )

getId() public méthode

public getId ( )

getInstructions() public méthode

public getInstructions ( )

getNotificationEmail() public méthode

getNotificationUrl() public méthode

public getNotificationUrl ( )

getPricingMethod() public méthode

public getPricingMethod ( )

getRate() public méthode

Get rate assigned to payout at effectiveDate
public getRate ( )

getReference() public méthode

public getReference ( )

getRequestDate() public méthode

public getRequestDate ( )

getResponseToken() public méthode

public getResponseToken ( )

getStatus() public méthode

public getStatus ( )

getToken() public méthode

public getToken ( )

setAccountId() public méthode

Set Account Id - Bitpays account ID for the payout.
public setAccountId ( $id )
$id

setAmount() public méthode

Sets the amount for this payout.
public setAmount ( $amount )
$amount

setBtcAmount() public méthode

Set the Bitcoin amount for this payout, once set by Bitpay.
public setBtcAmount ( $amount )
$amount

setCurrency() public méthode

Set Currency
public setCurrency ( bitpay\CurrencyInterface $currency )
$currency bitpay\CurrencyInterface

setEffectiveDate() public méthode

Set Effective date - date payout should be given to employees.
public setEffectiveDate ( $effectiveDate )
$effectiveDate

setId() public méthode

Set the batch ID as assigned from bitpay.
public setId ( $id )
$id

setNotificationEmail() public méthode

Set an email address where updates to payout status should be sent.
public setNotificationEmail ( $notificationEmail )
$notificationEmail

setNotificationUrl() public méthode

Set a notification url - where updated Payout objects will be sent
public setNotificationUrl ( $notificationUrl )
$notificationUrl

setPricingMethod() public méthode

Set the pricing method for this payout request
public setPricingMethod ( $pricingMethod )
$pricingMethod

setRate() public méthode

Set the rate in bitcoin for the payouts of this transaction.
public setRate ( $rate )
$rate

setReference() public méthode

Set the payroll providers reference for this payout
public setReference ( $reference )
$reference

setRequestDate() public méthode

Set
public setRequestDate ( $requestDate )

setResponseToken() public méthode

Set Response Token - returned by Bitpay when payout request is created
public setResponseToken ( $responseToken )
$responseToken

setStatus() public méthode

Sets the status for the current payout request
public setStatus ( $status )
$status

setToken() public méthode

Set the token to authorize this request.
public setToken ( bitpay\TokenInterface $token )
$token bitpay\TokenInterface

updateInstruction() public méthode

Update Instruction - Supply an index of the instruction to update, plus the function and single argument, to do something to an instruction.
public updateInstruction ( $index, $function, $argument )
$index
$function
$argument

Property Details

$account_id protected_oe property

protected string $account_id
Résultat string

$amount protected_oe property

protected float $amount
Résultat float

$btc protected_oe property

protected float $btc
Résultat float

$currency protected_oe property

protected CurrencyInterface,bitpay $currency
Résultat bitpay\CurrencyInterface

$effectiveDate protected_oe property

protected string $effectiveDate
Résultat string

$id protected_oe property

protected string $id
Résultat string

$instructions protected_oe property

protected array $instructions
Résultat array

$notificationEmail protected_oe property

protected string $notificationEmail
Résultat string

$notificationUrl protected_oe property

protected string $notificationUrl
Résultat string

$pricingMethod protected_oe property

protected string $pricingMethod
Résultat string

$rate protected_oe property

protected string $rate
Résultat string

$reference protected_oe property

protected string $reference
Résultat string

$requestDate protected_oe property

protected string $requestDate
Résultat string

$responseToken protected_oe property

protected string $responseToken
Résultat string

$status protected_oe property

protected string $status
Résultat string

$token protected_oe property

protected TokenInterface,bitpay $token
Résultat bitpay\TokenInterface