| Method |
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. |
|
