Yahoo! Payment API

Overview

  • This document outlines the steps for setting up the Yahoo! Payment API with Stone Edge.
  • The Yahoo! Payment API does not support reference transactions. If you are running Stone edge Version 7.1 or greater, you cannot process new payment transactions using an existing payment transaction. You have to contact the customer to get the credit card number and manually enter that information into the Payment Module to process a new payment transaction.

General Information

Requirements

  • Before attempting to configure this feature, the merchant must have Stone Edge ‘s Yahoo! Partner Agreement Number. To obtain that information, contact our Sales department via email or call 484-927-4804.

Limitations

  • The new Yahoo! API does not have access to the Manual Transactions system at 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 Stone Edge ‘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 Stone Edge ‘s main system parameters to process payments for those orders. The 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 Stone Edge 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 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, Stone Edge leaves the original capture transaction, creates a new transaction reversing the captured amount and creates a third transaction representing the original Authorization which can be captured again.

Setting Up the Yahoo! Payment API in Yahoo! Store Manager

  1. Once the merchant has obtained the Stone Edge Yahoo Partner Agreement Number, they must login to Yahoo! Store Manager and click Real-Time Links in the Order Settings section.

  1. Then click the API Settings link.

  1.  Select Add New Partner.

  1. Enter Stone Edge as a partner by adding our Yahoo Partner Agreement Number in the Partner ID field and click Next.

Note: Stone Edge ‘s Partner Agreement Number can be obtained by contacting our Sales Department as described in the Requirements section of this document.

  1. Select the Order API and Payment API check boxes and then click Next.

  1. The merchant must accept terms of service.  Click Accept.

  1. Continue with the next section, Setting up Stone Edge to use the Yahoo! Payment API.

Setting Up Stone Edge to Use the Yahoo! Payment API

The Yahoo! Payment API is only for use with orders originating at Yahoo! This interface currently CANNOT be used with Stone Edge’s Manual Orders or the Point-of-Sale methods of order entry.

If the merchant is not using either of these order entry methods, and they only have a single Yahoo! shopping cart that uses 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 Stone Edge at Manual Orders or in the Point-of-Sale system, then the merchant needs to specify information for a different payment gateway in the main system parameter Credit Card group (such as Authorize.net or PCCharge, etc.) and the new Yahoo API payment gateway parameters should only be set in the cart-based (Special) parameters, instead.

Setting Main System Parameters (less common)

  1. Go to Main Menu > Settings > System Functions > Set System Parameters.
  2. Select Credit Cards in the Parameter Group list.
  3. Select CreditCardProcessor from Parameters In Selected Group.
  4. Choose YahooAPI in the box on the lower right hand corner of the form and click Save.

  1. Return to Parameters In Selected Group and select the YahooAPIGatewayStoreID parameter.
  2. Enter your Yahoo Store ID ( YHST number) in Parameter Text and click Save.
  3. Return to Parameters In Selected Group and select the YahooAPIGatewayToken parameter.
  4. Enter your Yahoo! Partner Store Contract Token in Parameter Text and click Save.

Note: The Yahoo! Partner Store Contract Token is sent by Yahoo! to the email address that is on file for the Yahoo! company store requesting the use of the API (see the previous section of this document entitled, Setting Up the 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 Stone Edge ‘s System Parameters.

  1. 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 Stone Edge , it should be set to Pre-Authorize. If payment is captured at the web store, it should be set to Sale. Be sure to click Save after making changes to a parameter setting.
  2. The setup is now complete.

Setting Cart-Based Parameters (most common)

  1. Go to Main Menu > Settings > System Functions > Set System Parameters > PC & Cart Based Parameters.
  2. Click Shopping Cart.
  3. In Shopping Carts, select the name of your Yahoo! cart.
  4. Go to the box labeled Parameter Group and select Credit Cards.
  5. Select the parameter CreditCardProcessor in the box labeled Parameters In Selected Group.
  6. Choose YahooAPI and click Save.

  1. Return to the box labeled Parameters in Selected Group.
  2. Select the YahooAPIGatewayStoreID parameter.
  3. Enter your Yahoo Store ID ( YHST number) in the box labeled Parameter Text and Save.

  1. Return to the box labeled Parameters in Selected Group.
  2. Select the YahooAPIGatewayToken parameter.
  3. Enter your Yahoo! Partner Store Contract Token in the box labeled Parameter Text and click Save.

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 Stone Edge’s System Parameters.

  1. Click Close.
  2. The setup is now complete.

Renewing a Token

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:

  1. Log into Yahoo! Store Manager and select Real-Time Links from Order Settings section.

  1. Then click API Settings.

  1.  A list of tokens is seen at the bottom of the subsequent page (not pictured). Select a token and click Renew Selected.

By default, the new token is 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.

  1. Click Renew Token. New token information is provided to you via email.
  2. Enter the new token in the appropriate Stone Edge parameter or parameters. You must begin using this new token immediately, as the expired token it replaces is no longer valid.

Revoked Tokens

If a token is revoked, Yahoo! sends 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.

  1. 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.
  2. When a new token is received from Yahoo!, update Stone Edge system parameter YahooAPIGatewayToken with the new value (in the Main system parameters or Cart-based parameters, depending on which group you use).
  3. Enter the new token in the appropriate Stone Edge parameter or parameters. You must begin using this new token immediately, as the expired token it replaces is no longer valid.

Troubleshooting

  1. Check the values in Stone Edge system parameters. Yahoo! Partner Store Tokens are not the same across multiple Yahoo! store accounts. Make sure that the partner token information entered into Stone Edge ‘s cart-based parameters for a given cart matches the appropriate Yahoo! store.
  2. If a Partner Store token has expired or is revoked, you 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.  Refer to the instructions previously outlined in this topic to resolve the problem; Renewing a Token or Revoked Tokens.

 

Updated on June 4, 2019

Was this article helpful?

Related Articles