Class PayoutBatchHeader

Batch header resource.

PayPal\Api\PayoutBatchHeader

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

Methods summary

`public`	# `setPayoutBatchId( string $payout_batch_id )` The PayPal-generated ID for a batch payout. The PayPal-generated ID for a batch payout. Parameters `$payout_batch_id` Returns $this
`public string`	# `getPayoutBatchId( )` The PayPal-generated ID for a batch payout. The PayPal-generated ID for a batch payout. Returns string
`public`	# `setBatchStatus( string $batch_status )` The PayPal-generated batch payout status. If the batch payout passes the preliminary checks, the status is `PENDING`. The PayPal-generated batch payout status. If the batch payout passes the preliminary checks, the status is `PENDING`. Parameters `$batch_status` Returns $this
`public string`	# `getBatchStatus( )` The PayPal-generated batch payout status. If the batch payout passes the preliminary checks, the status is `PENDING`. The PayPal-generated batch payout status. If the batch payout passes the preliminary checks, the status is `PENDING`. Returns string
`public`	# `setTimeCreated( string $time_created )` The time the batch entered processing. The time the batch entered processing. Parameters `$time_created` Returns $this
`public string`	# `getTimeCreated( )` The time the batch entered processing. The time the batch entered processing. Returns string
`public`	# `setTimeCompleted( string $time_completed )` The time that processing for the batch was completed. The time that processing for the batch was completed. Parameters `$time_completed` Returns $this
`public string`	# `getTimeCompleted( )` The time that processing for the batch was completed. The time that processing for the batch was completed. Returns string
`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 sender-provided batch payout header. The sender-provided batch payout header. Returns `PayPal\Api\PayoutSenderBatchHeader`
`public`	# `setAmount( PayPal\Api\Currency $amount )` Total amount, in U.S. dollars, requested for the applicable payouts. Total amount, in U.S. dollars, requested for the applicable payouts. Parameters `$amount` Returns $this
`public PayPal\Api\Currency`	# `getAmount( )` Total amount, in U.S. dollars, requested for the applicable payouts. Total amount, in U.S. dollars, requested for the applicable payouts. Returns `PayPal\Api\Currency`
`public`	# `setFees( PayPal\Api\Currency $fees )` Total estimate in U.S. dollars for the applicable payouts fees. Total estimate in U.S. dollars for the applicable payouts fees. Parameters `$fees` Returns $this
`public PayPal\Api\Currency`	# `getFees( )` Total estimate in U.S. dollars for the applicable payouts fees. Total estimate in U.S. dollars for the applicable payouts fees. Returns `PayPal\Api\Currency`
`public`	# `setErrors( PayPal\Api\Error $errors )` Sets Errors Sets Errors Parameters `$errors` Returns $this
`public PayPal\Api\Error`	# `getErrors( )` Gets Errors Gets Errors Returns `PayPal\Api\Error`
`public`	# `setLinks( PayPal\Api\Links[] $links )` Sets Links Sets Links Parameters `$links` Returns $this
`public PayPal\Api\Links[]`	# `getLinks( )` Gets Links Gets Links Returns `PayPal\Api\Links[]`
`public`	# `addLink( PayPal\Api\Links $links )` Append Links to the list. Append Links to the list. Parameters `$links` Returns $this
`public`	# `removeLink( PayPal\Api\Links $links )` Remove Links from the list. Remove Links from the list. Parameters `$links` Returns $this

Methods inherited from PayPal\Common\PayPalModel

__construct(), __get(), __isset(), __set(), __toString(), __unset(), fromArray(), fromJson(), getList(), setCredential(), toArray(), toJSON()

Properties summary

Properties inherited from PayPal\Common\PayPalModel

$credential

Namespaces

Classes

Class PayoutBatchHeader

Methods summary

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Methods inherited from PayPal\Common\PayPalModel

Properties summary

Properties inherited from PayPal\Common\PayPalModel