Introduction
This page describes the integration process steps and general API information.
Before you get an account to access Payment Platform, you must provide the following data to the Payment Platform administrator.
| Data | Description |
|---|---|
| IP List | List of your IP addresses, from which requests to Payment Platform will be sent Notification |
| URL | URL which will be receiving the notifications of the processing results of your request to Payment Platform |
| Contact Email | Email address of Responsible Person who will monitor transactions, conduct refunds, etc. |
Note: Notification URL is mandatory if your account supports 3D-Secure. The length of Notification URL should not be more than 255 symbols.
With all Payment Platform POST requests at Notification URL the Merchant must return the string "OK" if he successfully received data or return "ERROR".
You should get the following information from the administrator to begin working with the Payment Platform.
| Info | Description |
|---|---|
| CLIENT_KEY | Unique key to identifying the account in Payment Platform (used as request parameter) |
| CLIENT_PASS | Password for Client authentication in Payment Platform (used for calculating hash parameter) |
| PAYMENT_URL | URL to request the Payment Platform |
What to do with this information? Follow the setup guide.
-
For the transaction, you must send the server to server HTTPS POST request with fields listed below to Payment Platform URL (PAYMENT_URL). In response Payment Platform will return the JSON (http://json.org/) encoded string.
-
If your account supports 3D-Secure and credit card supports 3D-Secure, then Payment Platform will return the link to the 3D-Secure Access Control Server to perform 3D-Secure verification. In this case, you need to redirect the cardholder at this link. If there are also some parameters except the link in the result, you will need to redirect the cardholder at this link together with the parameters using the method of data transmitting indicated in the same result.
-
In the case of 3D-Secure after verification on the side of the 3D-Secure server, the owner of a credit card will come back to your site using the link you specify in the sale request, and Payment Platform will return the result of transaction processing to the Notification URL action.
When you make request to Payment Platform, you need to specify action, that needs to be done. Possible actions are:
| Action | Description |
|---|---|
| SALE | Creates SALE or AUTH transaction |
| CAPTURE | Creates CAPTURE transaction |
| CREDITVOID | Creates REVERSAL or REFUND transaction |
| GET_TRANS_STATUS | Gets status of the transaction in Payment Platform |
| GET_TRANS_DETAILS | Gets details of the order from Payment platform |
| RECURRING_SALE | Creates SALE or AUTH transaction using previously used cardholder data |
Result – value that system returns on request. Possible results are:
| Result | Description |
|---|---|
| SUCCESS | Action was successfully completed in Payment Platform |
| DECLINED | Result of unsuccessful action in Payment Platform |
| REDIRECT | Additional action required from requester (Redirect to 3ds) |
| ACCEPTED | Action was accepted by Payment Platform, but will be completed later |
| ERROR | Request has errors and was not validated by Payment Platform |
Status – actual status of transaction in Payment Platform. Possible statuses are:
| Status | Description |
|---|---|
| 3DS | The transaction awaits 3D-Secure validation |
| REDIRECT | The transaction is redirected |
| PENDING | The transaction awaits CAPTURE |
| SETTLED | Successful transaction |
| REVERSAL | Transaction for which reversal was made |
| REFUND | Transaction for which refund was made |
| CHARGEBACK | Transaction for which chargeback was made |
| DECLINED | Not successful transaction |
