Developer Tools Overview

Easy, customized Shop Systems integration

Add OKPAY as a payment option on your website!

There are different ways of integrating your business with OKPAY. We offer various integration options, which makes them suitable for all users, from beginners who are newcomers in the world of electronic commerce to seasoned Internet tycoons who wish to advance their prosperous online businesses to a new level.

For all users, including those not running a website

Marketplace - Start selling your goods or services to the whole OKPAY community now! Using the Marketplace, you can set up your own online store in just a quarter of an hour while not necessarily having any special programming skills.

For users with their own website(s)

E-commerce Systems – Using a shopping cart for your online store provides a quick and easy online shopping experience for your customers. OKPAY is linked to the widest range of shopping carts giving you the ultimate in choice to suit your business needs.

Payment Links and Buttons – These objects can be easily created using our configuration forms. No programming skills are required, so simple text links or secure encrypted buttons can be added to your website in seconds. You can add many parameters to suit your product or service. Our Payment Links & Buttons Generator can be found in your OKPAY Profile » Merchant section.

OKPAY Seal represents a graphic proof of your genuine OKPAY account. This is similar to presenting your credentials to a prospective business partner prior to negotiating a deal.

For users with programming skills

We have various types of API (Application Programming Interface) functionality.

Payment Notification (IPN) - OKPAY messaging service that sends out transaction-related notifications. Once IPN is integrated, sellers do not have to wait for actual payments to come in, thus being able to better automate their back office.

Program Interfaces (API) - Full payment functionality integration for website developers. This is for more complex requirements and should fill the bill if you have prior knowledge of API/website development.

Marketplace

Increase the visibility of your products and services, advertise and sell your goods and expertise in the OKPAY Marketplace.
Using the Marketplace, you can set up your own online store in just a quarter of an hour while not necessarily having any special programming skills.
Your products will be presented to the wide and varied community of OKPAY users, thus increasing sales of your goods, services, subscriptions, etc. The most popular products will be displayed on the main page of the okpay.com website, as well as in registered users’ private space. As a result your products will feature as exclusive offers to a community of well-heeled buyers who will only need one click of the mouse to make a purchase!
To get started with the Marketplace, simply register in the Profile -> Merchant -> Marketplace section and then provide a description of your products or services.
To make it quite simple, a product or service specification can comprise just three fields: title, description, and price. In addition, you can upload images, associate your product with your existing catalogue (price list or database) using the field "Item No.", indicate the available quantity of the product in stock (with every purchase, this value will be automatically reduced accordingly) and provide other information.
Navigate to the Marketplace stock manager within your account, add your goods, services or digital products to the catalogue -- and start making money, all in a matter of minutes!
Additionally, if you have sufficient programming skills, you can automate the sales and stock management routine as described elsewhere in Program Interfaces.

Payment Links & Buttons Overview

Start accepting OKPAY, the world’s most convenient electronic currency. Turn your website into an online store today!

Purchasing with a few mouse clicks

Your customers will pay you with just a few mouse clicks. A typical payment routine is as follows.
1. You place a payment link (button) for any of your goods or services on a page on your website.
2. A visitor clicks on this link and is transferred to a payment processing page at OKPAY. This page may contain a logo, title and description of your online store. Optionally, you can specify your phone number, email address and/or the URL of customer support. All these details will be displayed at the top of the payment processing page, so your client will be able to ask you for support in case of problems or if they have any questions about the purchase.
3. Once the customer has paid, he/she returns to your website, to the page that you specify in the auto-return URL.
Your visitor stays on your website while making the purchase.

Creating payment links and buttons

Step-by-step generation of payment links

Your site is up, but how are customers going to pay you? The OKPAY payment links and buttons creation wizard is the fastest way to set up online payment on your website via OKPAY.
You will find this wizard very handy if you only sell a few products or services. If yours is a big business, however, we recommend that you use another option -- see below.

Automatic creation of payment links

If your website sells goods or services in large volumes or if your products (their description, prices, etc.) are stored in a database, you will need to be able to create purchase links automatically, i.e. "on the fly".
These automatically generated payment links will look and work exactly like those created by the wizard; however, they are made with the help of “API variables” of which, of course, we provide a detailed description as regards their purpose, default values, maximum length, etc. Check out Variable Reference to be able to fully employ the functionality of the OKPAY payment system.

E-commerce systems working with OKPAY

We have made integration a simple task which will not require extraordinary programming skills. Go to Supported E-commerce Systems to see a steadily growing list of e-commerce shopping scripts and systems that has already been integrated with OKPAY.

Payment Links & Buttons Creation

OKPAY Payment Links & Buttons generator form provides a simple, step by step method to getting you up and running with your account.
OKPAY static payment link service allows merchants to receive payments securely, without having to integrate their online stores to the OKPAY transaction processing service. With static payment link, you only have to embed one or more HTML links – which OKPAY provides – into your store’s Web page. This link takes your customer to a secure payment page transparently hosted by OKPAY. The customer provides all the required payment information and then confirm payment. That’s all it takes for the purchase to be debited from payment option of customer choice and settled in your OKPAY account.
If you have required technical skills you can also create payment links and buttons automatically using information in our Payment Links & Buttons Variable Reference.

