Note: This topic refers to the older Yahoo! Credit Card Gateway (screen scraper) system that relies on the YSI.dll. It does not apply to the new Yahoo! API for payment processing. Refer to Using the New Yahoo! Payment API for more information.
Order Manager Versions 5.921 and higher do not support the older Yahoo payment gateway; the new Yahoo! API must be implemented to be compatible with either of these versions.
Using the Yahoo Credit Card gateway with the Order Manager requires a third party application to allow the user to have full credit card functionality directly through your Yahoo Store Manager. The system allows you to run Authorizations, Sales, Captures, Credits and Voids either against an existing Yahoo Order or through the Manual Transaction processor in Yahoo. The Order Manager determines whether to use the View Orders screen or the Enter Orders Manually screen automatically prior to transmitting the transaction. The decision is based on whether there is an existing sale or credit associated with the Yahoo order in the Order Manager and the source of the transaction (the Web or a manual transaction).
Yahoo only allows one credit card sale per Yahoo order, so if an order already has a sale (or capture) against it in the Order Manager, additional sales for the same order are directed through the Manual Transactions screen.
Yahoo only allows only one credit per Yahoo order, so if an order already has a credit against it in the Order Manager, additional credits applied to the same order are directed through the Manual Transactions screen.
Keep in mind that if you run any credit card transactions at your Yahoo Store Manager AFTER downloading the order to the Order Manager, the Order Manager will NOT be aware of the new transaction, which may cause an error condition when running additional sales or credits. It is highly recommended to handle all card processing through the Order Manager to avoid this potential problem.
The Order Manager (version 3.7 Beta and higher) allows you to assign credit card processors on a per shopping cart basis. For each Yahoo store you can specify different login information to access the credit card functionality of that specific store. Start by setting the appropriate System Parameters.
Go to the Maintenance Menu> Maintenance Tab> Set System Parameters, then click the User, PC & Cart Based Parameters button to open the Special System Parameters form.
In the Show Special Parameters For list box, click on Cart ID to display all of your shopping carts in the Shopping Carts List.
Select the Yahoo store that you wish to configure (if your Yahoo store is not on the list, go to the Shopping Carts form found at Maintenance Menu> Cart Functions tab> Create & Edit Shopping Carts and create the shopping cart).
Click on the Credit Card parameter group.
Set CreditCartProcessor to Yahoo.
Set YahooGatewayPassword to the password you use to login to the Yahoo Store Manager.
Set YahooGatewaySecurityKey to the Security Key you use to login to the Yahoo Store Manager.
Set YahooGatewayShowBrowser to True if you want to view the transaction activity at Yahoo while each payment is processed. Under normal circumstances this should be False unless you experience problems with the Yahoo gateway system. By showing the browser window you may be able to determine where the process is failing. For assistance, contact Stone Edge Technologies, Inc. at (610) 994-3699 Monday through Friday, 9 a.m. to 6 p.m. EST.
Set YahooGatewayStoreID to the name of your Yahoo store (WARNING: this is case sensitive!).
Set YahooGatewayUserID to the User Name you use to login to the Yahoo Store Manager.
Check the settings of the main and/or cart-based system parameter, WebTransactionType to make sure it agrees with your workflow. The choices are Pre-Authorize or Sale. If payments will be captured via the Order Manager, it should be set to Pre-Authorize. If payment is captured at the web store, it should be set to Sale.
Repeat steps above for any additional Yahoo Stores that you may have in the Shopping Carts List.
The Order Manager requests a card authorization at the time the order is imported if you set the credit card group system parameter PreAuthAtImport to True. Or you can get the authorization at the CCTerminal by clicking Get Data From Order (on the right side of the CCTerminal tab), clicking the Authorization radio button (on the left side of the CCTerminal), and then clicking Transmit to send the authorization request to Yahoo.
If the Yahoo Order does not have any transactions against it, the Order Manager runs the transaction against the order. If the order already has a sale transaction associated with it then the authorization is run through the Manual Transaction feature in Yahoo so you will not see a record of the transaction on the order screen in Yahoo.
You can also run an authorization from the Order Manager's Manual Orders screen for orders that did not originate in Yahoo. The Order Manager (version 3.7 Beta or later) has a drop-down list just above the order total columns on the Manual Orders form that lets you select a shopping cart to associate the new order with prior to running an authorization. By selecting a shopping cart from the list, you can direct the authorization through the gateway used for that shopping cart, and you can also use that cart's report and email parameter settings for communications with the customer. Transactions run from the Manual Orders screen are directed through Yahoo's Manual Transactions system.
For Yahoo Stores that perform a credit card authorization at the website, the Order Manager can capture the authorization during import, when the order is approved either at the View Orders screen or the Multi-Order Processor, or at the CCTerminal.
To capture the payment when the order is approved set CaptureApprovedOrdersAtImport system parameter (in the Credit Card group) to True. If the Order Manager can automatically approve the order (based on the Approval Rules defined in the system), it runs the capture against the authorization.
If you prefer to capture at the time of approval at the View Orders screen, set CaptureAtManualApproval system parameter (in the Credit Card group) to True. This displays card information on the Approval Options form (the form with the calendar) and captures any existing authorization when you click one of the "Approve and..." buttons.
The Multi-Order Processor can also run the capture based on the settings applied prior to processing the orders.
To capture in the CCTerminal, select the authorization transaction at the bottom of the CCTerminal. The system automatically selects the transaction type "capture". Adjust the amount to capture (if necessary) and then click Transmit.
The capture against the Authorization is directed to either the Yahoo order or the Manual Transactions system based on the Transaction ID associated with the authorization. If the authorization was done directly against the order (either in Yahoo or in Order Manager) the Order Manager will NOT receive a Transaction ID and will direct the capture transaction to the Yahoo order. If the authorization was run through the Manual Transaction system in Yahoo, then Order Manager does receive a Transaction ID number and directs any capture transaction through the Manual Transaction system in Yahoo (for authorizations run in the Order Manager only).
If a credit card "sale" is run at the Yahoo site, then you are paid for the order at the time the order is submitted. No additional processing is required in the Order Manager to collect the funds.
A sale against the credit card can be run at the time the order is imported by setting ChargeCardsAtImport system parameter (in the Credit Card group) to True. If an order is Approved by the import process, this parameter tells the Order Manager to run a sale against the credit card for the shippable balance due on the order.
Sales can also be run at the Multi-Order Processor based on the settings established prior to processing or at the View Orders>CCTerminal tab by clicking the Get Data From Order button, which causes the system to default to a "sale" transaction. Adjust the sale amount as needed and then click Transmit to send the transaction to Yahoo.
If the order was originally imported from Yahoo and does not have any credit card sales (or captures) associated with it in the Order Manager, then the Order Manager directs the sale transaction to the Yahoo order system. If the order already has an existing sale (or capture) in the Order Manager then the new sale is directed to the Manual Transaction system in Yahoo.
You can Void a Sale or a Credit through the Yahoo system but it can only be done at the View Orders screen on the CCTerminal tab. Select the Sale or Credit transaction that you want to void at the bottom of the CCTerminal. Set the transaction type to Void, then click the Transmit button. If the sale or credit transaction was associated with a Yahoo order (i.e. it has no Transaction ID) then the Void transaction will also be directed to the order. If the transaction was run through the Manual Transaction system (i.e. it has a Transaction ID) then the void will be directed to the Manual Transaction System in Yahoo.
Credits can only be issued at the CCTerminal. To issue a credit, select the sale or capture transaction that you want to credit. If there is a credit is due on the current order, the transaction type defaults to Credit. Revise the credit amount (if necessary) and then click the Transmit button. If the order originated in Yahoo and no other credits exist in the Order Manager, the credit transaction is directed to the Yahoo order. If a credit transaction already exists in the Order Manager, the new credit is directed to the Manual Transactions system in Yahoo.
Upon completion of the transaction in Yahoo, you should receive a message
that shows "Approved" or "Declined" based on the transaction's
result. If you receive an error message, contact Stone Edge Technologies,
Inc. with the error number and message displayed. Our technical support
staff will ask you to turn on debug mode for Yahoo processing.
If you run a Sale or Authorization transaction in the Order Manager, you
receive information regarding the AVS test performed on the card and the
Authorization code issued by the card issuing bank. CVV2 (CVV) testing
is currently not supported but should be added shortly as Yahoo improves
their card services to include that feature.
See Also
Using the New Yahoo! Payment API
Updated: 3/28/11