Class PayoutItem

Class PayoutItem

A sender-created definition of a payout to a single recipient.

PayPal\Common\PayPalModel

Extended by

PayPal\Common\PayPalResourceModel implements PayPal\Rest\IResource

Extended by

PayPal\Api\PayoutItem

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

Methods summary

`public`	# `setRecipientType( string $recipient_type )` The type of ID that identifies the payment receiver. Value is: EMAIL . Unencrypted email. Value is a string of up to 127 single-byte characters. PHONE . Unencrypted phone number. Note: The PayPal sandbox does not support the PHONE recipient type. PAYPAL_ID . Encrypted PayPal account number. If the sender_batch_header includes the recipient_type attribute, any payout item without its own recipient_type attribute uses the recipient_type value from sender_batch_header . If the sender_batch_header omits the recipient_type attribute, each payout item must include its own recipient_type value. The type of ID that identifies the payment receiver. Value is: EMAIL . Unencrypted email. Value is a string of up to 127 single-byte characters. PHONE . Unencrypted phone number. Note: The PayPal sandbox does not support the PHONE recipient type. PAYPAL_ID . Encrypted PayPal account number. If the sender_batch_header includes the recipient_type attribute, any payout item without its own recipient_type attribute uses the recipient_type value from sender_batch_header . If the sender_batch_header omits the recipient_type attribute, each payout item must include its own recipient_type value. Parameters `$recipient_type` Returns $this
`public string`	# `getRecipientType( )` The type of ID that identifies the payment receiver. Value is: EMAIL . Unencrypted email. Value is a string of up to 127 single-byte characters. PHONE . Unencrypted phone number. Note: The PayPal sandbox does not support the PHONE recipient type. PAYPAL_ID . Encrypted PayPal account number. If the sender_batch_header includes the recipient_type attribute, any payout item without its own recipient_type attribute uses the recipient_type value from sender_batch_header . If the sender_batch_header omits the recipient_type attribute, each payout item must include its own recipient_type value. The type of ID that identifies the payment receiver. Value is: EMAIL . Unencrypted email. Value is a string of up to 127 single-byte characters. PHONE . Unencrypted phone number. Note: The PayPal sandbox does not support the PHONE recipient type. PAYPAL_ID . Encrypted PayPal account number. If the sender_batch_header includes the recipient_type attribute, any payout item without its own recipient_type attribute uses the recipient_type value from sender_batch_header . If the sender_batch_header omits the recipient_type attribute, each payout item must include its own recipient_type value. Returns string
`public`	# `setAmount( PayPal\Api\Currency $amount )` The amount of money to pay the receiver. The amount of money to pay the receiver. Parameters `$amount` Returns $this
`public PayPal\Api\Currency`	# `getAmount( )` The amount of money to pay the receiver. The amount of money to pay the receiver. Returns `PayPal\Api\Currency`
`public`	# `setNote( string $note )` Optional. A sender-specified note for notifications. Value is any string value. Optional. A sender-specified note for notifications. Value is any string value. Parameters `$note` Returns $this
`public string`	# `getNote( )` Optional. A sender-specified note for notifications. Value is any string value. Optional. A sender-specified note for notifications. Value is any string value. Returns string
`public`	# `setReceiver( string $receiver )` The receiver of the payment. Corresponds to the `recipient_type` value in the request. The receiver of the payment. Corresponds to the `recipient_type` value in the request. Parameters `$receiver` Returns $this
`public string`	# `getReceiver( )` The receiver of the payment. Corresponds to the `recipient_type` value in the request. The receiver of the payment. Corresponds to the `recipient_type` value in the request. Returns string
`public`	# `setSenderItemId( string $sender_item_id )` A sender-specified ID number. Tracks the batch payout in an accounting system. A sender-specified ID number. Tracks the batch payout in an accounting system. Parameters `$sender_item_id` Returns $this
`public string`	# `getSenderItemId( )` A sender-specified ID number. Tracks the batch payout in an accounting system. A sender-specified ID number. Tracks the batch payout in an accounting system. Returns string
`public static PayPal\Api\PayoutItemDetails`	# `get( string $payoutItemId, PayPal\Rest\ApiContext $apiContext = null, PayPal\Transport\PayPalRestCall $restCall = null )` Obtain the status of a payout item by passing the item ID to the request URI. Obtain the status of a payout item by passing the item ID to the request URI. Parameters `$payoutItemId` `$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\PayoutItemDetails`
`public static PayPal\Api\PayoutItemDetails`	# `cancel( string $payoutItemId, PayPal\Rest\ApiContext $apiContext = null, PayPal\Transport\PayPalRestCall $restCall = null )` Cancels the unclaimed payment using the items id passed in the request URI. If an unclaimed item is not claimed within 30 days, the funds will be automatically returned to the sender. This call can be used to cancel the unclaimed item prior to the automatic 30-day return. Cancels the unclaimed payment using the items id passed in the request URI. If an unclaimed item is not claimed within 30 days, the funds will be automatically returned to the sender. This call can be used to cancel the unclaimed item prior to the automatic 30-day return. Parameters `$payoutItemId` `$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\PayoutItemDetails`

Methods inherited from PayPal\Common\PayPalResourceModel

addLink(), executeCall(), getLink(), getLinks(), removeLink(), setLinks(), updateAccessToken()

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