Merge pull request thephpleague#12 from rushi/XOL-2788

XOL-2788 Void an Authorize.net transaction if it has not been settled

Author: anush

src/Message/CIMAbstractRequest.php

@@ -93,4 +93,13 @@ public function getBaseData()
 
         return $data;
     }
+
+    public function sendData($data)
+    {
+        $headers = array('Content-Type' => 'text/xml; charset=utf-8');
+        $data = $data->saveXml();
+        $httpResponse = $this->httpClient->post($this->getEndpoint(), $headers, $data)->send();
+
+        return $this->response = new CIMResponse($this, $httpResponse->getBody());
+    }
 }

src/Message/CIMAbstractResponse.php

@@ -10,7 +10,7 @@
 /**
  * Authorize.Net CIM Response
  */
-class CIMAbstractResponse extends AbstractResponse
+abstract class CIMAbstractResponse extends AbstractResponse
 {
     protected $xmlRootElement = null;
 
@@ -79,6 +79,21 @@ public function getReasonCode()
         return $code;
     }
 
+    /**
+     * A reason code is the a part of the "directResponse" attribute returned by Authorize.net. This is the third
+     * element within the "directResponse" attribute which is a CSV string.
+     */
+    public function getResponseReasonCode()
+    {
+        $responseCode = null;
+        if (isset($this->data['directResponse'])) {
+            $directResponse = explode(',', (string)$this->data['directResponse']);
+            $responseCode = $directResponse[2];
+        }
+
+        return $responseCode;
+    }
+
     /**
      * Text description of the status.
      *

src/Message/CIMRefundRequest.php

@@ -9,6 +9,24 @@ class CIMRefundRequest extends CIMCaptureRequest
 {
     protected $action = "profileTransRefund";
 
+    protected $voidIfRefundFails = false;
+
+    /**
+     * @return boolean
+     */
+    public function isVoidIfRefundFails()
+    {
+        return $this->voidIfRefundFails;
+    }
+
+    /**
+     * @param boolean $voidIfRefundFails
+     */
+    public function setVoidIfRefundFails($voidIfRefundFails)
+    {
+        $this->voidIfRefundFails = $voidIfRefundFails;
+    }
+
     /**
      * Adds reference for original transaction to a partially filled request data object.
      *
@@ -25,4 +43,21 @@ protected function addTransactionReferenceData(\SimpleXMLElement $data)
         $action->transId = $transRef['transId'];
         return $data;
     }
+
+    public function send()
+    {
+        /** @var CIMResponse $response */
+        $response = parent::send();
+        $parameters = $this->getParameters();
+
+        if (!$response->isSuccessful() && $this->voidIfRefundFails &&
+            $response->getResponseReasonCode() === CIMResponse::ERROR_RESPONSE_CODE_CANNOT_ISSUE_CREDIT) {
+            // An attempt to a refund a transaction that was not settled. We can just void the entire transaction
+            $voidRequest = new CIMVoidRequest($this->httpClient, $this->httpRequest);
+            $voidRequest->initialize($parameters);
+            $response = $voidRequest->send();
+        }
+
+        return $response;
+    }
 }

src/Message/CIMResponse.php