How to create an OKPAY Payment Link or Button

Adding a payment button to your website could not be easier! You can set up the button in about 5 minutes with no advanced programming skills required.
Firstly, log in to your account with OKPAY and go to: Profile -> Merchant -> Payment Links & Buttons. There you will see a special form allowing you to create your payment link or button in two easy steps.

Describe your item

Choose in that wallet this purchase will be placed, then select item type and provide it's name visible for your customers. Optionally, you can specify item's article number for tracking purchase in your database.

You can set the price, or your customer can decide how much he wants to pay

You have the option of allowing the customer or shopper to enter the price or payable amount or you can set the price and hard-code the amount to be paid. Leave Amount field blank to allow your customers to send any amount.

Choose a graphic for your payment button

You can choose from many different graphics or you can just create a link. This link can be put in an email or chat message and instantly sent to your customer or payer.

...and many others.

Provide advanced options if needed

These settings are optional and hidden from visitor's eyes by default. You shoud click to Show extra details to provide this extra information, that includes: custom Sucess and Fail URLs, custom IPN URL, etc.

Use your payment button or link anywhere

To use the payment tool obtained as described above, 'copy' the OKPAY code of your preferred payment image and insert it in your website, send via email or IM, etc.

Variable Reference

Using our API you can programmatically create payment buttons and links which are the same kind of buttons and links that you can create from your OKPAY Profile.

Generated payment link code

When you create a button, OKPAY responds by generating code that you can paste into your web page or document.
The generated code includes:

HTML code to put the button on a web page;
URL link code for adding buttons to emails and documents that support links.

This example shows HTML code for displaying a Buy Now button to sell a Robot:

<form   method="post" action="https://www.okpay.com/process.html"><input  type="hidden" name="ok_receiver" value="your@email.com" /> <input type="hidden" name="ok_item_1_name" value="Robot" /> <input type="hidden" name="ok_currency" value="usd" /> <input type="hidden" name="ok_item_1_type" value="service" /> <input type="hidden" name="ok_item_1_price" value="100" /> <input type="image" name="submit" alt="OKPAY Payment"  src="https://www.okpay.com/img/buttons/x03.gif"/></form>

OKPAY-generated code for a link would be as follows:

Specifying HTML variables

When you create a button, you must specify the same HTML variables that you use when generating Payment Links and Buttons in your account profile.
The following table provides additional information about these variables.

HTML Variable	Required or Optional	Description	Length, characters
Receiver information
`ok_receiver`	Required	One of the following: Email address / Cellphone number or Wallet ID.	127
Payment information
`ok_currency`	Optional	The currency of the payment. The default is EUR. For valid values see Currency Codes.	3
`ok_invoice`	Optional	Invoice reference number or ID. Pass-through variable for you to track the product or service purchased or contribution made. The value you specify is passed back to you upon payment completion (you can use it in your IPN handler or Auto Return URLs).	127
`ok_fees`	Optional	This field can assume one of two values. “0” – commission payable by the merchant (default); “1” – commission payable by the buyer.	1
`ok_item_#_name`	Required	Name of item.	127
`ok_item_#_article`	Optional	Item article number. Pass-through variable for you to track the product or service purchased or contribution made. The value you specify is passed back to you upon payment completion (you can use it in your IPN handler or Auto Return URLs).	40
`ok_item_#_type`	Optional	One of item types. The default is `digital`.	64
`ok_item_#_quantity`	Optional	Number of items as entered by your customer or as passed by you, the merchant. This will multiply the amount if greater than one.	8
`ok_item_#_price`	Optional	Item price. Limitations: the value must be a positive number; no currency symbol; must have two decimal places, the decimal separator must be a period (.) and the optional thousands separator must be a comma (,). Total amount for each item will be calculated as follows: ItemTotal = `ok_item_#_price` * `ok_item_#_quantity` + `ok_item_#_tax` + `ok_item_#_handling` + ShippingTotal (see bottom);	15
`ok_item_#_handling`	Optional	Used only when the merchant applies a handling charge for a specific item.	15
`ok_item_#_shipping`	Optional	Used only when the merchant applies a shipping charge for a specific item. Total shipping for each item will be calculated as follows: ShippingTotal = `ok_item_#_shipping` + `ok_item_#_shipping2` * (`ok_item_#_quantity` -1);	15
`ok_item_#_shipping2`	Optional	The cost of shipping for each additional item.	15
`ok_item_#_tax`	Optional	Used only when the merchant applies a tax charge for a specific item.	15
`ok_item_#_custom_1_title`	Optional	Custom field 1 title as passed by you, the merchant.	127
`ok_item_#_custom_1_value`	Optional	Custom field 1 value as entered by your customer or as passed by you, the merchant.	127
`ok_item_#_custom_2_title`	Optional	Custom field 2 title as passed by you, the merchant.	127
`ok_item_#_custom_2_value`	Optional	Custom field 2 value as entered by your customer or as passed by you, the merchant.	127
Payer information
If this information is provided, it will be used to pre-fill the appropriate fields of the registration form for the new OKPAY client.
General
`ok_payer_first_name`	Optional	Customer’s first name.	64
`ok_payer_last_name`	Optional	Customer’s last name.	64
`ok_payer_business_name`	Optional	Customer’s company name, if the customer is a business.	127
`ok_payer_email`	Optional	Customer’s email address.	127
`ok_payer_phone`	Optional	Customer’s telephone number.	20
Address
`ok_payer_country_code`	Optional	ISO 3166 country code associated with customer’s address.	2
`ok_payer_country`	Optional	Country of customer’s address.	64
`ok_payer_city`	Optional	City of customer’s address.	40
`ok_payer_state`	Optional	State/province of customer’s address.	40
`ok_payer_street`	Optional	Customer’s street address.	200
`ok_payer_zip`	Optional	Zip/postal code of customer’s address.	20
Extra information
`ok_return_success`	Optional	The URL to which the payer’s browser is redirected after completing the payment; for example, a URL on your site that displays a “Thank you for your payment” page. By default the browser is redirected to an OKPAY web page.	127
`ok_return_fail`	Optional	A URL to which the payer’s browser is redirected if payment is cancelled; for example, a URL on your website that displays a “Payment Canceled” page. By default the browser is redirected to an OKPAY web page.	127
`ok_ipn`	Optional	The URL to which OKPAY posts information about the transaction, in the form of Instant Payment Notification messages.	127
`ok_language`	Optional	The language of the login or sign-up page for a payer. If unspecified, the language is determined by an OKPAY cookie in the customer’s browser. If there is no OKPAY cookie, the language is selected automatically by IP address or browser language.

