lxbfYeaa/PayPal-PHP-SDK
Archived
Template
1
0
Fork 0
forked from LiveCarta/PayPal-PHP-SDK
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update Payouts to v1.2

Browse Source
This commit is contained in:
sdcoffey
2016-10-13 11:04:49 -07:00
parent 3f98d9f182
commit 0f3a5e6548
12 changed files with 177 additions and 153 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
lib/PayPal/Api/PayoutItem.php
View File

@@ -10,7 +10,7 @@ use PayPal\Validation\ArgumentValidator;
/**
* Class PayoutItem
*
* Sender-created description of a payout to a single recipient.
* A sender-created definition of a payout to a single recipient.
*
* @package PayPal\Api
*
@@ -23,10 +23,10 @@ use PayPal\Validation\ArgumentValidator;
class PayoutItem extends PayPalResourceModel
{
/**
* The type of identification for the payment receiver. If this field is provided, the payout items without a `recipient_type` will use the provided value. If this field is not provided, each payout item must include a value for the `recipient_type`.
* The type of ID that identifies the payment receiver. Value is:<ul><code>EMAIL</code>. Unencrypted email. Value is a string of up to 127 single-byte characters.</li><li><code>PHONE</code>. Unencrypted phone number.<blockquote><strong>Note:</strong> The PayPal sandbox does not support the <code>PHONE</code> recipient type.</blockquote></li><li><code>PAYPAL_ID</code>. Encrypted PayPal account number.</li></ul>If the <code>sender_batch_header</code> includes the <code>recipient_type</code> attribute, any payout item without its own <code>recipient_type</code> attribute uses the <code>recipient_type</code> value from <code>sender_batch_header</code>. If the <code>sender_batch_header</code> omits the <code>recipient_type</code> attribute, each payout item must include its own <code>recipient_type</code> value.
*
* @param string $recipient_type
*
*
* @return $this
*/
public function setRecipientType($recipient_type)
@@ -36,7 +36,7 @@ class PayoutItem extends PayPalResourceModel
}
/**
* The type of identification for the payment receiver. If this field is provided, the payout items without a `recipient_type` will use the provided value. If this field is not provided, each payout item must include a value for the `recipient_type`.
* The type of ID that identifies the payment receiver. Value is:<ul><code>EMAIL</code>. Unencrypted email. Value is a string of up to 127 single-byte characters.</li><li><code>PHONE</code>. Unencrypted phone number.<blockquote><strong>Note:</strong> The PayPal sandbox does not support the <code>PHONE</code> recipient type.</blockquote></li><li><code>PAYPAL_ID</code>. Encrypted PayPal account number.</li></ul>If the <code>sender_batch_header</code> includes the <code>recipient_type</code> attribute, any payout item without its own <code>recipient_type</code> attribute uses the <code>recipient_type</code> value from <code>sender_batch_header</code>. If the <code>sender_batch_header</code> omits the <code>recipient_type</code> attribute, each payout item must include its own <code>recipient_type</code> value.
*
* @return string
*/
@@ -46,10 +46,10 @@ class PayoutItem extends PayPalResourceModel
}
/**
* The amount of money to pay a receiver.
* The amount of money to pay the receiver.
*
* @param \PayPal\Api\Currency $amount
*
*
* @return $this
*/
public function setAmount($amount)
@@ -59,7 +59,7 @@ class PayoutItem extends PayPalResourceModel
}
/**
* The amount of money to pay a receiver.
* The amount of money to pay the receiver.
*
* @return \PayPal\Api\Currency
*/
@@ -69,10 +69,10 @@ class PayoutItem extends PayPalResourceModel
}
/**
* Note for notifications. The note is provided by the payment sender. This note can be any string. 4000 characters max.
* Optional. A sender-specified note for notifications. Value is any string value.
*
* @param string $note
*
*
* @return $this
*/
public function setNote($note)
@@ -82,7 +82,7 @@ class PayoutItem extends PayPalResourceModel
}
/**
* Note for notifications. The note is provided by the payment sender. This note can be any string. 4000 characters max.
* Optional. A sender-specified note for notifications. Value is any string value.
*
* @return string
*/
@@ -92,10 +92,10 @@ class PayoutItem extends PayPalResourceModel
}
/**
* The receiver of the payment. In a call response, the format of this value corresponds to the `recipient_type` specified in the request. 127 characters max.
* The receiver of the payment. Corresponds to the `recipient_type` value in the request.
*
* @param string $receiver
*
*
* @return $this
*/
public function setReceiver($receiver)
@@ -105,7 +105,7 @@ class PayoutItem extends PayPalResourceModel
}
/**
* The receiver of the payment. In a call response, the format of this value corresponds to the `recipient_type` specified in the request. 127 characters max.
* The receiver of the payment. Corresponds to the `recipient_type` value in the request.
*
* @return string
*/
@@ -115,10 +115,10 @@ class PayoutItem extends PayPalResourceModel
}
/**
* A sender-specific ID number, used in an accounting system for tracking purposes. 30 characters max.
* A sender-specified ID number. Tracks the batch payout in an accounting system.
*
* @param string $sender_item_id
*
*
* @return $this
*/
public function setSenderItemId($sender_item_id)
@@ -128,7 +128,7 @@ class PayoutItem extends PayPalResourceModel
}
/**
* A sender-specific ID number, used in an accounting system for tracking purposes. 30 characters max.
* A sender-specified ID number. Tracks the batch payout in an accounting system.
*
* @return string
*/
@@ -186,5 +186,4 @@ class PayoutItem extends PayPalResourceModel
$ret->fromJson($json);
return $ret;
}
}