PHP Класс Bitpay\Payout

Наследование: implements bitpay\PayoutInterface
Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
$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

Открытые методы

Метод Описание
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.

Описание методов

addInstruction() публичный Метод

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

getAccountId() публичный Метод

public getAccountId ( )

getAmount() публичный Метод

public getAmount ( )

getBtcAmount() публичный Метод

public getBtcAmount ( )

getCurrency() публичный Метод

public getCurrency ( )

getEffectiveDate() публичный Метод

public getEffectiveDate ( )

getId() публичный Метод

public getId ( )

getInstructions() публичный Метод

public getInstructions ( )

getNotificationEmail() публичный Метод

getNotificationUrl() публичный Метод

public getNotificationUrl ( )

getPricingMethod() публичный Метод

public getPricingMethod ( )

getRate() публичный Метод

Get rate assigned to payout at effectiveDate
public getRate ( )

getReference() публичный Метод

public getReference ( )

getRequestDate() публичный Метод

public getRequestDate ( )

getResponseToken() публичный Метод

public getResponseToken ( )

getStatus() публичный Метод

public getStatus ( )

getToken() публичный Метод

public getToken ( )

setAccountId() публичный Метод

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

setAmount() публичный Метод

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

setBtcAmount() публичный Метод

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

setCurrency() публичный Метод

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

setEffectiveDate() публичный Метод

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

setId() публичный Метод

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

setNotificationEmail() публичный Метод

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

setNotificationUrl() публичный Метод

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

setPricingMethod() публичный Метод

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

setRate() публичный Метод

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

setReference() публичный Метод

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

setRequestDate() публичный Метод

Set
public setRequestDate ( $requestDate )

setResponseToken() публичный Метод

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

setStatus() публичный Метод

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

setToken() публичный Метод

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

updateInstruction() публичный Метод

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

Описание свойств

$account_id защищенное свойство

protected string $account_id
Результат string

$amount защищенное свойство

protected float $amount
Результат float

$btc защищенное свойство

protected float $btc
Результат float

$currency защищенное свойство

protected CurrencyInterface,bitpay $currency
Результат bitpay\CurrencyInterface

$effectiveDate защищенное свойство

protected string $effectiveDate
Результат string

$id защищенное свойство

protected string $id
Результат string

$instructions защищенное свойство

protected array $instructions
Результат array

$notificationEmail защищенное свойство

protected string $notificationEmail
Результат string

$notificationUrl защищенное свойство

protected string $notificationUrl
Результат string

$pricingMethod защищенное свойство

protected string $pricingMethod
Результат string

$rate защищенное свойство

protected string $rate
Результат string

$reference защищенное свойство

protected string $reference
Результат string

$requestDate защищенное свойство

protected string $requestDate
Результат string

$responseToken защищенное свойство

protected string $responseToken
Результат string

$status защищенное свойство

protected string $status
Результат string

$token защищенное свойство

protected TokenInterface,bitpay $token
Результат bitpay\TokenInterface