Search:  

You are in: Help > Specifications for API Developers > Simple Online Merchant Interface Setup

Simple Online Merchant Interface Setup
 

We have received a number of emails recently from individuals who would like to receive GoldGrams in exchange for a good or service. They have requested a simple explanation of how to set-up GoldMoney's Online Merchant Interface (OMI) at their website. In response to these requests, we have put together this short guide.

In order to set-up the OMI on your site, you need to do the following:

  1. Request GoldMoney to authorise the use of the OMI with your Holding - Log in to your Holding, and send a secure message to GoldMoney requesting the activation of the OMI for that Holding.
  2. Create 3 HTML pages - a Pay page, a Success page and a Failure page. Sample HTML pages are included below (use.html, success.html and fail.html). Although these pages are very basic, they provide the key elements necessary to handle the OMI payment of GoldGrams. These pages can easily be made to fit the look and feel of your own site.
  3. Configure the OMI settings in your Holding - In order to process the payments made by customers to your Holding, you need to set some OMI parameters for your Holding. Once GoldMoney has activated the OMI for your Holding, log in to your Holding, and you will then have a link named "OMI" available to you. Clicking on this link will direct your browser to the OMI section of your Holding, where you can then set the OMI parameters. This will ensure that the payment is made instantly to your Holding, and you can receive email notification as soon as a payment has been made.

Create 3 HTML Pages
See the HTML source code below of the three pages you will need to set-up on your website. All of the pages should be located in the same directory at your website.

 
<!-- use.html -->

<html>
<head>
<title>Pay</title>
</head>

<body>

<form action="https://secure.goldmoney.com/omi/omipmt.php" method="post">

<p>Pay $1 in gg...</p>
<p>
<!-- replace the Holding Number below with your own Holding Number -->
<input type="hidden" name="OMI_MERCHANT_HLD_NO" value="50-04-00-N">

<!-- change the value below if you want to specify another currency -->
<!-- list of currency codes is at: omi.html#table3 -->
<input type="hidden" name="OMI_CURRENCY_CODE" value="840">

<!-- specify the currency amount on which goldgram payment is based -->
<input type="hidden" name="OMI_CURRENCY_AMT" value="1">

</p>
<p>
<input type="submit" name="Submit" value="Pay">
</p>
</form>

</body>
</html>


 
<!-- success.html -->

<html>
<head>
<title>Success</title>
</head>

<body>

<!-- Change the text and link below according to your needs -->

<p>Your payment was successful.</p>

<p><a href="http://goldmoney.com/">Back to goldmoney.com</a></p>

</body>
</html>


 
<!-- fail.html -->

<html>
<head>
<title>Fail</title>
</head>

<body>

<!-- Change the text and link below according to your needs -->

<p>Your payment failed.</p>

<p><a href="http://goldmoney.com/">Back to goldmoney.com</a></p>

</body>
</html>

Configure OMI Settings
Login to your GoldMoney Holding and then go to OMI section of your Holding (if this section is not visible, then GoldMoney may not have yet activated the OMI for your Holding). Once you are able to view the OMI Details of your Holding, set them as described below (details on each of these options can be found in the OMI spec). Listed below are the options used to make the sample payment page at http://goldmoney.com/omi-use.html accept a GoldGram payment valued at US$1. The settings are:

Result URL: email:payment@goldmoney.com
(an email will be sent to this email address any time a payment using the OMI is received in the Holding)
Success URL: http://goldmoney.com/omi-success.html
Fail URL: http://goldmoney.com/omi-fail.html
(Note: you will need to change the above three settings to point to your email address and two pages on your own website)
Secret Key: <any secret key of your choosing>
(the Secret Key functionality is not used in this simplified implementation of the OMI, so simply enter any value)
Success URL Method: LINK
Fail URL Method: LINK
Payment Details Hash Method: SHA-1
Test/Live Flag: Live
Active/Inactive Flag: Active
Send Secret Key Flag: Never Send
Omit Payment Details Flag: No
Allow URL Overrides from Payment Request Form: Yes
Verify the SSL Certificate of the Result URL: No

That's it! Once you put the 3 pages on your website and configure your own settings you can begin accepting GoldGram payments for the product or service you are selling online.

Please note that the above implementation will only work for a single product or service. In order to sell multiple products or services, you will first need to have some kind of e-commerce system running on your site. However, integrating your e-commerce system with GoldMoney's OMI can be achieved with a minimum of difficulty. See the OMI spec for details.