@@ -7,6 +7,11 @@
  */
 class CIMResponse extends CIMAbstractResponse
 {
+    /**
+     * For Error codes: @see https://developer.authorize.net/api/reference/responseCodes.html
+     */
+    const ERROR_RESPONSE_CODE_CANNOT_ISSUE_CREDIT = '54';
+
     protected $xmlRootElement = 'createCustomerProfileTransactionResponse';
 
     public function getTransactionReference()

src/Message/CIMVoidRequest.php

@@ -7,15 +7,18 @@
  */
 class CIMVoidRequest extends CIMAbstractRequest
 {
+    protected $xmlRootElement = 'createCustomerProfileTransactionRequest';
     protected $action = 'voidTransaction';
 
     public function getData()
     {
         $this->validate('transactionReference');
 
         $data = $this->getBaseData();
-        $data->transactionRequest->refTransId = $this->getTransactionReference();
-        $this->addTestModeSetting($data);
+        $transRef = json_decode($this->getTransactionReference(), true);
+        if (is_array($transRef) && isset($transRef['transId'])) {
+            $data->transaction->profileTransVoid->transId = $transRef["transId"];
+        }
 
         return $data;
     }

tests/CIMGatewayIntegrationTest.php

@@ -164,15 +164,13 @@ public function testAuthorizeAndVoid()
         $this->assertTrue($response->isSuccessful(), 'Purchase transaction should get created');
         $this->assertNotNull($response->getTransactionReference(), 'Transaction reference should exist');
 
-        $transactionRef = json_decode($response->getTransactionReference(), true);
-
         // Make a refund on the purchase transaction
-        $params = array('transactionReference' => $transactionRef['transId']);
-        $request = $this->gateway->void($params);
+        $request = $this->gateway->void(array('transactionReference' => $response->getTransactionReference()));
         $request->setDeveloperMode(true);
 
         $response = $request->send();
         $this->assertTrue($response->isSuccessful(), 'Refund transaction should get created');
         $this->assertNotNull($response->getTransactionReference(), 'Transaction reference should exist');
+        $this->assertEquals('Successful.', $response->getMessage());
     }
 }

tests/CIMGatewayTest.php

@@ -220,12 +220,22 @@ public function testRefundFailure()
         $response = $this->gateway->refund($this->refundOptions)->send();
 
         $this->assertFalse($response->isSuccessful());
-        $this->assertNull(
-            $response->getTransactionReference()
-        );
+        $this->assertNull($response->getTransactionReference());
         $this->assertSame(
             'The referenced transaction does not meet the criteria for issuing a credit.',
             $response->getMessage()
         );
     }
+
+    public function testShouldVoidTransactionIfTryingToRefundAnUnsettledTransaction()
+    {
+        $this->setMockHttpResponse(array('CIMRefundFailure.txt', 'CIMVoidResponse.txt'));
+        $this->refundOptions['voidIfRefundFails'] = true;
+
+        $response = $this->gateway->refund($this->refundOptions)->send();
+
+        $this->assertTrue($response->isSuccessful());
+        $this->assertNotNull($response->getTransactionReference());
+        $this->assertEquals('Successful.', $response->getMessage());
+    }
 }

tests/Message/CIMResponseTest.php

@@ -29,4 +29,12 @@ public function testGetTransactionReference()
             $response->getTransactionReference()
         );
     }
+
+    public function testShouldReturnResponseReasonCodeFromDirectResponse()
+    {
+        $httpResponse = $this->getMockHttpResponse('CIMRefundFailure.txt')->getBody();
+        $response = new CIMResponse($this->getMockRequest(), $httpResponse);
+
+        $this->assertEquals(54, $response->getResponseReasonCode());
+    }
 }

tests/Mock/CIMVoidResponse.txt

@@ -0,0 +1,13 @@
+HTTP/1.1 200 OK
+Date: Sat, 02 Aug 2014 06:07:08 GMT
+Server: Microsoft-IIS/6.0
+Access-Control-Allow-Origin: *
+Access-Control-Allow-Methods: GET, POST, OPTIONS
+Access-Control-Allow-Headers: x-requested-with, cache-control, content-type, origin, method
+X-Powered-By: ASP.NET
+X-AspNet-Version: 2.0.50727
+Cache-Control: private
+Content-Type: text/xml; charset=utf-8
+Content-Length: 836
+
+<?xml version="1.0" encoding="utf-8"?><createCustomerProfileTransactionResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="AnetApi/xml/v1/schema/AnetApiSchema.xsd"><messages><resultCode>Ok</resultCode><message><code>I00001</code><text>Successful.</text></message></messages><directResponse>1,1,1,This transaction has been approved.,4A6ZAK,P,2252208237,,,0.00,CC,void,,,,,,,,12345,,,,,,,,,,,,,,,,,,0E3D23E0BB8AD22BDFD412B205E42308,,,,,,,,,,,,,XXXX1111,Visa,,,,,,,,,,,,,,,,</directResponse></createCustomerProfileTransactionResponse>