Class Payout

This object represents a set of payouts that includes status data for the payouts. This object enables you to create a payout using a POST request.

PayPal\Common\PayPalModel

PayPal\Common\PayPalResourceModel implements PayPal\Rest\IResource

PayPal\Api\Payout

Namespace: PayPal\Api
Package: PayPal\Api
Located at PayPal/Api/Payout.php

Methods summary

`public`	# `setSenderBatchHeader( PayPal\Api\PayoutSenderBatchHeader $sender_batch_header )` The original batch header as provided by the payment sender. The original batch header as provided by the payment sender. Parameters `$sender_batch_header` Returns $this
`public PayPal\Api\PayoutSenderBatchHeader`	# `getSenderBatchHeader( )` The original batch header as provided by the payment sender. The original batch header as provided by the payment sender. Returns `PayPal\Api\PayoutSenderBatchHeader`
`public`	# `setItems( PayPal\Api\PayoutItem[] $items )` An array of payout items (that is, a set of individual payouts). An array of payout items (that is, a set of individual payouts). Parameters `$items` Returns $this
`public PayPal\Api\PayoutItem[]`	# `getItems( )` An array of payout items (that is, a set of individual payouts). An array of payout items (that is, a set of individual payouts). Returns `PayPal\Api\PayoutItem[]`
`public`	# `addItem( PayPal\Api\PayoutItem $payoutItem )` Append Items to the list. Append Items to the list. Parameters `$payoutItem` Returns $this
`public`	# `removeItem( PayPal\Api\PayoutItem $payoutItem )` Remove Items from the list. Remove Items from the list. Parameters `$payoutItem` Returns $this
`public PayPal\Api\PayoutBatch`	# `create( array $params = array(), PayPal\Rest\ApiContext $apiContext = null, PayPal\Transport\PayPalRestCall $restCall = null )` Create a payout batch resource by passing a sender_batch_header and an items array to the request URI. The sender_batch_header contains payout parameters that describe the handling of a batch resource while the items array conatins payout items. Create a payout batch resource by passing a sender_batch_header and an items array to the request URI. The sender_batch_header contains payout parameters that describe the handling of a batch resource while the items array conatins payout items. Parameters `$params` `$apiContext` is the APIContext for this call. It can be used to pass dynamic configuration and credentials. `$restCall` is the Rest Call Service that is used to make rest calls Returns `PayPal\Api\PayoutBatch`
`public PayPal\Api\PayoutBatch`	# `createSynchronous( PayPal\Rest\ApiContext $apiContext = null, PayPal\Transport\PayPalRestCall $restCall = null )` You can submit a payout with a synchronous API call, which immediately returns the results of a PayPal payment. You can submit a payout with a synchronous API call, which immediately returns the results of a PayPal payment. Parameters `$apiContext` `$restCall` Returns `PayPal\Api\PayoutBatch`
`public static PayPal\Api\PayoutBatch`	# `get( string $payoutBatchId, PayPal\Rest\ApiContext $apiContext = null, PayPal\Transport\PayPalRestCall $restCall = null )` Obtain the status of a specific batch resource by passing the payout batch ID to the request URI. You can issue this call multiple times to get the current status. Obtain the status of a specific batch resource by passing the payout batch ID to the request URI. You can issue this call multiple times to get the current status. Parameters `$payoutBatchId` `$apiContext` is the APIContext for this call. It can be used to pass dynamic configuration and credentials. `$restCall` is the Rest Call Service that is used to make rest calls Returns `PayPal\Api\PayoutBatch`