PHP Class PayPal\Api\PayoutBatchHeader

Batch header resource.
Inheritance: extends PayPal\Common\PayPalModel
Show file Open project: paypal/rest-api-sdk-php Class Usage Examples

Public Methods

Method Description
addLink ( PayPal\Api\Links $links ) Append Links to the list.
getAmount ( ) : PayPal\Api\Currency Total amount, in U.S. dollars, requested for the applicable payouts.
getBatchStatus ( ) : string The PayPal-generated batch payout status. If the batch payout passes the preliminary checks, the status is PENDING.
getErrors ( ) : Error Gets Errors
getFees ( ) : PayPal\Api\Currency Total estimate in U.S. dollars for the applicable payouts fees.
getLinks ( ) : PayPal\Api\Links[] Gets Links
getPayoutBatchId ( ) : string The PayPal-generated ID for a batch payout.
getSenderBatchHeader ( ) : PayoutSenderBatchHeader The sender-provided batch payout header.
getTimeCompleted ( ) : string The time that processing for the batch was completed.
getTimeCreated ( ) : string The time the batch entered processing.
removeLink ( PayPal\Api\Links $links ) Remove Links from the list.
setAmount ( PayPal\Api\Currency $amount ) Total amount, in U.S. dollars, requested for the applicable payouts.
setBatchStatus ( string $batch_status ) The PayPal-generated batch payout status. If the batch payout passes the preliminary checks, the status is PENDING.
setErrors ( Error $errors ) Sets Errors
setFees ( PayPal\Api\Currency $fees ) Total estimate in U.S. dollars for the applicable payouts fees.
setLinks ( PayPal\Api\Links[] $links ) Sets Links
setPayoutBatchId ( string $payout_batch_id ) The PayPal-generated ID for a batch payout.
setSenderBatchHeader ( PayoutSenderBatchHeader $sender_batch_header ) The original batch header as provided by the payment sender.
setTimeCompleted ( string $time_completed ) The time that processing for the batch was completed.
setTimeCreated ( string $time_created ) The time the batch entered processing.

Method Details

getAmount() public method

Total amount, in U.S. dollars, requested for the applicable payouts.
public getAmount ( ) : PayPal\Api\Currency
return PayPal\Api\Currency

getBatchStatus() public method

The PayPal-generated batch payout status. If the batch payout passes the preliminary checks, the status is PENDING.
public getBatchStatus ( ) : string
return string

getErrors() public method

Gets Errors
public getErrors ( ) : Error
return Error

getFees() public method

Total estimate in U.S. dollars for the applicable payouts fees.
public getFees ( ) : PayPal\Api\Currency
return PayPal\Api\Currency

getPayoutBatchId() public method

The PayPal-generated ID for a batch payout.
public getPayoutBatchId ( ) : string
return string

getSenderBatchHeader() public method

The sender-provided batch payout header.
public getSenderBatchHeader ( ) : PayoutSenderBatchHeader
return PayoutSenderBatchHeader

getTimeCompleted() public method

The time that processing for the batch was completed.
public getTimeCompleted ( ) : string
return string

getTimeCreated() public method

The time the batch entered processing.
public getTimeCreated ( ) : string
return string

setAmount() public method

Total amount, in U.S. dollars, requested for the applicable payouts.
public setAmount ( PayPal\Api\Currency $amount )
$amount PayPal\Api\Currency

setBatchStatus() public method

The PayPal-generated batch payout status. If the batch payout passes the preliminary checks, the status is PENDING.
public setBatchStatus ( string $batch_status )
$batch_status string

setErrors() public method

Sets Errors
public setErrors ( Error $errors )
$errors Error

setFees() public method

Total estimate in U.S. dollars for the applicable payouts fees.
public setFees ( PayPal\Api\Currency $fees )
$fees PayPal\Api\Currency

setPayoutBatchId() public method

The PayPal-generated ID for a batch payout.
public setPayoutBatchId ( string $payout_batch_id )
$payout_batch_id string

setSenderBatchHeader() public method

The original batch header as provided by the payment sender.
public setSenderBatchHeader ( PayoutSenderBatchHeader $sender_batch_header )
$sender_batch_header PayoutSenderBatchHeader

setTimeCompleted() public method

The time that processing for the batch was completed.
public setTimeCompleted ( string $time_completed )
$time_completed string

setTimeCreated() public method

The time the batch entered processing.
public setTimeCreated ( string $time_created )
$time_created string