Merge pull request #1 from binaryminds/master

Adjustments to handle Void and Credit actions

Author: pmcelhaney

HTTPPayFlowProGateway.cfc

@@ -12,6 +12,14 @@
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      See the License for the specific language governing permissions and
      limitations under the License.
+	
+	
+	
+	PayFlowPro Components for ColdFusion
+	
+	Changes:
+	9/5/2012 Pawel Dulak: changed "chargeCard" function name to "executeTransaction"
+	
 --->
 
 <cfcomponent>
@@ -37,7 +45,7 @@
 </cffunction>
 
 
-<cffunction name = "chargeCard">
+<cffunction name = "executeTransaction">
 	<cfargument name="params">
 	<cfargument name="transactionID">
 
@@ -49,7 +57,7 @@
 
 	<cfreturn parseURLData(CFHTTP.FileContent)>
 </cffunction>
-	
+
 <cffunction name = "encodeURLData" output="no">
 	<cfargument name="params">
 	<cfset var key = 0>

PayFlowProTransaction.cfc

@@ -12,6 +12,11 @@
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      See the License for the specific language governing permissions and
      limitations under the License.
+	
+	
+	 Changes:
+	 9/5/2012 Pawel Dulak: added "credit", "void", "setBaseParams", "setReferenceTransaction" functions and a possibility to use Reference Transaction ID in "run"
+	 
 --->
 
 <cfcomponent>
@@ -20,6 +25,7 @@
 	<cfargument name="gateway">
 	<cfset variables.transactionID = CreateUUID()>
 	<cfset variables.gateway = arguments.gateway>
+	<cfset variables.origID = "">
 	<cfreturn this>
 </cffunction>
 
@@ -45,6 +51,11 @@
 	<cfset variables.cardNumber = arguments.cardNumber>
 </cffunction>
 
+<cffunction name = "setReferenceTransaction" output="no">
+	<cfargument name="pnref">
+	<cfset variables.origid = arguments.pnref>
+</cffunction>
+
 <cffunction name = "setExpirationMonthAndYear" output="no">
 	<cfargument name="month">
 	<cfargument name="year">
@@ -59,32 +70,58 @@
 		<cfreturn "">		
 	</cfif>
 </cffunction>
-	
+
 <cffunction name = "pnRef" output="no">
 	<cfif isDefined("variables.response.pnRef")>
 		<cfreturn variables.response.pnRef>
 	<cfelse>
 		<cfreturn "">		
 	</cfif>
 </cffunction>
-	
-<cffunction name="run" output="no">
+
+<cffunction name="setBaseParams" output="no">
 	<cfset var params = structNew()>
 	<cfset params.user = variables.username>
 	<cfset params.pwd = variables.password>
 	<cfset params.partner = "Verisign">
 	<cfset params.vendor = variables.vendor>
-	<cfset params.trxtype = "S">
 	<cfset params.tender = "C">
+	<cfreturn params>
+</cffunction>
+
+<cffunction name="run" output="no">
+	<cfset params = setBaseparams()>
+	<cfset params.trxtype = "S">
 	<cfset params.amt = variables.amount>
-	<cfset params.expdate = formatExpirationDate()>
-	<cfset params.acct = variables.cardNumber>
-	
-	<cfset variables.response = variables.gateway.chargeCard(params, variables.transactionID)>
-	
+	<cfif variables.origID NEQ "">
+		<cfset params.origID = variables.origID>
+	<cfelse>
+		<cfset params.expdate = formatExpirationDate()>
+		<cfset params.acct = variables.cardNumber>
+	</cfif>
+
+	<cfset variables.response = variables.gateway.executeTransaction(params, variables.transactionID)>
+
+</cffunction>
+
+<cffunction name="credit" output="no">
+	<cfset params = setBaseparams()>
+	<cfset params.trxtype = "C">
+	<cfset params.amt = variables.amount>
+	<cfset params.origID = variables.origID>
+
+	<cfset variables.response = variables.gateway.executeTransaction(params, variables.transactionID)>
+
 </cffunction>
 
+<cffunction name="void" output="no">
+	<cfset params = setBaseparams()>
+	<cfset params.trxtype = "V">
+	<cfset params.origID = variables.origID>
+
+	<cfset variables.response = variables.gateway.executeTransaction(params, variables.transactionID)>
 
+</cffunction>
 
 <cffunction name = "formatExpirationDate" output="no">
 	<cfreturn numberFormat(variables.expiresMonth, "00") & numberFormat(right(variables.expiresYear, 2), "00")>
@@ -111,6 +148,13 @@
 <cffunction name = "approved" output="no">
 	<cfreturn 0 eq resultCode()>
 </cffunction>
-		
-</cfcomponent>
 
+<cffunction name = "transactionID" output="no">
+	<cfif isDefined("variables.transactionID")>
+		<cfreturn variables.transactionID>
+	<cfelse>
+		<cfreturn -1/>
+	</cfif>
+</cffunction>
+
+</cfcomponent>

readme.txt

@@ -19,4 +19,32 @@ Result Code: #transaction.resultCode()#<br>
 Response Message: #transaction.responseMessage()#<br>
 Auth code: #transaction.authCode()#<br>
 PNREF: #transaction.pnRef()#
-</cfoutput>
+</cfoutput>
+
+Another execution possibilities:
+
+Charge Using Reference Transaction:
+
+<cfset transaction = gateway.createTransaction()>
+<cfset transaction.setVendor(vendor)>
+<cfset transaction.setUsernameAndPassword(username,password)>
+<cfset transaction.setReferenceTransaction(pnref)>	
+<cfset transaction.setAmount(amount_to_charge)>
+<cfset transaction.run()>
+
+Credit Using Reference Transaction:
+
+<cfset transaction = gateway.createTransaction()>
+<cfset transaction.setVendor(vendor)>
+<cfset transaction.setUsernameAndPassword(username,password)>
+<cfset transaction.setReferenceTransaction(pnref)>	
+<cfset transaction.setAmount(amount_to_credit)>
+<cfset transaction.credit()>
+
+Void Transaction Using Reference Transaction:
+
+<cfset transaction = gateway.createTransaction()>
+<cfset transaction.setVendor(vendor)>
+<cfset transaction.setUsernameAndPassword(username,password)>
+<cfset transaction.setReferenceTransaction(pnref)>	
+<cfset transaction.void()>