Note to payer property

lib/PayPal/Api/Capture.php

@@ -22,6 +22,7 @@
  * @property string parent_payment
  * @property string invoice_number
  * @property \PayPal\Api\Currency transaction_fee
+ * @property string note_to_payer
  * @property string create_time
  * @property string update_time
  * @property \PayPal\Api\Links[] links
@@ -214,6 +215,29 @@ public function getTransactionFee()
         return $this->transaction_fee;
     }
 
+    /**
+     * A free-form field that clients can use to send a note to the payer.
+     *
+     * @param string $note_to_payer
+     *
+     * @return $this
+     */
+    public function setNoteToPayer($note_to_payer)
+    {
+        $this->note_to_payer = $note_to_payer;
+        return $this;
+    }
+
+    /**
+     * A free-form field that clients can use to send a note to the payer.
+     *
+     * @return string
+     */
+    public function getNoteToPayer()
+    {
+        return $this->note_to_payer;
+    }
+
     /**
      * The date and time of capture, as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6).
      *

sample/payments/AuthorizationCapture.php

@@ -5,6 +5,7 @@
 // API used: /v1/payments/payment
 // https://developer.paypal.com/docs/api/#capture-an-authorization
 
+require __DIR__ . '/../bootstrap.php';
 use PayPal\Api\Amount;
 use PayPal\Api\Authorization;
 use PayPal\Api\Capture;
@@ -29,6 +30,7 @@
     ### Capture
     $capture = new Capture();
     $capture->setAmount($amt);
+    $capture->setNoteToPayer("Contact us for any questions on your order.");
 
     // Perform a capture
     $getCapture = $authorization->capture($capture, $apiContext);

tests/PayPal/Test/Api/CaptureTest.php

@@ -19,7 +19,7 @@ class CaptureTest extends TestCase
      */
     public static function getJson()
     {
-        return '{"id":"TestSample","amount":' .AmountTest::getJson() . ',"is_final_capture":true,"state":"TestSample","reason_code":"TestSample","parent_payment":"TestSample","invoice_number":"TestSample","transaction_fee":' .CurrencyTest::getJson() . ',"create_time":"TestSample","update_time":"TestSample","links":' .LinksTest::getJson() . '}';
+        return '{"id":"TestSample","amount":' .AmountTest::getJson() . ',"is_final_capture":true,"state":"TestSample","reason_code":"TestSample","parent_payment":"TestSample","invoice_number":"TestSample","transaction_fee":' .CurrencyTest::getJson() . ',"note_to_payer":"Contact us for any questions on your order.","create_time":"TestSample","update_time":"TestSample","links":' .LinksTest::getJson() . '}';
     }
 
     /**
@@ -48,6 +48,7 @@ public function testSerializationDeserialization()
         $this->assertNotNull($obj->getParentPayment());
         $this->assertNotNull($obj->getInvoiceNumber());
         $this->assertNotNull($obj->getTransactionFee());
+        $this->assertNotNull($obj->getNoteToPayer());
         $this->assertNotNull($obj->getCreateTime());
         $this->assertNotNull($obj->getUpdateTime());
         $this->assertNotNull($obj->getLinks());
@@ -69,6 +70,7 @@ public function testGetters($obj)
         $this->assertEquals($obj->getParentPayment(), "TestSample");
         $this->assertEquals($obj->getInvoiceNumber(), "TestSample");
         $this->assertEquals($obj->getTransactionFee(), CurrencyTest::getObject());
+        $this->assertEquals($obj->getNoteToPayer(), "Contact us for any questions on your order.");
         $this->assertEquals($obj->getCreateTime(), "TestSample");
         $this->assertEquals($obj->getUpdateTime(), "TestSample");
         $this->assertEquals($obj->getLinks(), LinksTest::getObject());