Preparing your OKPAY Account

The OKPAY API relies on the highest standards of security and reliability, which is why an API Key-based signature generation scheme is used while making API calls.

Creating an API Key

Before calling protected API functions, you need to set up an API Key in the API Access Keys section of your OKPAY Profile. An API Key can be assigned to one or more wallets, therefore these settings can be adjusted separately for each particular wallet.

Figure 1. API Access Keys.

API Access Keys

To create a new API Key, click on the "Add new API key" button — you will need to specify a name and select the appropriate Wallet(s), as well as choose which functions you plan to call using that API Key.

Important: API Keys grant access to your OKPAY account and should be protected the same way as your password.

Figure 2. API Key Warning.

API Key Warning

API Key Security and Limits

Enabling transaction limits and IP filtering is useful for additional security. You are able to set daily, weekly and monthly limits for each API Key. Leaving the field set to 0 means that there will be no transaction limits for the API Key being created.

Hint: For security purposes, you can create several API Keys, and configure each API key to allow access only to certain functions and with certain transaction limits. For instance, you can give a freelance developer access to the SendMoney function with enabled daily limits to test your integration.

Figure 3. API Key Settings.

API Key Settings

Click on the "Save API Key" button to obtain an API key ID. It will be displayed in the table. The API Key ID, along with the API key password, is required for secured API function calls. To learn more, please visit the Authorization scheme section.

Hint: the OKPAY system can notify you when a transaction has been successfully completed. It's done in a background process, and all of the payment details are posted on your website at a specified URL. Detailed instructions on how to create an IPN script can be found in the Instant Payment Notification (IPN) section. Please go to Test Tools to test your settings and view your IPN messages history.

Once you have created an API Key and set up your IPN Handler (optional), you can make API calls.

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