Название раздела OKPAY guides www.okpay.com INTEGRATION OVERVIEW 2012
Contents INTEGRATION OVERVIEW GUIDE Contents 1. Payment System Integration 2. OKPAY Integration Types 2.1. Basic Payment Links and Buttons 2.2. Shopping Cart Software 2.3. Advanced Payment Buttons 2.4. API Integration 3. Integration Assistance and Support 4. Notes 3 4 6 11 15 18 20 21 2 www.okpay.com
1. Payment System Integration A payment system is a system used for transferring money. With the rapid development of computers and electronic communications a large number of electronic payment systems have emerged. The term electronic payment can refer narrowly to e-commerce - a payment for buying and selling goods or services offered through the Internet, or broadly to any type of electronic funds transfer. Despite the fact that electronic payment systems have their own procedures and protocols, standardisation has allowed some of these systems and networks to grow to a global scale, but there are still many country and product specific systems. Basically, an e-commerce payment system facilitates the acceptance of electronic payment for online transactions. About OKPAY: OKPAY.com is a P2P and B2C web based payment system providing users with a virtual account that allows easily loading, sending, receiving and withdrawing money as well as making purchases online. OKPAY is a widely spread electronic payments system and is among the world s leading ewallet providers with over 300 000 account holders. OKPAY payment network offers access to the great number of payment options for businesses in over 200 countries within a single integration. 3 www.okpay.com
2. OKPAY Integration Types OKPAY offers a customized integration experience of the following types: 1.Basic Payment Links and Buttons 2.Shopping Cart Software 3.Advanced Payment Buttons 4.API Integration Basically using the provided tools and settings you can easily achieve Shopping Carts with customized layouts integration, Custom Payment Solutions for Donations, Customized Event Registration and Event processing, Support for Domestic and International payment processing, automated Currency Conversion and many more. OKPAY Developers Section (Code and Examples Library) contains the necessary code samples in various programming languages, explanations and examples that can be used in most integration projects. Please refer to the Developers section and feel free to use this information or contact Certified Technical Assistance Partners to request a complete integration, fine tune your current system. OKPAY Company never keeps credit card information in the database for the highest clients protection. OKPAY Payment System utilizes the information for submitting payment through the API s. This allows for customized transaction experience for merchants and customers which can be truly based on any business model. How do I start accepting payments? You have already verified your OKPAY account, applied for a Merchant Services and ready to start OKPAY payment system integration on your website. Locating Merchant Services section Open www.okpay.com website to login to your OKPAY account. Locate the main panel on top of the page: Click on Log In link to open your OKPAY account this will bring you to the next page My Account overview. Then in the same panel on top of the page click on the Profile link: 4 www.okpay.com
Locale Merchant section on the Profile page: You will find merchant instruments such as: Payment Links & Buttons, OKPAY Seal, Websites, Test Tools, Debit Cards Pre-Order. Payment Links & Buttons is an automated button code generation service that can be used to create basic payment integration on the website. OKPAY Seal can be used to present yourself to the Internet community and is similar in principle to presenting your credentials to a prospective business partner prior to negotiating a deal. Websites category displays the list of added websites and their statuses. Test Tools category contains necessary testing instruments such as IPN Simulator and IPN History that allow you to test entire integration before submitting transactions to the live OKPAY processing. Debit Cards Pre-Order category allows to place a mass preorder on OKPAY Debit Cards for your business partners, colleagues, friends and family members. Recipients will be notified that the order has been pre-paid and will be offered to complete a Debit Card application form. 5 www.okpay.com
2.1. Basic Payment Links and Buttons Basic and the simplest way to start accepting payments is to use OKPAY Payment Links & Buttons generation service. This is very easy way as it only takes a few mouse clicks to create a Payment button code and add it to your website. Click on the Payment Links & Buttons link this will bring you to the next page: Payment Links and Button generator service allows Merchant to generate and test a payment Button or a Link on the fly. 1. Start with selecting an Item Type: Digital Product, Donation, Service, Tangible Good; 2. Enter the Item Title; 3. Select if the Commission will be paid by Merchant or Buyer. If commission is payable by Buyer total charged amount will include an item price and a transaction fee; 4. Enter the Price and Currency; 5. Enter Tax if applicable. IMPORTANT NOTE: To generate a simple Donation service button, leave the Price box empty. This way payer is able to enter desired payment amount. You can also create additional parameters to the button code. Click on the Show Extra Fields link to view the list of available options: 6 www.okpay.com
You can enter Article and Invoice numbers, Success and Fail URLs, IPN URL, set a Language and even add additional information in the Custom fields. Of course you can adjust the way the button looks. Click on the appropriate link to select a payment button appearance. 7 www.okpay.com
All payment buttons are separated and sorted in accordance with the categories: Digital Product, Donation, Service, Subscription, Tangible Good; and arranged in columns by color. After you will complete the Payment Links generator form and select the button appearance click on the Next button to proceed. Next page will contain the generated HTML code that is ready to be applied to your website s page. 8 www.okpay.com
1. We suggest you to test the link first before using it. Click on the Link Preview ( Test Item ) to open checkout page and preview generated payment page. Link Code section contains the actual payment link that can be used on the website, forum or a blog. HTML Preview displays the button appearance. HTML Code section contains the actual HTML code that you can paste to your webpages. IMPORTANT NOTE: You can create a test OKPAY account and login to it in alternative browser. Copy generated Test Item link (right click on it and select Copy link ) then paste it to alternative browser s address bar. It is important to do so to make sure that your current session will stay active. Since you are already logged to a test OKPAY account in alternative browser you will be able to make a test payment on the generated checkout page. 9 www.okpay.com
10 www.okpay.com
2.2. Shopping Cart Software More advanced way to start accepting payments is to install shopping carts software on your website by applying an appropriate shopping cart software module. OKPAY provides integration modules for almost all major commercial and open-source shopping carts software. Click on the Developers tab to proceed This will bring you to the Developer Tools Overview page: On the left side of you will find table of contents and categories. In the middle of the page you will see the most popular categories such as: Marketplace, E-commerce Systems, Payment Links and Buttons, OKPAY Seal, Payment Notifications IPN, Program Interfaces API. On the right side you will find Supported Shopping Carts link. Click on the Supported Shopping Carts link to view the gallery of the supported modules: 11 www.okpay.com
If you have found the available Shopping Carts software module for your website s ecommerce system select it to download the module and view instructions. 12 www.okpay.com
For example we have a website working on TomatoCart shopping system. The module itself and installation instructions are included in the downloadable archive. IMPORTANT NOTE: If you are unable to find a suitable cart or application for your ecommerce website please send us a Request and we will forward it to our developer s network. 13 www.okpay.com
Enter your Name, Email address, Application title or Website Name, Website address, and Plugin Details. Click on the Send button to submit your request. You request will be submitted and forwarded to the appropriate developers department. Module creation can take some time, depending on the current workload of our programmers. If you can not wait or you are having specific requests you can always consult with the certified Technical Assistance partners offering professional approach in creating necessary integration modules or scripts. https://www.okpay.com/en/catalog/technical-assistance 14 www.okpay.com
2.3. Advanced Payment Buttons Advanced payment buttons can offer wider integration as well as more delicate button settings alignment. OKPAY Developers section contains the specialized section of Code Samples that will help you to create a more customized payment button parameters as well as tuning basic settings. Click on the Developers section to continue Locate a Developers Tools contents on the right of the page There you will need to find Code Samples click on it and you will be forwarded to appropriate page 15 www.okpay.com
Code Samples page contains various major custom button code features and samples, using and combining which will help you to create your very own button code. You can also view the buttons in action (by clicking on the OKPAY Buy Now button).the full list of variables can be found in the table of contents on the left of the page ( Variables section). 16 www.okpay.com
Refer to this page to find the list of supported variables, description and additional information. Customizing the payment links and buttons code is a great way to fine-tune your payments processing experience. 17 www.okpay.com
2.4. API Integration IMPORTANT NOTE: An application programming interface (API) is a specification intended to be used as an interface by software components to communicate with each other. An API may include specifications for routines, data structures, object classes, and variables. API Integration allows creating more flexible payment system integration, as well as automating accepting payments process. The OKPAY SOAP API provides programmatic access to OKPAY features and services. Developers can build custom applications, tools, and services that correspond to the same services and tools available through the main OKPAY website, https://www.okpay.com/. Typical applications include searching for transactions, paying en masse, and making refunds. The API is based on open standards known collectively as Web Services which include the Simple Object Access Protocol (SOAP), Web Services Definition Language (WSDL), and the XML Schema Definition language (XSD). These standards are supported by a wide range of development tools on a variety of platforms. OKPAY uses SOAP version 1.1. The OKPAY Web Services schema base and core components are required for developing applications to work with the OKPAY Web Services API. The following is the location of the WSDL and XSD files: https://api.okpay.com/okpayapi How SOAP API works Like many web services, OKPAY SOAP is a combination of client-side and server-side schemas, hardware and software servers, and core services. 18 www.okpay.com
In an object-oriented processing model, the interface to SOAP requests/responses is an object in your application s native programming language. Your third-party SOAP client generates business-object interfaces and network stubs from OKPAY-provided WSDL and XSD files that specify the OKPAY SOAP message structure, its contents, and the OKPAY API service bindings. A business application works with data in the form of object properties to send and receive data by calling object methods. The SOAP client handles the details of building the SOAP request, sending it to the OKPAY service, and converting the response back to an object. Operations that can be performed via OKPAY API General. General-purpose functions: get server time, verify if an account exists in the system, etc. Transfers. Moving funds from one account to another. With this command you can transfer funds in any of the OKPAY-supported currencies. History. Requesting history of a specified wallet. Additional parameters can be used such as date range, currency, destination account, etc. This function is also necessary if you wish to receive infor mation about specific transactions. Balance. Wallet balance requests. Get a wallet s balance in all currencies or return the balance of a specified currency. Authentication An API call must always contain information that will let the API server to authenticate the calling user. This call will contain a Wallet ID and other information that will help the server to accurately identify the user submitting the request. Every server request to API must contain the following authentication information: WalletID. This is a wallet which has enabled API access and which the user wishes to query. SecurityToken. This parameter consists of a hashed line of text formed by concatenating the API s access password and UTC date. Creating a security token To create a security token, use the following procedures: Apply concatenation to obtain the following line: Access Password:Date UTC in YYYYMMDD format:time UTC in HH format. Do a hash of the above line by SHA256. For example, if API access password = MyApiPass and UTC date = 2010-06-01 15:30 (24h format) Concatenation of parameters: MyApiPass:20100601:15 SHA256 hash of the above line: 5950F9BDA723ECDF9859AD205412BB44E0DAB16630CA4462490DE64B02305F8D Security The OKPAY SOAP API service is protected to ensure that only authorized OKPAY members can use it. There are three levels of security: 1. A required API username (WalletID) and an API security token; 2. Secure Sockets Layer (SSL) data transport; 3. Access filtering by IP address in the wallet s settings. An authentication failure at any of these levels denies access to the OKPAY SOAP API service. More information on API functionality can be found on the API Functions page: https://www.okpay.com/en/developers/interfaces/functions/index.html 19 www.okpay.com
3. Integration Assistance and Support OKPAY Company is also featuring a network of certified partners that are always ready to provide technical assistance and support at any stage of integration and website development. Our partners are professional web-design studious, web-integrators and other companies that have an advanced integration experience of OKPAY payment system to any websites. https://www.okpay.com/en/catalog/technical-assistance A brief list of services offered: 1.Payment system integration services 2.Auditing service of existing shopping cart and checkout pages. 3.Checkout technical support i.e. quick issue resolution in a production environment. 4.Security audit. SSL certificate installation. You are welcome to contact technical assistance partners and request a quote. 20 www.okpay.com
4. Notes OKPAY Developers Section https://www.okpay.com/en/developers/index.html OKPAY Technical Assistance Directory https://www.okpay.com/en/catalog/technical-assistance 21 www.okpay.com
Copyright 2007 2012 OKPAY. All rights reserved. www.okpay.com