Class: Payment_Process_Result

[line 412]
Payment_Process_Result

The core result class that should be returned from each driver's process() function. This should be extended as Payment_Process_Result_DriverName and then have the appropriate fields mapped out accordingly.

Take special care to appropriately create a parse() function in your result class. You can then call _mapFields() with a resultArray (ie. exploded result) to map your results from parse() into the member variables.

Please note that this class keeps your original codes intact so they can be accessed directly and then uses the function wrappers to return uniform Payment_Process codes.

$approvalCode =

[line 487]

Authorization/Approval code

$avsCode =

[line 504]

Address verification code

The AVS code returned from your gateway. This should then be mapped to the appropriate PAYMENT_PROCESS_AVS_* code using $_avsCodeMap. This value should also be mapped to the appropriate textual message via the $_avsCodeMessages array.

$code =

[line 449]

The approval/decline code

The value returned by your gateway as approved/declined should be mapped into this variable. Valid results should then be mapped into the appropriate PAYMENT_PROCESS_RESULT_* code using the $_statusCodeMap array. Values returned into $code should be mapped as keys in the map with PAYMENT_PROCESS_RESULT_* as the values.

$customerId =

[line 542]

Customer ID

Unique internall customer ID (ie. your company's customer ID used to track individual customers).

$cvvCode =  PAYMENT_PROCESS_CVV_NOAPPLY

[line 555]

CVV Code

The CVV code is the 3-4 digit number on the back of most credit cards. This value should be mapped via the $_cvvCodeMap variable to the appropriate PAYMENT_PROCESS_CVV_* values.

$cvvMessage =  'No CVV message from gateway'

[line 568]

CVV Message

Your cvvCode value should be mapped to appropriate messages via the $_cvvCodeMessage array. This value is merely here to hold the value returned from the gateway (if any).

$invoiceNumber =

[line 530]

Invoice Number

Unique internal invoiceNumber (ie. your company's order/invoice number that you assign each order as it is processed). It is always a good idea to pass this to the gateway (which is usually then echo'd back).

$message =  'No message from gateway'

[line 478]

Message from gateway

Map the textual message from the gateway into this variable. It is not currently returned or used (in favor of the $_statusCodeMessages map, but can be accessed directly for debugging purposes.

$messageCode =

[line 464]

Message/Response Code

Along with the response (yes/no) you usually get a response/message code that translates into why it was approved/declined. This is where you map that code into. Your $_statusCodeMessages would then be keyed by valid messageCode values.

$transactionId =

[line 517]

Transaction ID

This is the unique transaction ID, which is used by gateways to modify transactions (credit, update, etc.). Map the appropriate value into this variable.

$_rawResponse =  null

[line 432]

The raw response (ie. from cURL)

Payment_Process_Result (Constructor)   [line 570]

---

factory   [line 575]

---

getAVSCode   [line 677]

---

getAVSMessage   [line 682]

---

getCode   [line 644]

---

getCvvCode   [line 687]

---

getCvvMessage   [line 692]

---

getMessage   [line 665]

---

parse   [line 630]

---

validate   [line 593]

---