This document outlines the steps for setting up the new Yahoo! Payment API for use with the Order Manager and contains sections listed in the links below. Click on a link to jump to that section, but please be sure to review the Requirements, Limitations and Considerations in the General Information section prior to setting up and using the new Yahoo! Payment API.
Setting Up the New Yahoo! Payment API in Yahoo! Store Manager
Setting Up the Order Manager to use the New Yahoo! Payment API
Once the merchant has obtained Stone Edge Technologies Inc.'s Yahoo Partner Agreement Number (see the Requirements section at the bottom of this page), they must login to their Yahoo! Store Manager and click on the Real-Time Links option.
Then click on the API Settings link.
Select the Add New Partner link.
Enter Stone Edge Technologies, Inc. as a partner by adding our Yahoo Partner Agreement Number in the Partner ID field and click Next.
Note: Stone Edge Technologies, Inc.'s Partner Agreement Number can be obtained by contacting our Sales Department as described in the Requirements section of this document.
Select the Order API and Payment API check boxes and then click the Next button.
The merchant must accept terms of service. Click the Accept button.
Continue with the next section, Setting up the Order Manager to use the New Yahoo! Payment API.
The new
Yahoo! Payment API is only for use with orders originating in Yahoo! This
interface currently CANNOT be
used with Order Manager's Manual Orders
or the Point of Sale methods of
order entry.
If the merchant will not be using either of these order entry methods, and they only have a single Yahoo! shopping cart that will use the new Yahoo! Payment API, then they can set the system parameters listed in the steps below in the main System Parameter Credit Card group.
If, however, the merchant intends to charge credit cards in Order Manager at Manual Orders or in the Point of Sale system, then the merchant will need to specify information for a different payment gateway in the main System Parameter Credit Card group (i.e. Authorize.net or PC Charge, etc.) and the new Yahoo API payment gateway parameters should be set in the Cart-Based (Special) Parameters, instead.
Go to Maintenance Menu>Maintenance>System Parameters
Select the Credit Cards entry in the box labeled Parameter Group.
Click on the CreditCardProcessor entry in the box labeled Parameters In Selected Group.
Choose YahooAPI in the box on the lower right hand corner of the form and click the Save button.
Return to the box labeled Parameters In Selected Group and select the YahooAPIGatewayStoreID parameter.
Enter your Yahoo Store ID (YHST number) in the box labeled Parameter Text and click the Save button.
Return to the box labeled Parameters In Selected Group and select the YahooAPIGatewayToken parameter.
Enter your Yahoo! Partner Store Contract Token in the box labeled Parameter Text and click the Save button.
Note: The Yahoo! Partner Store Contract Token will be sent by Yahoo! to the email address that is on file for the Yahoo! company store that is requesting the use of the API (see the previous section of this document entitled, Setting Up the New Yahoo! Payment API in Yahoo Store Manager). The figure below shows an example of what a Partner Store Contract Token looks like (highlighted in yellow).
Tip: The Yahoo! Partner Store Contract ”token” may be ”text wrapped” by their email client software - meaning that the email software may introduce carriage returns and/or line feed characters in the token. The merchant is best served by copying the token then pasting it into Wordpad or Notepad with text wrap turned off. If the token appears on a single line then it is OK. If the token appears on several lines, they will need to back out the carriage returns/line feed characters before copying and pasting into the Order Manager's System Parameters.
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.
Click the Close button the top of the Set System Parameters form.
Click the Return to Main Menu button.
The setup is now complete.
Go to System Parameters>User, PC or Cart-Based Parameters.
Click the radio button labeled "Cart ID".
In the box labeled Shopping Carts, select the name of your Yahoo cart.
Go to the box labeled Parameter Group click on Credit Cards.
Select the parameter CreditCardProcessor in the box labeled Parameters In Selected Group.
Choose the entry YahooAPI and click the Save button.
Return to the box labeled Parameters in Selected Group.
Select the YahooAPIGatewayStoreID parameter.
Enter your Yahoo Store ID (YHST number) in the box labeled Parameter Text and click the Save button.
Return to the box labeled Parameters in Selected Group.
Select the YahooAPIGatewayToken parameter.
Enter your Yahoo! Partner Store Contract Token in the box labeled Parameter Text and click the Save button.
Note: The Yahoo! Partner Store Contract Token will be sent by Yahoo! to the email address that is on file for the Yahoo! company store that is requesting the use of the API (see the previous section of this document entitled, Setting Up the New Yahoo! Payment API in Yahoo Store Manager). The figure below shows an example of what a Partner Store Contract Token looks like (highlighted in yellow).
Tip: The Yahoo! Partner Store Contract ”token” may be ”text wrapped” by their email client software - meaning that the email software may introduce carriage returns and/or line feed characters in the token. The merchant is best served by copying the token then pasting it into Wordpad or Notepad with text wrap turned off. If the token appears on a single line then it is OK. If the token appears on several lines, they will need to back out the carriage returns/line feed characters before copying and pasting into the Order Manager's System Parameters.
Click the Close button at the top of the Special System Parameters form.
Click the Close button at the top of the Set System Parameters form.
Click the Return to Main Menu button. The setup is now complete.
Yahoo! sends a warning, to the company email address on file, stating that a token is about to expire. That email provides instructions as to how to renew a token. If you did not get the email, perform the following steps:
Log in to the Store Manager and select Real-Time Links from the Order Settings column.
Then click on the API Settings link.
A list of tokens will be seen at the bottom of the following page (not pictured). Click on a token and click the Renew Selected link.
By default, the new token will be set to expire one year from the date it is renewed. Optionally, you may wish to set your own token expiry date, which may be up to five years from the date the token is renewed.
Click the "Renew Token" button. New token information will be provided to you via email. You must begin using this new token immediately, as the expired token it replaces is no longer valid.
If a token has been revoked, Yahoo! will also send an email to the address on the Yahoo! company file. This email may also be sent as a result of removing Stone Edge Technologies, Inc. from the partner list.
Re-add the SETI partner agreement number to generate a new store token (see step 4 in Setting Up the New Yahoo! Payment API in Yahoo Store Manager), or Contact Yahoo! for assistance.
When a new token is received from Yahoo!, update the Order Manager system parameter YahooAPIGatewayToken with the new value (in the Main system parameters or Cart-based parameters, depending on which group you use).
Check the values in the Order Manager system parameters. Yahoo! Partner Store Tokens are not the same across multiple Yahoo! store accounts. Make sure that the partner token information entered into the Order Manager's cart-based parameters for a given cart matches that for the appropriate Yahoo! store.
If a Partner Store token has expired or was revoked, the customer may receive an error message, as shown below, when attempting to process credit card transactions. Please note that there may be other circumstances that cause this error, as well. Refer to the instructions previously mentioned in this topic to resolve the problem; Renew Token or Revoked Token
Requirements: To utilize this interface, the user must have Order Manager 5.612 or higher installed. Before attempting to configure this feature, the merchant must have Stone Edge Technologies Inc.'s Yahoo! Partner Agreement Number. To obtain that information, contact our Sales department via email or call 610-994-3699, option 1.
Limitations: The new Yahoo! API will not have access to the Manual Transactions system in Yahoo!, so the merchant can only run transactions against orders originating in Yahoo! (a Yahoo! Order Number is required for processing). Therefore,the new Yahoo! Payment API cannot be used with the Order Manager's Manual Orders or Point of Sale systems. If a merchant uses either of those systems, another payment gateway will have to be configured in Order Manager's main system parameters to process payments for those orders. The New Yahoo! Payment API parameters should then be setup in the cart-based parameters for your Yahoo shopping cart to process payments for imported orders.
Multiple Captures against an Authorization is not supported in the Order Manager even though you may be able to do this at Yahoo (PayPal transactions only).
Multiple Credits against a Capture up to the original capture amount is not supported because that feature has not been implemented by Yahoo! as of 6/30/11.
The new Yahoo! API does not support blind credits.
Considerations: Yahoo has two different payment systems: PayPal and FDMS (First Data Corp). The following restrictions are in place depending on payment system used:
PayPal:
Authorizations can be captured. Authorizations can be voided.
Captures can be credited. Captures cannot be voided, they must be credited.
Credits cannot be voided, this must be done at Yahoo!
FDMS:
Authorizations can be captured. Authorizations cannot be voided.
Captures can be voided, the Transaction will be returned to Authorization status.
Captures can be credited.
Credits can be voided.
NOTE: If the capture was exported to an accounting application, the Order Manager will leave the original capture transaction, create a new transaction reversing the captured amount and will create a third transaction representing the original Authorization which can be captured again.
Created 6/11/2009
Modified: 6/30/2011