Differences

This shows you the differences between two versions of the page.

Link to this comparison view

enterprise service bus data handler - forte refund [2016/09/14 14:19] (current)
Line 1: Line 1:
 +====== Enterprise Service Bus Data Handler - Forte Refund ======
  
 +===== Purpose =====
 +
 +The Forte Refund data handler allows the builder to create a transaction that will charge an end user's payment method.
 +
 +//This feature will be available in Platform Version 14.12.1023//​
 +===== Supporting Elements =====
 +
 +For the Forte Refund data handler to work properly there should be several elements added to the application. ​ A [[Table|table]] should be used to track the credit transactions created to store a history of what a person has been refunded. ​ This is not strictly necessary because this data is also stored in the Forte Virtual terminal but it is highly recommended that this data be stored in the WorkXpress Application. ​  
 +
 +For an End User to receive a refund they must have entered a payment method in a [[Field Type - Forte Checkout|Forte Checkout]] field.
 +
 +===== Options =====
 +
 +There are four configuration options in this data handler.
 +
 +  * Merchant ID - This is the Merchant ID provided by Forte of the merchant receiving the money. ​ This must be the same merchant as was used to setup the Forte Checkout field. ​ Multiple merchants can not share customer tokens.
 +  * Merchant Processing Password - This is the merchant transaction processing password provided by Forte.
 +  * Forte Checkout Field - This query points to the record and Forte Checkout field that is being used to store the Customer Token and the Payment Method Token.
 +  * Refund Amount - This is the total amount of the refund and it must not contain any currency symbols.
 +
 +===== Triggering =====
 +
 +This Data Handler is triggered via an [[Action Type - Enterprise Service Bus|Enterprise Service Bus Action]]. ​ To see which actions will trigger this Data Handler use the "​Outgoing"​ tab on the [[Enterprise Service Bus|Enterprise Service Bus]] page.
 +
 +
 +===== Child Actions =====
 +
 +When this Data Handler is used in an Enterprise Service Bus Action it becomes possible to add child actions below the ESB Action. ​ Actions added to this part of the action tree will have the following runtime values available.
 +
 +  * Response Code - This is the code returned by Forte that describes the type of response for a transaction. ​ In the case of a successful transaction the value will be "​A01"​ for approved. ​ In the case of a failed transaction the code might be a numeric http error code in the case of a communication failure or a processor decline code in the case of invalid or under funded payment methods. ​ For more details about the response codes a list can be found [[https://​forte.net/​devdocs/​reference/​response_codes.htm|here]]
 +  * Response Description - This is text description of the response code.
 +  * Transaction Authorization Code - In the case of a successful credit transaction this is the authorization code provided by the payment gateway.
 +  * Transaction Trace Number - In the case of a successful credit transaction this is the identifier of the transaction.
 +  * Transaction Order Number - In the case of a successful credit transaction this is the order number created by WorkXpress to identify a transaction. ​ This id can be used to easily search for a transaction in the Forte Virtual Terminal.
enterprise service bus data handler - forte refund.txt ยท Last modified: 2016/09/14 14:19 (external edit)
Copyright WorkXpress, 2019