Auto Return URLs

With Auto Return, your customers are redirected back to your site immediately after clicking the Pay button on the Payment Confirmation page.
Auto Return applies to all OKPAY website payments, including Buy Now, Donations, Subscriptions, and Shopping Cart.
Your customers enjoy a streamlined checkout experience and are returned back to your site quickly!

How Auto Return works

Setting up Auto Return

To set up Auto Return:

Log in and click on Profile under My Account.
Click the Wallets and Currencies link under Account preferences.
Choose a wallet for which you want to set up Auto Return and click Properties.
In wallet properties click on the Integration tab.
Enter the success and fail Return URLs.

Return URL requirements

The following is required to set up Auto Return.

Success URL

In accordance with the user agreement, you must provide verbiage on the page displayed by the Return URL that will help the customer understand that the payment has been made and the transaction has been completed.
You must also provide verbiage on the page displayed by the Return URL that explains that the payment details will be emailed to the buyer.
Example: Thank you for your payment. Your transaction has been completed and a receipt for your purchase has been emailed to you. You can log in to your account at www.okpay.com to view the details of this transaction.

Fail URL

This is the URL address of a web page that the customer will be redirected to by OKPAY if he cancels his payment or the payment fails.

Variables passed to Auto Return URLs

To inform the customer about the operation, your Auto Return pages can use the same variables as those received by the IPN listener.
Please note you should not use Auto Return pages for any purpose other than informing users about the success or failure of the transaction because in some situations these pages may not be called. For example, the user can close the window immediately after payment. Conversely, an IPN URL is always called so all the necessary post-purchase procedures will be performed.

Overriding return URLs for specific payments

The Return URLs will be applied to all payments to a certain wallet unless otherwise specified in the button/link code for a particular payment. You can change a Return URL by editing it in the Wallet Properties; alternatively, you can modify the HTML code (the variables ok_return_success and ok_return_fail) associated with a button or link. In this latter case, the Return URL associated with the button or link will override that specified in the Wallet Properties.

Code Samples

Refer to the following page for additional code samples information, clarifications and examples. Please note that you can use payment form not only the way it is presented, but also combine required variables and create your own custom payment form.

Basic

Basic payment form is the simpliest way to sell any sort of a digital good or get paid for a service. For example we will use it to sell OKPAY Poster.
The form contains only minimum required variables such as "ok_item_1_name"; "ok_item_1_price"; "ok_currency".
Additional variables description can be found on the Variable Reference page.

<form  method="post" action="https://www.okpay.com/process.html">
   <input type="hidden" name="ok_receiver" value="OK702746927"/>
   <input type="hidden" name="ok_item_1_name" value="OKPAY Poster"/>
   <input type="hidden" name="ok_item_1_price" value="100"/>
   <input type="hidden" name="ok_currency" value="USD"/>
   <input type="image" name="submit" alt="OKPAY Payment" src="https://www.okpay.com/img/buttons/x02.gif"/>
</form>