Merge pull request #121 from fraterblack/master

Implemented RestRefundCaptureRequest to refund captured payments. And RestVoidRequest to void a previously authorized payments

Author: delatbabel

src/Message/RestRefundCaptureRequest.php

@@ -0,0 +1,36 @@
+<?php
+/**
+ * PayPal REST Refund Captured Payment Request
+ */
+
+namespace Omnipay\PayPal\Message;
+
+/**
+ * PayPal REST Refund Captured Payment Request
+ *
+ * Use this call to refund a captured payment.
+ *
+ * @link https://developer.paypal.com/docs/api/#refund-a-captured-payment
+ * @see RestAuthorizeRequest
+ * @see RestCaptureRequest
+ */
+class RestRefundCaptureRequest extends AbstractRestRequest
+{
+    public function getData()
+    {
+        $this->validate('transactionReference');
+
+        return array(
+            'amount' => array(
+                'currency' => $this->getCurrency(),
+                'total' => $this->getAmount(),
+            ),
+            'description' => $this->getDescription(),
+        );
+    }
+
+    public function getEndpoint()
+    {
+        return parent::getEndpoint() . '/payments/capture/' . $this->getTransactionReference() . '/refund';
+    }
+}

src/Message/RestVoidRequest.php

@@ -0,0 +1,28 @@
+<?php
+/**
+ * PayPal REST Void an authorization
+ */
+
+namespace Omnipay\PayPal\Message;
+
+/**
+ * PayPal REST Void an authorization
+ *
+ * Use this call to void a previously authorized payment.
+ * Note: A fully captured authorization cannot be voided.
+ *
+ * @link https://developer.paypal.com/docs/api/#void-an-authorization
+ * @see RestAuthorizeRequest
+ */
+class RestVoidRequest extends AbstractRestRequest
+{
+    public function getData()
+    {
+        $this->validate('transactionReference');
+    }
+
+    public function getEndpoint()
+    {
+        return parent::getEndpoint() . '/payments/authorization/' . $this->getTransactionReference() . '/void';
+    }
+}

src/RestGateway.php

@@ -441,6 +441,20 @@ public function authorize(array $parameters = array())
         return $this->createRequest('\Omnipay\PayPal\Message\RestAuthorizeRequest', $parameters);
     }
 
+    /**
+     * Void an authorization.
+     *
+     * To to void a previously authorized payment.
+     *
+     * @link https://developer.paypal.com/docs/api/#void-an-authorization
+     * @param array $parameters
+     * @return \Omnipay\PayPal\Message\RestVoidRequest
+     */
+    public function void(array $parameters = array())
+    {
+        return $this->createRequest('\Omnipay\PayPal\Message\RestVoidRequest', $parameters);
+    }
+
     /**
      * Capture an authorization.
      *
@@ -458,7 +472,20 @@ public function capture(array $parameters = array())
     }
 
     // TODO: Authorizations with payment_method == paypal.
-    // TODO: Look up and refund captured payments.
+
+    /**
+     * Refund a Captured Payment
+     *
+     * To refund captured payments (authorization transaction) created by a authorize request.
+     *
+     * @link https://developer.paypal.com/docs/api/#refund-a-captured-payment
+     * @param array $parameters
+     * @return \Omnipay\PayPal\Message\RestRefundCaptureRequest
+     */
+    public function refundCapture(array $parameters = array())
+    {
+        return $this->createRequest('\Omnipay\PayPal\Message\RestRefundCaptureRequest', $parameters);
+    }
 
     //
     // Sale Transactions -- Get and refund completed payments (sale transactions).

tests/RestGatewayTest.php

@@ -245,4 +245,38 @@ public function testReactivateSubscription()
         $this->assertTrue($response->isSuccessful());
         $this->assertNull($response->getMessage());
     }
+
+    public function testRefundCapture()
+    {
+        $request = $this->gateway->refundCapture(array(
+            'transactionReference' => 'abc123'
+        ));
+
+        $this->assertInstanceOf('\Omnipay\PayPal\Message\RestRefundCaptureRequest', $request);
+        $this->assertSame('abc123', $request->getTransactionReference());
+        $endPoint = $request->getEndpoint();
+        $this->assertSame('https://api.paypal.com/v1/payments/capture/abc123/refund', $endPoint);
+        
+        $request->setAmount('15.99');
+        $request->setCurrency('BRL');
+        $request->setDescription('Test Description');
+        $data = $request->getData();
+        // we're expecting an empty object here
+        $json = json_encode($data);
+        $this->assertEquals('{"amount":{"currency":"BRL","total":"15.99"},"description":"Test Description"}', $json);
+    }
+
+    public function testVoid()
+    {
+        $request = $this->gateway->void(array(
+            'transactionReference' => 'abc123'
+        ));
+
+        $this->assertInstanceOf('\Omnipay\PayPal\Message\RestVoidRequest', $request);
+        $this->assertSame('abc123', $request->getTransactionReference());
+        $endPoint = $request->getEndpoint();
+        $this->assertSame('https://api.paypal.com/v1/payments/authorization/abc123/void', $endPoint);
+        $data = $request->getData();
+        $this->assertEmpty($data);
+    }
 }