PHP Class PayPal\Api\PayoutBatch

The PayPal-generated batch status.
Inheritance: extends PayPal\Common\PayPalModel
Show file Open project: paypal/rest-api-sdk-php Class Usage Examples

Public Methods

Method Description
addItem ( PayoutItemDetails $payoutItemDetails ) Append Items to the list.
getBatchHeader ( ) : PayoutBatchHeader A batch header. Includes the generated batch status.
getItems ( ) : PayoutItemDetails[] An array of items in a batch payout.
getLinks ( ) : PayPal\Api\Links[] Gets Links
removeItem ( PayoutItemDetails $payoutItemDetails ) Remove Items from the list.
setBatchHeader ( PayoutBatchHeader $batch_header ) A batch header. Includes the generated batch status.
setItems ( PayoutItemDetails[] $items ) An array of items in a batch payout.
setLinks ( PayPal\Api\Links[] $links ) Sets Links

Method Details

addItem() public method

Append Items to the list.
public addItem ( PayoutItemDetails $payoutItemDetails )
$payoutItemDetails PayoutItemDetails

getBatchHeader() public method

A batch header. Includes the generated batch status.
public getBatchHeader ( ) : PayoutBatchHeader
return PayoutBatchHeader

getItems() public method

An array of items in a batch payout.
public getItems ( ) : PayoutItemDetails[]
return PayoutItemDetails[]

removeItem() public method

Remove Items from the list.
public removeItem ( PayoutItemDetails $payoutItemDetails )
$payoutItemDetails PayoutItemDetails

setBatchHeader() public method

A batch header. Includes the generated batch status.
public setBatchHeader ( PayoutBatchHeader $batch_header )
$batch_header PayoutBatchHeader

setItems() public method

An array of items in a batch payout.
public setItems ( PayoutItemDetails[] $items )
$items PayoutItemDetails[]