PHP 클래스 Bitpay\Payout

상속: implements bitpay\PayoutInterface
파일 보기 프로젝트 열기: bitpay/php-client

보호된 프로퍼티들

프로퍼티 타입 설명
$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