Application Programming Interfaces (API)

This section contains essential information about the current OKPAY API as well as step-by-step instructions on how to start using it. The OKPAY API is available to all verified personal or corporate account owners. As new API functions are added and their functionality grows, the information gets updated accordingly.

API Overview

The OKPAY 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.eu. Typical applications include transactions search, mass payments, etc.

The API is based on JSON (or JavaScript Object Notation), a lightweight, easy and popular way to exchange data. It is based on a subset of the JavaScript Programming Language. JSON is a text format that is completely language independent but uses conventions that are familiar to programmers of the C-family of languages, including C, C++, C#, Java, JavaScript, Perl, Python, and many others. These properties make JSON an ideal data-interchange language.

Note: You can find previous versions of the OKPAY SOAP API in the Obsolete API section.

Security

The OKPAY JSON API service is protected to ensure that only authorized OKPAY clients can use it. There are several levels of security:

  1. Using API Key IDs and complex signatures instead of API passwords;
  2. Using a nonce for every API call;
  3. Secure Sockets Layer (SSL) data transport;
  4. Access filtering by IP addresses;
  5. Transaction limits for API Keys.

Authorization failure at any of these levels denies access to the OKPAY API Service.

How the OKPAY API Works

The OKPAY API provides access to our services and information to our sellers. If you would like to see a particular function added, please contact us. API calls are implemented as HTTPS POST or GET calls.

API Name API Location
General API https://api.okpay.eu/v2/

Like many other web services, the OKPAY API is a combination of client-side and server-side schemas, hardware and software servers, and core services.

Figure 1. OKPAY API High-level Diagram

JSON API Diagram

Learn More

Use these sources to learn more about API features:

OKPAY RSS
OKPAY Forum
OKPAY on Facebook
OKPAY on Livejournal
OKPAY on Twitter
OKPAY on VK
OKPAY on Linkedin
OKPAY on Youtube