Merchant Manual (EN)

1. About the document

2. Terms
3. Connecting to the payment gate
4. Interaction between systems during a payment
4.1. Interaction scheme of the process using 3D Secure
4.2. Interaction scheme of the process not using 3-D Secure
4.3. Scheme of implementation on the merchant's side
5. Algorithm for connecting to the payment gate
6. Web-service interface
6.1. One-phase payment requests
6.1.1. Order registration request
6.1.2. Order reversal request
6.1.3. Refund request
6.1.4. Order status request
6.1.5. Extended order status request
6.1.6. 3DS enrolled verification request
6.1.7. Request for additional parameters adding
6.1.8. Payment statistics for a specified period
6.1.9. Request to add a card number to the list of SSL-cards
6.2. Two-phase payment requests
6.2.1. Order preauthorization request
6.2.2. Request for completion of a preauthorized order
6.2.3. Order reversal request
6.2.4. Refund request
6.2.5. Order status request
6.2.6. Extended order status request
6.2.7. 3DS enrolled verification request
6.2.8. Request for additional parameters adding
6.2.9. Payment statistics for a specified period
6.2.10. Request to add a card number to the list of SSL-cards
7. REST interface
7.1. Testing of REST requests in an Internet browser
7.2. One-phase payment requests
7.2.1. Order registration request
7.2.2. Order reversal request
7.2.3. Refund requеst.
7.2.4. Order state request
7.2.5. Extended order state request
7.2.6. 3DS enrolled verification request
7.2.7. Payment statistics for a specified period
7.2.8. Request to add a card number to the list of SSL-cards
7.3. Two-phase payment requests
7.3.1. Preauthorized order registration request
7.3.2. Order completion request
7.3.3. Order reversal request
7.3.4. Rеfund requеst.
7.3.5. Order state request
7.3.6. Extended order state request
7.3.7. 3DS enrolled verification request
7.3.8. Payment statistics for a specified period
7.3.9. Request to add a card number to the list of SSL-cards
8. Payment interface design
8.1. Requirements to the payment interface pages
8.2. Payment page requirements
8.2.1. Page name
8.2.2. Page header
8.2.3. Page body
8.2.3.1. Mandatory elements on the payment page
8.2.3.2. Additional elements on the payment page
8.2.3.2.1. Notification of the client about transaction
8.2.3.2.2. Displaying of payment parameters
8.2.3.2.3. Displaying of order additional parameters
8.2.3.3. Validation of card details
8.3. Payment page requirements if binding ID was sent in the registration request
8.3.1. Page name.
8.3.2. Page header.
8.3.3. Page body.
8.4. Error page requirements
 8.4. Error page requirements
8.4.1. Page name
8.4.2. Page header
8.4.3. Page body
8.5. Requirements to final page design
8.5.1. Pаge name
8.5.2. Pаge header
8.5.3. Pаge body
8.6. Requirements to check page
8.6.1. Page nаme
8.6.2. Requirement to pаge dising
9. Address data for connections
10. Test cards
11. Appendix 1. Binding functionality
11.1. Functionality description
11.2. Displaying on the payment page. Form of binding choosing
11.3. Requests with bindings
11.3.1. WеbService interface
11.3.1.1. Payment by binding request
11.3.1.2. Unbind card request
11.3.1.3. Bind card request
11.3.1.4. Request to change binding expiry date
11.3.1.5. Merchant bindings list request
11.3.1.6. Request for list of bindings of a bank card
11.3.2. REST interfacе
11.3.2.1. Payment by binding request
11.3.2.2. Unbind card request
11.3.2.3. Bind card request
11.3.2.4. Request to change binding expiry date
11.3.2.5. Merchant bindings list request
11.3.2.6. Request for list of bindings of a bank card
11.4. Address data for connections (bindings functionality)
12. Appendix 3. External fee for payment
12.1. Addition the to payment page description
12.2. Testing
13. Appendix 4. Specification of additional fields for payments in air-commerce
14. Appendix 5. Dynamically formed pages
14.1. Dinamically formed payment page
14.1.1. External commission
14.1.2. Bindings
14.1.3. Payment through Alfa-click
14.1.4. Error of CVV/CVC entering
14.2. Dinamically formed page of payment result
14.3. Dinamically formed error page
15. Appendix 6. Response codes - actionCode description (processing answer)

1. About the document

The present document describes connection and graphical interfaces of the payment gate.

2. Terms
Merchant is a retailer or a service provider that uses a website for selling goods or services.
Bank card is a VISA or MasterCard card.
Issuing bank is the bank that issued a client's bank card.
IPS is acronym for International Payment System (e.g. Visa or MasterCard).
Payment gate of the acquirer bank (PG) is the automatic system that allows merchants to receive, and clients to perform payments with
bank cards over the internet.
Acquirer bank is the bank that implements and runs the payment gate.
3D Secure (Verified by Visa) is a technology developed by Visa that allows to perform additional authorization for a client on the side of
the issuer bank.
SecureCode is a technology developed by MasterCard that allows to perform additional authorization for a client on the side of the issuer
bank. Practically the same as the 3-D Secure technology. Further in the document both technologies will be referred to as 3D Secure.
Merchant Plugin Interface (MPI) is a component of 3D Secure technologies that may be implemented in the payment gate or on the
merchant's side.
ACS is acronym for Access Control Server which is an element of 3D Secure infrastructure that ensures validation of the payer by the
 ACS is acronym for Access Control Server which is an element of 3D Secure infrastructure that ensures validation of the payer by the
issuer bank.
Payment form is an HTML page that clients use for entering payment's properties.
Payment details are attributes of the card that the client uses for paying an order. Usually payment detail are: card number, expiration
date and CVC/CVV.
Payer (client) is an individual who pays by his bank card in the Merchant online shop for Merchant services.
Binding is correspondence between the Payer and card payment details (card number, expiration date and CVC/CVV)
Order is the elementary entity of the system, that describes the order in a certain online shop or its analog. Any order has the sum.
Purchase payment is a payment for goods / services, performed via the Internet with using of a credit card, which requires no further
confirmation.
Pre-Autorization payment is a payment for goods / services, performed via the Internet with using of a credit card, which requires further
confirmation. Pre-Autorization procedure of the checking process allows you to divide the solvency of a credit card (authorization) and
withdrawals (financial confirmation). First stage of pre-autorization payment is checking of the solvency of a credit card and blocking of
funds on the payer's account.
Reversal is the unlocking of funds on the payer's account. This feature is available for a limited time, the exact terms to be specified in the
bank.
Refund is a partial or full refund to the payer's card in case of refusal from goods (services) or refund of goods. The operation of money
return is performed after money withdrawal from the payer's account.

3. Connecting to the payment gate

In order to connect to the system a merchant provides:

HTML page (graphic, CSS and other necessary files) showing the payment form. Requirements to this page are described in the section
Payment page design.

After registration each merchant receives:

1. Login - name of the merchant within the payment gate. Login is used only to perform operations via API.
2. Password - password of the merchant within the payment gate. Login is used only to perform operations via API.

4. Interaction between systems during a payment

There are two possible cases for payment: the first case is with the card being involved with a 3D Secure technology, and the second one is with
the card being not involved in 3D.

4.1. Interaction scheme of the process using 3D Secure

Description:

1. The client forms an order using the online shop of the merchant.
2. When the order is confirmed by the client, the merchant system registers the order in the payment gate. The following parameters are
used for order registering: amount to be charged and currency of the expected payment, internal order number and merchant URL for
client redirecting after payment.
3. The payment gate responds with a unique identifier of the registered order and with a URL of the payment form that the client should be
redirected to.
4. Merchant system redirects the client to the URL generated in the previous step.
5. Client's browser opens the URL.
6. As a result, the browser opens the payment form.
7. The client fills in the form and sends the data to the payment gate server.
8. The payment gate checks if the specified card is involeved into 3D Secure (SecureCode).
9. The gate redirects the client's browser to the ACS page of the issuer bank (this step is mandatory for 3D Secure processing).
10. Client's browser requests authorization form from the ACS (each issuer implements this step in it's own way).
11. ACS sends the form to the client.
12. Client fills in this form and sends the data back to ACS.
13. ACS processes the data and (regardless of the result) redirects the client's browser to a page of the payment gate. Along with it the URL
of the page browser receives enciphered authorization results.
14. Client's browser opens the page, passing authorization results to the payment gate.
15. The payment gate performs the payment.
16. When the payment is processed, the payment gate sends the return URL to the client's browser (specified by the merchant during the
order registration).
17. Client's browser requests the payment results page from the merchant.
18. The merchant system requests the payment state from the payment gate using the order identifier assigned by the gate earlier. Note that
payment state request (getOrderStatus or getOrderStatusExtended) is mandatory for implementation for all merchants.
19. The payment gate returns the payment status.
20. The merchant system sends the page with payment results to the client's browser.

If the Client does not return to the merchant page of payment results (to the Client's return URL) after 20 minutes allotted for a payment, the
payment is considered to be a failure.

Under the request of the merchant the status of order payment can be changed manually by Bank employees after checking of transaction status
in bank systems. In this case after confirmation of order status change the merchant can make repeated request for status of order payment
(steps 18-19).

After step 20 the on-line interaction between the store and the payment gate ends. Further operations on the payment completion (in case of
two-step payment), payment cancellation and money return are performed in off-line mode.

The order life cycle is described in paragraph Order life cycle (AF).

4.2. Interaction scheme of the process not using 3-D Secure

Description:

1. The client places the order in the online shop of the merchant.
2. When the order is confirmed by the client, the merchant system registers the order in the payment gate. The following parameters are
used for order registering: amount to be charged, currency of the expected payment, internal order number and URL for the client to
return to after payment.
3. The payment gate responds with a unique identifier of the registered order and with a URL of the payment form that the user should be
redirected to.
4. Merchant system redirects the client to the URL generated in the previous step.
5. Client's browser opens the URL.
6. As a result, the browser opens the payment form.
7. The client fills in the form and sends the data to the payment gate server.
8. The payment gate performs the payment after reseiving of payment details.
9. When the payment is processed, the payment gate sends the return URL to the client's browser (specified by the merchant during the
order registration).
10. Client's browser requests the payment results page from the merchant.
11. The merchant system requests the payment status from the payment gate using the order identifier assigned by the gate earlier. Note
that payment state request (getOrderStatus or getOrderStatusExtended) is mandatory for implementation for all merchants.
12. The payment gate returns the payment status.
 12. The payment gate returns the payment status.
13. The merchant system sends page with the payment results to the client's browser.

If the Client does not return to the merchant page of payment results (to the Client's return URL) after 20 minutes allotted for a payment, the
payment is considered to be a failure.

Under the request of the merchant the status of order payment can be changed manually by Bank employees after checking of transaction status
in bank systems. In this case after confirmation of order status change the merchant can make repeated request for status of order payment
(steps 11-12).

After step 20 the online interaction between the merchant and the payment gate ends. Further operations on the payment completion (in case of
two-step payment), payment cancellation and money refund are performed in offline mode.

The order life cycle is described in paragraph Order life cycle (AF).

4.3. Scheme of implementation on the merchant's side

There are several automatic interactions between a merchant and the payment gate:

2, 3 in both schemes,
19, 20 in the first one,
11 and 12 in the second one.

These interactions are synchronous, i.e. requesting side must wait for a response or timeout to continue. Interactions are also unilateral: the
merchant system sends requests to the payment gate, not the other way. To implement these interactions developers can use API provided by
the payment gate, which consists of 2 requests:

1. Register order.
2. Get information about order status.

There are 2 versions of the API:

Web-services implementation (SOAP);

REST implementation.

Note: The client has limited time for payment - 20 minutes from order registration. Attempt to perform the payment after 20 minutes causes
displaying of the error page.

5. Algorithm for connecting to the payment gate

1. Receive logins and passwords for the test server.

2. Design the payment page.

3. Upload archived payment page files to the test server.

4. Test the payment page:

using REST / Web-service interface

using form of order registering
using console.

5. Contact bank to ask for payment page verification. If the verification is successful, the bank will transfer the payment page to the production
server.

6. Receive login and password pair (or pairs, for multiple users) for the production server.

7. Reconfigure the merchant's system for using the production server as the payment gate.

8. Try paying for an order with a real card (it's recommended to use both 3DS and SSL cards for testing to be thorough).

9. Reverse and refund these payments via the console.

10. Inform the bank about the start of commercial use of the gate. (Sign the act of internet shop readiness).

6. Web-service interface
Description (WSDL) of the service can be found on the test server that is available without restrictions. For the exact address see "Address data

for connections" section.

for connections" section.

For successful authorization purposes each request should include login and password of the merchant that were produced during registration of
the merchant. Values of the login and password are sent in the format described in the WS-Security specification, authorization type UsernameTo
ken. Header for such authorization looks something like this:

<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oas

is-open.org/wss/2004/01/oasis-200401-wss-%20wssecurity-utility-1.0.xsd">
<wsse:UsernameToken wsu:Id="UsernameToken-87">
<wsse:Username>aa</wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">123456</
wsse:Password>
</wsse:UsernameToken>
</wsse:Security>

Requests for one- and two-phase schemes may differ. Requests for each scheme are described below.

If the Error code = 0, it means that the request is processed by the Payment gate without system errors. Error code does not show the status of
the order.

To get the status of an order you should use the request getOrderStatus or getOrderStatusExtended (one of these methods must
necessarily be implemented under TSP integration with payment gate ).

6.1. One-phase payment requests

6.1.1. Order registration request

Use registerOrder method for order registration in the payment gate. The method is described in WSDL of the service.

Request parameters:

Name Type Mandatory Description

merchantOrderNumber AN..32 yes Number (identifier) of the order in the merchant system. It is unique within the system

description AN..512 no Free-formed description of the order.

amount N..20 yes Order amount in minimal currency units (e.g. cents).

currency N3 no Code of the payment currency (according to ISO 4217). If it is not specified in the request, the default value is
used - 810, russian rubles.

language A2 no Code of the language (according to ISO 639-1) that the payment page should be displayed in. If it is not
specified, the system uses the default language from the merchant settings.

pageView ANS..20 no This parameter indicates what type of payment interface pages should be uploaded for the payer. Possible
values:

DESKTOP – to upload pages designed for displaying on PC monitors (pages with names payment_<lo
cale>.html and errors_<locale>.html from archive of payment interface pages);
MOBILE – to upload pages designed for displaying on mobile devices (pages with names mobile_pay
ment_<locale>.html and mobile_errors_<locale>.html from archive of payment interface
pages);
If the merchant has pages with names formed by adding of some prefix to the template part of the page
name, then you can specify necessary prefix in the pageView parameter in order to redirect client to
the corresponding page. For example, if pageView=iphone then pages with names iphone_paymen
t_<locale>.html and iphone_error_<locale>.html will be used.

Where:

locale – the page language in 2-alpha code according to ISO 639-1, e.g. ru for Russian and en for
English.

Default value is pageView=DESKTOP.

 sessionTimeoutSecs N...9 no Duration of order life in seconds.

If the parameter is not specified, then the value from merchant settings is used, otherwise - the default value
(1200 seconds - 20 minutes).

If the request contains expirationDate parameter, the parameter sessionTimeoutSecs is ignored.

bindingId AN..255 no Identificator of the binding, that was created earlier. May be used only if the merchant has permission to work
with bindings. If this parameter is sent in the request, that means:

1. This order may be payed only by binding;

2. The payer will be redirected to a payment page, where entering of CVC only is required.

expirationDate ANS no Date and time of termination of order life. Format: yyyy-MM-dd'T'HH:mm:ss.

If this parameter is not specified, the sessionTimeoutSecs parameter is used to determine date and time
of termination of order life.

returnUrl AN..512 yes Web address that the client should be redirected after successful payment. Absolute link must be specified.

failUrl AN..512 no Web address that the client should be redirected if the payment failed. Absolute link must be specified.

params no An additional tag with the attributes for passing additional parameters of the merchant.

Fields of additional informaiton to be stored. To send N parameters, the request must contain N params tags
, where the name attribute contains parameter name and value attribute contains parameter value:

Name Type Mandatory Description

name AN..20 yes Name of the additional parameter

value AN..1024 yes Value of the additional parameter

These fields may be passed to the bank processing for their representation in registers.*

This functionality can be switched on during the integration period at the agreement with bank.

If notification of the client is switched on for the merchant, this tag should contain parameter with name emai
l which value is client's email.

clientId AN..255 no Number of the client (identifier) in the merchant system. It is used to realise binding functionality. The request
may contain this parameter only if the merchant is allowed to use bindings.

merchantLogin AN..255 no To register the order from the name of the child merchant, specify its login in this parameter.

* By default the following fields are passed to the bank processing:

orderNumber – order number in the merchant system;

description – order description (not more than 99 simbols, the following simbols are forbidden to use - %, +, \r, \n).

If additional parameter with name merchantOrderId is sent with the order, then its value will be passed to the bank processing as
order number (instead of value of orderNumber field).

Response parameters:

Name Type Mandatory Description

orderId ANS36 no Order number in the payment gate. It is unique within the gate. Absent if order registration failed (error is described by
the errorCode parameter).

formUrl AN..512 no URL of the payment form that the client's browser should be redirected to. Absent if order registration failed (error is
described by the errorCode parameter).

errorCode N3 no Code of the error that occurred during registration of the order.

errorMessage AN..512 no Description of the error in the language specified in the language parameter of the request.

Possible codes for errors (the errorCode field):

Value Description
 0 No system error

1 Incorrect order number

1 Order with this number is already registered in the system

3 Unknown currency

4 Empty emount

4 Order number is empty

5 Invalid value of one of the parameters

5 Access denied

5 The user must change his password

7 System error

Request example:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:mer="http://engine.paymentgate.ru/webservices/merchant">
<soapenv:Header/>
<soapenv:Body>
<mer:registerOrder>
<order merchantOrderNumber="78ds901234567890" description=" "
amount="15000" currency=" " language=" " pageView="DESKTOP"
sessionTimeoutSecs=" " bindingId=" " expirationDate="2014-09-08T14:14:14">
<returnUrl>https://web.rbsuat.com/ab/finish.html</returnUrl>
<params name="param1" value="valueParam1"/>
<params name="param2" value="valueParam2"/>
<clientId>666</clientId>
<merchantLogin> </merchantLogin>
</order>
</mer:registerOrder>
</soapenv:Body>
</soapenv:Envelope>

Response example:
 <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:registerOrderResponse
xmlns:ns1="http://engine.paymentgate.ru/webservices/merchant">
<return orderId="05fcbc62-7ee6-4f1a-b3d5-6ca41a982283"
errorCode="0" errorMessage="Success">
<formUrl>
https://web.rbsuat.com/ab/payment_ru.html?mdOrder=05fcbc62-7ee6-4f1a-b3d5-
6ca41a982283 </formUrl>
</return>
</ns1:registerOrderResponse>
</soap:Body>
</soap:Envelope>

6.1.2. Order reversal request

To reverse an order use the reverseOrder request. This functionflity is available for a limited period, that is specified by the Bank.

The reversal operation may be performed only once. If the reversal request caused an error, the next try will not be successful.

The reversal operation is available for merchants only under agreement with the Bank. To perform the reversal request a user must have an
appropriate permission.

Request parameters:

Name Type Mandatory Description

orderId ANS36 yes Order number in the payment gate. Unique within the gate.

language A2 no Language according to ISO 639-1. If not specified, the system uses the default language from the merchant's settings. Error
message will be stated in this language.

Response parameters:

Name Type Mandatory Description

errorCode N3 no Code of the error that occurred during reversal.

errorMessage AN..512 no Description of the error in the language specified in the Language field of the request.

Possible codes for errors (the errorCode field):

Value Description

0 No system error

5 Access denied

5 The user must change his password

5 [orderId] is empty

6 No such order
 7 Reversal is impossible for current transaction state

7 System error

Request example:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:mer="http://engine.paymentgate.ru/webservices/merchant">
<soapenv:Header/>
<soapenv:Body>
<mer:reverseOrder>
<order language="en"
orderId="f88a2bbf-2021-4ccc-8783-8a13068a89f9">
<!–Zero or more repetitions:-->
<params name=" " value=" "/>
</order>
</mer:reverseOrder>
</soapenv:Body>
</soapenv:Envelope>

Response example:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:reverseOrderResponse
xmlns:ns1="http://engine.paymentgate.ru/webservices/merchant">
<return errorCode="7" errorMessage="Reversal is impossible for
current transaction state"/>
</ns1:reverseOrderResponse>
</soap:Body>
</soap:Envelope>

6.1.3. Refund request

Use refundOrder request to refund deposited money.

This request returns money paid for the order back to the client. Request causes an error if the client is not charged. The payment gate allows
multiple refunds, but their total amount cannot exceed the amount that was diposited from the client's account as a result of the order.

A user must have a corresponding permission in the system to perform this operation.

Request parameters:

Name Type Mandatory Description

orderId ANS36 yes Order number in the payment gate. It is unique within the gate.

refundAmount N..5 yes Refund amount in the order currency. May be less or equal to the current charged amount (which is lowered by
previous refunds).
 language A2 no Language according to ISO 639-1. If not specified, the system uses the default language from the merchant's settings.
Error messages will be stated in this language.

Response parameters:

Name Type Mandatory Description

errorCode N3 no Code of the error that occurred in the process of the refund.

errorMessage AN..512 no Description of the error in the language specified in the Language field of the request.

Possible codes for errors (the errorCode field):

Value Description

0 No system error

5 Access denied

5 The user must change his password

5 [orderId] is empty

5 Amount is invalad

6 No such order

7 Refund is impossible for current transaction state

7 Refund amount exceeds deposited amount

7 System error

Request example:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:mer="http://engine.paymentgate.ru/webservices/merchant">
<soapenv:Header/>
<soapenv:Body>
<mer:refundOrder>
<order language=" "
orderId="4302d369-a5e8-4432-a5e5-42acfab52c86" refundAmount="20000">
<!--Zero or more repetitions:-->
<params name=" " value=" "/>
</order>
</mer:refundOrder>
</soapenv:Body>
</soapenv:Envelope>

Response example:
 <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:refundOrderResponse
xmlns:ns1="http://engine.paymentgate.ru/webservices/merchant">
<return errorCode="7" errorMessage="Refund amount exceeds
deposited amount"/>
</ns1:refundOrderResponse>
</soap:Body>
</soap:Envelope>

6.1.4. Order status request

To inquire state of a registered order, use the getOrderStatus request.

The order status must be determined by the value of orderStatus parameter.

authCode field is deprecated.

Request parameters:

Name Type Mandatory Description

orderId ANS36 yes Order identifier in the payment gate. Unique within the gate.

language A2 no Language according to ISO 639-1. If not specified, the system uses the default language from the merchant's settings. Error
messages, if any, will be returned in this language.

Response parameters:

Name Type Mandatory Description

orderStatus N2 no This paramater shows order status in the payment gate. Possible values are listed in the table below.
Parameter is absent if no order with the specified ID was found.

errorCode N3 no Code of the error that occurred in the course of processing the request.

errorMessage AN..512 no Description of the error in the language specified in the Language field of the request.

orderNumber AN..32 yes Order number (identifier) in the merchant's system

pan N..19 no Masked number of the card that was used for payment. Specified only for paid orders.

expiration N6 no Card expiration date in the YYYYMM format. Specified only for paid orders.

cardholderName A..64 no Cardholder name. Specified only for paid orders.

amount N..20 yes Order amount in minimal currency units (e.g. cents)

currency N3 no Code of the payment's currency (according to ISO 4217).

approvalCode AN6 no IPS authorization code. The field has fixed length of six characters, it can contain both numbers and letters.

authCode N3 no This parameter is deprecated. Its value is always "2", regardless of the order status and processing system
authorization code.

ip AN..20 no IP address of the computer that the order initiated on.

date ANS yes Date of order registration

orderDesctiption AN..512 yes Order description that was sent during registration

actionCodeDesctiption AN..512 yes Description of action code the language specified in the Language field of the request.
 clientId AN..255 no Number of the client (identifier) in the merchant's system. Transferred, when order is registred. Present only if
creation of ligaments is allowed for merchant.

bindingId AN..255 no Identificator of the ligament created while paying an order or used to pay for. Present only if creation of
ligaments is allowed for merchant.

The orderStatus field may have the following statuses:

State number Description

0 The order is registered, but not paid yet.

1 Pre-authorisation amount was held (for two-phase payment)

2 The amount was deposited successfully

3 Authorization reversed

4 Transaction was refunded

5 Authorization through the issuer's ACS initiated

6 Authorization declined

Possible codes for errors (the errorCode field):

Value Description

0 No system error.

1 Order with this number is already registered in the system.

2 Payment is declined

5 The user must change his password

5 Access denied

5 [orderId] is empty

6 Unknown order id

7 System error

Request example:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:mer="http://engine.paymentgate.ru/webservices/merchant">
<soapenv:Header/>
<soapenv:Body>
<mer:getOrderStatus>
<order orderId="b1221b79-5703-42c9-a4b1-ed0d0f36493e"
language="en"/>
</mer:getOrderStatus>
</soapenv:Body>
</soapenv:Envelope>

Response example:
Response example:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:getOrderStatusResponse
xmlns:ns1="http://engine.paymentgate.ru/webservices/merchant">
<return orderStatus="2" errorCode="0"
orderNumber="456789012345678" pan="411111**1111" expiration="201512"
cardholderName="Ivan" amount="15000" currency="810" approvalCode="123456"
authCode="2" ip="212.5.125.194" date="2013-09-03T16:48:52.459+04:00"
orderDescription=" " actionCodeDescription="Request processed successfully"
clientId="666" bindingId="df0b1801-a754-4576-b174-c2485d98bc9b"/>
</ns1:getOrderStatusResponse>
</soap:Body>
</soap:Envelope>

6.1.5. Extended order status request

To inquire about state of a registered order, use the getOrderStatusExtended request.

Request parameters:

Name Type Mandatory Description

orderId ANS36 yes* Order identifier in the payment gate. Unique within the gate.

merchantOrderNumber AN..32 yes* Order number (identifier) in the merchant'system

language A2 no Language according to ISO 639-1. If not specified, the system uses the default language from the merchant's
settings. Error messages, if any, will be returned in this language.

* It is necessary to specify whether orderId or merchantOrderNumber in the request. If the request contains both parameters, orderId is a
priority.

There are 3 sets of response parameters. These sets depend on getOrderStatusExtended version, specified in merchant settings.

Response parameters for versions 01, 02,03:

The following parameters are returned regardless gerOrderStatusExtended version.

Name Type Mandatory Description

orderNumber AN..32 yes Order number (identifier) in the merchant's system

orderStatus N2 no State of the order in the payment gate. The value is selected from the list below. Absent if no order with the
specified ID was found.

actionCode N3 yes Processing system authorization code.

actionCodeDescription AN..512 yes Action code description on the language passed in the parameter Language"

errorCode N3 no Code of the error that occurred in the course of processing the request.

errorMessage AN..512 no Description of the error in the language specified in the Language field of the request.

amount N..20 yes Order amount in minimal currency units (e.g. cents)

currency N3 no Code of the payment's currency (according to ISO 4217).If not specified, assumed to be 810 (Russian
rubles).

date ANS yes Date of order registration.

orderDescription AN..512 no Free-formed description of the order.

ip AN..20 yes IP address of the computer that the order initiated on.

Element merchantOrderParams is present in the reponse if the order contains merchant additional parameters. Each additional parameter is described in
separate element merchantOrderParams by the following fields:

name AN..20 no Name of additional parameter

value AN..1024 no Value of additional parameter

Element cardAuthInfo – the structure includes element secureAuthInfo and the following attributes:

maskedPan N..19 no Masked number of the card that was used for payment. Specified only for paid orders.

expiration N6 no Card expiration date in the YYYYMM format. Specified only for paid orders.

cardholderName A..64 no Cardholder name. Specified only for paid orders.

approvalCode AN6 no IPS authorization code.Specified only for paid orders. The field has fixed length of six characters, it can
contain both numbers and letters.

Element secureAuthInfo (includes element eci and element threeDSInfo with parameters cavv and xid):

eci N..4 no Electronic Commerce Indicator. Set just after the payment order in the case of a permit

cavv ANS..200 no Cardholder Authentication Verification Value. Set just after the payment order in the case of a permit.

xid ANS..80 no Electronic Commerce Transaction Identifier.Set just after the payment order in the case of a permit.

Element bindingInfo consits of the following fields:

clientId AN..255 no Client number (ID) in the shop system, transferred during the order registration. Presents only if a shop is
allowed to create bindings.

bindingId AN..255 no Binding identifier created during order payment or used for payment. Presents only if a shop is allowed to
create bindings.

Response parameters for versions 02, 03:

If getOrderStatusExtended version is 02 or higher, the following parameters are also returned along with parameters described above.

Name Type Mandatory Description

authDateTime ANS no Authorisation date and time

authRefNum AN..24 no Reference number

terminalId AN..10 no Terminal Id

Response parameters for version 03:

If getOrderStatusExtended version is 03, the following parameters are also returned along with parameters described above.

Name Type Mandatory Description

Element paymentAmountInfo consists of the following parameters:

approvedAmount N..20 no Amount hold on the client's card (only for two-phase payments)

depositedAmount N..20 no Amount confirmed for deposit

refundedAmount N..20 no Refund amount

paymentState N2 no Payment state

Element bankInfo consist of:

 bankName AN..200 no Name of issuing bank

bankCountryCode AN..4 no Code of issuing bank country

bankCountryName AN..160 no Country of issuing bank in language specified in language parameter or in user language if language parameter
is empty

The orderStatus field may have the following values:

State number Description

0 The order is registered, but not paid yet.

1 Pre-authorisation amount was held (for two-phase payment)

2 The amount was deposited successfully

3 Authorization reversed

4 Transaction was refunded

5 Authorization through the issuer's ACS initiated.

6 Authorization declined

Possible codes for errors (the errorCode field):

Value Description

0 No system error

1 Expected [orderId] or [orderNumber]

5 Access denied

5 The user must change his password

6 Order not found

7 System error

Request example:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:mer="http://engine.paymentgate.ru/webservices/merchant">
<soapenv:Header/>
<soapenv:Body>
<mer:getOrderStatusExtended>
<order orderId="942e8534-ac73-4e3c-96c6-f6cc448018f7"
language="en">
<!-Optional:->
<merchantOrderNumber> </merchantOrderNumber>
</order>
</mer:getOrderStatusExtended>
</soapenv:Body>
</soapenv:Envelope>
Response example:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:getOrderStatusExtendedResponse
xmlns:ns1="http://engine.paymentgate.ru/webservices/merchant">
<return orderNumber="0s7a84sPe49Hdsddd0134567a0"
orderStatus="2" actionCode="0" actionCodeDescription="Request processed
successfully" amount="33000" currency="810"
date="2013-11-13T16:51:02.785+04:00" orderDescription=" " errorCode="0"
errorMessage="Success">
<attributes name="mdOrder"
value="942e8534-ac73-4e3c-96c6-f6cc448018f7"/>
<cardAuthInfo maskedPan="411111**1111" expiration="201512"
cardholderName="Ivan" approvalCode="123456"/>
<authDateTime>2013-11-13T16:51:02.898+04:00</authDateTime>
<terminalId>111113</terminalId>
<authRefNum>111111111111</authRefNum>
<paymentAmountInfo paymentState="DEPOSITED"
approvedAmount="33000" depositedAmount="33000" refundedAmount="0"/>
<bankInfo bankName="TEST CARD" bankCountryCode="RU"
bankCountryName="Russian Federation"/>
</return>
</ns1:getOrderStatusExtendedResponse>
</soap:Body>
</soap:Envelope>

6.1.6. 3DS enrolled verification request

To inquire about state of 3DS enrolled verification, use the verifyEnrollment request.

Request parameters:

Name Type Mandatory Description

pan N12...19 yes Card number.

Response parameters:

Name Type Mandatory Description

errorCode N3 no Code of the error.

errorMessage AN..512 no Description of the ErrorCode error.

isEnrolled A1 no 3ds enrolled atribute. Available values: Y, N, U.

emitterName AN..160 no Name of the issuer bank

emitterCountryCode AN..4 no Country code of the issuer bank

Possible codes for errors (the errorCode field):

 Value Description

0 No system error

1 PAN not specified

1 PAN must be a number from 13 to 19 digits

5 Access denied

5 User must change his password

6 No info found for specified PAN

7 System error

Request example:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mer="http://engine.paymentgate.ru/webservices/merc

hant">
<soapenv:Header/>
<soapenv:Body>
<mer:verifyEnrollment>
<pan>4111111111111111</pan>
</mer:verifyEnrollment>
</soapenv:Body>
</soapenv:Envelope>

Response example:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:verifyEnrollmentResponse xmlns:ns1="http://engine.paymentgate.ru/webservices/merchant">

<return isEnrolled="Y" emitterName="TEST CARD" emitterCountryCode="RU" errorCode="0"/>

</ns1:verifyEnrollmentResponse>
</soap:Body>
</soap:Envelope>

6.1.7. Request for additional parameters adding

To add new additional parameters to an order use addParams request.

If there is an additional parameter in the order and a parameter with the same name is going to be added, the latest passed value of the
parameter will be saved in the order.

Request parameters:

Name Type Mandatory Description

orderId ANS36 yes Order number in the payment gate. It is unique within the gate.

Tag of additional parameters - params:

name AN..20 yes Name of the additional parameter

value AN..1024 yes Value of the additional parameter

Response parameters:
 Name Type Mandatory Description

errorCode N3 yes Code of the error.

errorMessage AN..512 no Description of the error. Is absent if the request is successful.

Possible codes for errors (the errorCode field):

Value Description

0 No system error

5 Access denied

5 User must change his password

6 orderId is not specified

6 Order not found

7 System error

Request example:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:mer="http://engine.paymentgate.ru/webservices/merchant">
<soapenv:Header/>
<soapenv:Body>
<mer:addParams>
<request orderId="02988563-0cc4-4109-84ed-15781f0d718e">
<!--Zero or more repetitions:-->
<params name="Param1" value="Param1"/>
<params name="Param2" value="Param2"/>
</request>
</mer:addParams>
</soapenv:Body>
</soapenv:Envelope>

Response example:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:addParamsResponse
xmlns:ns1="http://engine.paymentgate.ru/webservices/merchant">
<return errorCode="0"/>
</ns1:addParamsResponse>
</soap:Body>
</soap:Envelope>
6.1.8. Payment statistics for a specified period
getLastOrdersForMerchants method allows you to obtain statistics on payments for a certain period.

Request parameters:

Name Type Mandatory Description

language A2 no Language according to ISO 639-1. If not specified, the system uses the default language from the merchant's
settings. Error messages, if any, will be returned in this language.

page N no The result of the request processing is a report divided into pages (each page contains size records).
The response will return a page at number specified in this parameter. Page numbering starts at 0.
If page parameter is not specified in the request, the response will return page number 0.

size N..3 yes Number of records on one page (maximum value is 200).

from ANS yes Date and time of the report period beginning. Format is YYYY-MM-DDTHH:mm:ss

to ANS yes Date and time of the report period end. Format is YYYY-MM-DDTHH:mm:ss

transactionStates A..9 yes This block is designed to specify order states you need to be included into the report. Possible values:
CREATED, APPROVED, DEPOSITED, DECLINED, REVERSED, REFUNDED.

merchants ANS yes List of merchant Logins. Only transactions of specified merchants will be included into the report.

Leave this block empty to receive transactions of all available merchants (which includes child merchants and
merchants specified as viewable in user settings).

searchByCreatedDate boolean no Possible values:

true – search for orders by date of order creation.

false – search for orders by date of payment (thus orders in state CREATED и DECLINED can not be
present in the report).

Default value – false.

Response parameters:

Name Type Mandatory Description

errorCode N..2 yes Code of the error that occurred in the course of the report processing. Description of possible codes is represented in
the table below - "Possible codes for errors (the errorCode field)".

errorMessage AN..512 no Description of the error. Present only in case of error (errorCode is not 0).

orderStatuses Blocks containing data on orders in the report. See the table below - "Parameters of orderStatuses tags".

totalCount N yes Total account of orders in the report (on all pages).

page N yes The number of the current page (it is equal to the page parameter, transferred in the request).

pageSize N..3 yes Maximum number of orders on one page of the report (it is equal to the size parameter, transferred in the request).

Parameters of orderStatuses tags:

Name Type Mandatory Description

orderNumber AN..32 yes Order number (identifier) in the merchant's system

orderStatus N..2 yes State of the order in the payment gate. The value is selected from the list below. Possible values are
represented in the table below - "The orderStatus field".

actionCode N..3 yes Processing system authorization code.

actionCodeDescription AN..512 yes Action code description in the language specified in the parameter language of the request.

amount N..20 yes Order amount in minimal currency units.

currency N3 yes Code of the payment's currency (according to ISO 4217).If not specified, assumed to be default currency.

date ANS yes Date of order registration.

orderDescription AN..512 no Free-formed description of the order from the order registration request.

ip AN..20 no IP address of the payer.

errorCode N..2 yes Error code.

merchantOrderParams no Tag with attributes, used to pass merchant additional parameters. See the table below - "Parameters of merc
hantOrderParams tag".

attributes yes Order attributes in the payment system (order number). See the table below - "Parameters of attributes
tag".

cardAuthInfo no Tag with payment attributes. See the table below - "Параметры блока cardAuthInfo".

bindingInfo no Tag with information on binding used for payment. See the table below - "Parameters of bindingInfo tag".

authDateTime ANS no Date and time of payment authorization.

terminalId AN..10 no Terminal ID.

authRefNum AN..24 no Reference number.

paymentAmountInfo no Tag with information on approved amount, deposited amount and refund.
See the table below - "Parameters of paymentAmountInfo tag".

bankInfo no Tag with information on Issuing Bank. See the table below - "Parameters of bankInfo tag".

Parameters of merchantOrderParams tag:

Name Type Mandatory Description

name AN..20 yes Name of the merchant additional parameter.

value AN..1024 yes Value of the merchant additional parameter.

Parameters of attributes tag:

Name Type Mandatory Description

name A7 yes Attribute name - "mdOrder".

value ANS36 yes Attribute value - order identifier in the payment system (unique in the system).

Parameters of cardAuthInfo tag:

Name Type Mandatory Description

maskedPan N..19 no Masked number of the card that was used for payment.

expiration N6 no Card expiration date in the YYYYMM format.

cardholderName A..64 no Cardholder name.

approvalCode AN6 no IPS authorization code. The field has fixed length of six characters, it can contain both numbers and letters.

Parameters of bindingInfo tag:

Name Type Mandatory Description

clientId AN..255 no Client number (ID) in the merchant system.

bindingId AN..255 no Identifier of the binding used for payment.

Parameters of paymentAmountInfo tag:

Name Type Mandatory Description

paymentState N..9 no Payment state.

approvedAmount N..20 no Amount confirmed for deposit.

depositedAmount N..20 no Deposited amount.

 refundedAmount N..20 no Refund amount.

Parameters of bankInfo tag:

Name Type Mandatory Description

bankName AN..200 no Name of the Issuing Bank .

bankCountryCode AN..4 no Code of the Issuing Bank country.

bankCountryName AN..160 no Country of the Issuing Bank in language specified in language parameter or in user language if language para
meter is empty.

The orderStatus field may have the following statuses:

Value Description

0 The order is registered, but it is not paid yet.

1 Pre-authorisation amount is held (for two-phase payment)

2 The amount was deposited successfully

3 Authorization reversed

4 Transaction was refunded

5 Authorization through the Issuer's ACS initiated.

6 Authorization declined

Possible codes for errors (the errorCode field):

Value Description

0 No system error

5 Mandatory fild is empty

5 Value of transactionStates parameter is invalid

7 System error

10 Parameter size exceeds maximum value

10 Unsufficient rigts to view transactions of specified merchant.

Request example:
 <soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:mer="http://engine.paymentgate.ru/webservices/merchant">
<soapenv:Header/>
<soapenv:Body>
<mer:getLastOrdersForMerchants>
<request language="en">
<page>0</page>
<size>200</size>
<!-- Optional: -->
<from>2014-09-10T00:00:00</from>
<!-- Optional: -->
<to>2014-11-11T00:00:00</to>
<!-- Optional: -->
<transactionStates>
<!-- Zero or more repetitions: -->
<transactionStates>DEPOSITED</transactionStates>
</transactionStates>
<!-- Optional: -->
<merchants>
<!-- Zero or more repetitions: -->
<merchants>MerchantLogin</merchants>
<searchByCreatedDate>false</searchByCreatedDate>
</merchants>
</request>
</mer:getLastOrdersForMerchants>
</soapenv:Body>
</soapenv:Envelope>

Response example:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:getLastOrdersForMerchantsResponse
xmlns:ns1="http://engine.paymentgate.ru/webservices/merchant">
<return errorCode="0">
<orderStatuses orderNumber="58drs0Pes459Hdsddd0567a0"
orderStatus="2" actionCode="0" actionCodeDescription="Request processed
successfully" amount="250000" currency="810"
date="2014-10-28T12:40:49.233+04:00" orderDescription="Opisanie"
ip="212.5.125.194" errorCode="0">
<merchantOrderParams name="registr1" value="registr1"/>
<attributes name="mdOrder"
value="f1a3365b-542c-4c8d-b34c-e9a7ee8dbc9c"/>
<cardAuthInfo maskedPan="411111**1111" expiration="201512"
cardholderName="Ivan" approvalCode="123456"/>
<bindingInfo clientId="666"
bindingId="1eabfb8e-b90e-4dc8-bef6-14bd392b1cec"/>
<authDateTime>2014-10-28T12:41:01.207+04:00</authDateTime>
<terminalId>111113</terminalId>
<authRefNum>111111111111</authRefNum>
<paymentAmountInfo paymentState="DEPOSITED"
approvedAmount="250000" depositedAmount="250000" refundedAmount="0"/>
<bankInfo bankName="TEST CARD" bankCountryCode="RU"
bankCountryName="Russian Federation"/>
</orderStatuses>
<orderStatuses orderNumber="57drs0Pes459Hdsddd0567a0"
orderStatus="2" actionCode="0" actionCodeDescription="Request processed
successfully" amount="250000" currency="810"
date="2014-10-28T12:34:37.286+04:00" orderDescription="Opisanie"
ip="212.5.125.194" errorCode="0">
<merchantOrderParams name="registr1" value="registr1"/>
<attributes name="mdOrder"
value="09489184-bc5e-44a7-b6c4-3ca1feb8ef69"/>
<cardAuthInfo maskedPan="411111**1111" expiration="201512"
cardholderName="Ivan" approvalCode="123456"/>
<bindingInfo clientId="666"
bindingId="1eabfb8e-b90e-4dc8-bef6-14bd392b1cec"/>
<authDateTime>2014-10-28T12:34:56.046+04:00</authDateTime>
<terminalId>111113</terminalId>
<authRefNum>111111111111</authRefNum>
<paymentAmountInfo paymentState="DEPOSITED"
approvedAmount="250000" depositedAmount="250000" refundedAmount="0"/>
<bankInfo bankName="TEST CARD" bankCountryCode="RU"
bankCountryName="Russian Federation"/>
</orderStatuses>
<totalCount>2</totalCount>
<page>0</page>
<pageSize>200</pageSize>
</return>
</ns1:getLastOrdersForMerchantsResponse>
</soap:Body>
</soap:Envelope>
6.1.9. Request to add a card number to the list of SSL-cards
The updateSSLCardListr equest allows merchant to add a number of a card used for payment to "SSL PAN list".

This method is available for merhcant only at the agreement with the bank. In order to use this method the user must have access rights to work
with fraud lists.

Request parameters:

Name Type Mandatory Description

orderId ANS36 yes Order number in the payment gate. Unique within the gate.

Параметры ответа:

Название Тип Обязательно Описание

errorCode N3 no Error code.

errorMessage AN..512 no Description of the error in the user default language.

Error codes (values of the errorCode field):

Value Description

0 No system error

1 Access denied

2 The user must change his password

3 [mdorder] is not specified

4 There is no payment in the system or [mdorder] is incorrect

6 The card number is already present in the list

7 System error

Request example:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:mer="http://engine.paymentgate.ru/webservices/merchant">
<soapenv:Header/>
<soapenv:Body>
<mer:updateSSLCardList>
<mdorder>e40927ef-6fa2-43f3-bf97-f1f2bc61d4fd</mdorder>
</mer:updateSSLCardList>
</soapenv:Body>
</soapenv:Envelope>
Response example:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:updateSSLCardListResponse
xmlns:ns1="http://engine.paymentgate.ru/webservices/merchant">
<return errorCode="0" errorMessage="Request processing took place
without system errors"/>
</ns1:updateSSLCardListResponse>
</soap:Body>
</soap:Envelope>

6.2. Two-phase payment requests

6.2.1. Order preauthorization request

Order preauthorization request is called registerOrderPreAuth. It is used for registering an order with preauthorization.

Request parameters:

Name Type Mandatory Description

merchantOrderNumber AN..32 yes Number (identifier) of the order in the merchant system. It is unique within the system

description AN..512 no Free-formed description of the order.

amount N..20 yes Order amount in minimal currency units (e.g. cents).

currency N3 no Code of the payment currency (according to ISO 4217). If it is not specified in the request, the default value is
used - 810, russian rubles.

language A2 no Code of the language (according to ISO 639-1) that the payment page should be displayed in. If it is not
specified, the system uses the default language from the merchant settings.

pageView ANS..20 no This parameter indicates what type of payment interface pages should be uploaded for the payer. Possible
values:

DESKTOP – to upload pages designed for displaying on PC monitors (pages with names payment_<lo
cale>.html and errors_<locale>.html from archive of payment interface pages);
MOBILE – to upload pages designed for displaying on mobile devices (pages with names mobile_pay
ment_<locale>.html and mobile_errors_<locale>.html from archive of payment interface
pages);
If the merchant has pages with names formed by adding of some prefix to the template part of the page
name, then you can specify necessary prefix in the pageView parameter in order to redirect client to
the corresponding page. For example, if pageView=iphone then pages with names iphone_paymen
t_<locale>.html and iphone_error_<locale>.html will be used.

Where:

locale – the page language in 2-alpha code according to ISO 639-1, e.g. ru for Russian and en for
English.

Default value is pageView=DESKTOP.

sessionTimeoutSecs N...9 no Duration of order life in seconds.

If the parameter is not specified, then the value from merchant settings is used, otherwise - the default value
(1200 seconds - 20 minutes).

If the request contains expirationDate parameter, the parameter the sessionTimeoutSecs is ignored.
 bindingId AN..255 no Identificator of the binding, that was created earlier. May be used only if the merchant has permission to work
with bindings. If this parameter is sent in the request, that means:

1. This order may be payed only by binding;

2. The payer will be redirected to a payment page, where entering of CVC only is required.

expirationDate ANS no Date and time of termination of order life. Format: yyyy-MM-dd'T'HH:mm:ss.

If this parameter is not specified, the sessionTimeoutSecs parameter is used to determine date and time
of termination of order life.

returnUrl AN..512 yes Web address that the client should be redirected after successful payment. Absolute link must be specified.

failUrl AN..512 no Web address that the client should be redirected if the payment failed. Absolute link must be specified.

params no An additional tag with the attributes for passing additional parameters of the merchant.

Fields of additional informaiton to be stored. To send N parameters, the request must contain N params tags
, where the name attribute contains parameter name and value attribute contains parameter value:

Name Type Mandatory Description

name AN..20 yes Name of the additional parameter

value AN..1024 yes Value of the additional parameter

These fields may be passed to the bank processing for their representation in registers.*

This functionality can be switched on during the integration period at the agreement with bank.

If notification of the client is switched on for the merchant, this tag should contain parameter with name emai
l which value is client's email.

clientId AN..255 no Number of the client (identifier) in the merchant system. It is used to realise binding functionality. The request
may contain this parameter only if the merchant is allowed to use bindings.

merchantLogin AN..255 no To register the order from the name of the child merchant, specify its login in this parameter.

* By default the following fields are passed to the bank processing:

orderNumber – order number in the merchant system;

description – order description (not more than 99 simbols, the following simbols are forbidden to use - %, +, \r, \n).

If additional parameter with name merchantOrderId is sent with the order, then its value will be passed to the bank processing as
order number (instead of value of orderNumber field).

Response parameters:

Name Type Mandatory Description

orderId ANS36 no Order number in the payment gate. It is unique within the gate. Absent if order registration failed (error is described by
the errorCode parameter).

formUrl AN..512 no URL of the payment form that the client's browser should be redirected to. Absent if order registration failed (error is
described by the errorCode parameter).

errorCode N3 no Code of the error that occurred during registration of the order.

errorMessage AN..512 no Description of the error in the language specified in the language parameter of the request.

Possible codes for errors (the errorCode field):

Value Description

0 No system error
 1 Order number is invalid

1 Order with this number is already registered in the system

3 Unknown currency

4 Empty emount

4 Empty return URL

4 Order number is empty

5 Invalid value of one of the parameters

5 Access denied

5 The user must change his password

5 Pre-authorization payment is restricted

7 System error

Request example:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:mer="http://engine.paymentgate.ru/webservices/merchant">
<soapenv:Header/>
<soapenv:Body>
<mer:registerOrderPreAuth>
<order merchantOrderNumber="asuaakdfadsfasdfasdd5" description="
" amount="10000" currency=" " language="ru" pageView="MOBILE"
sessionTimeoutSecs=" " bindingId=" " expirationDate="2014-09-08T14:14:14">
<returnUrl>https://web.rbsuat.com/ab/finish.html</returnUrl>
<params name="param1" value="paramValue1"/>
<params name="param2" value="paramValue2"/>
<clientId>7777</clientId>
</order>
</mer:registerOrderPreAuth>
</soapenv:Body>
</soapenv:Envelope>

Response example:
 <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:registerOrderPreAuthResponse
xmlns:ns1="http://engine.paymentgate.ru/webservices/merchant">
<return orderId="5e5dc6bd-dee3-4c96-849a-09f3f575f4b6"
errorCode="0" errorMessage="Success">
<formUrl>
https://web.rbsuat.com/ab/mobile_payment_ru.html?mdOrder=5e5dc6bd-dee3-4c9
6-849a-09f3f575f4b6 </formUrl>
</return>
</ns1:registerOrderPreAuthResponse>
</soap:Body>
</soap:Envelope>

6.2.2. Request for completion of a preauthorized order

To deposit payment for a preauthorized order use the depositOrder request. This request is not available by default.

Request parameters:

Name Type Mandatory Description

orderId ANS36 yes Order number in the payment gate. Unique within the gate.

depositAmount N..5 yes Deposit amount in the order currency. Can be less or equal to the preauthorized amount. Cannot be less than 1
standard currency unit (e.g. 1 euro, currency used depends on the system configuration).

language A2 no Language according to ISO 639-1. If not specified, the system uses the default language from the merchant's settings.
Error message will be returned in this language.

Response parameters:

Name Type Mandatory Description

errorCode N3 no Code of the error that occurred during deposit.

errorMessage AN..512 no Description of the error in the language specified by the Language parameter of the request.

Attention!!! If you specify zero in "DepositAmount" parameter, completion occurs for the entire pre-authorized amount.

Possible codes for errors (the errorCode field):

Value Description

0 No system error

5 deposited amount is exceeding approved amount

5 deposit amount must be at least 1 ruble or equal to zero

5 Access denied

5 The user must change his password

 6 No such order

6 [orderId] is empty

7 Payment must be in approved state

7 System error

Request example:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mer="http://engine.paymentgate.ru/webservices/merc

hant">
<soapenv:Header/>
<soapenv:Body>
<mer:depositOrder>
<order language="ru" orderId="4302d369-a5e8-4432-a5e5-42acfab52c86" depositAmount="30000">
<!-Zero or more repetitions:->
<params name="?" value="?"/>
</order>
</mer:depositOrder>
</soapenv:Body>
</soapenv:Envelope>

Response example:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:depositOrderResponse xmlns:ns1="http://engine.paymentgate.ru/webservices/merchant">

<return errorCode="6" errorMessage="No such order"/>

</ns1:depositOrderResponse>
</soap:Body>
</soap:Envelope>

6.2.3. Order reversal request

To reverse an order use the reverseOrder request. This functionflity is available for a limited period, that is specified by the Bank.

The reversal operation may be performed only once. If the reversal request caused an error, the next try will not be successful.

The reversal operation is available for merchants only under agreement with the Bank. To perform the reversal request a user must have an
appropriate permission.

Request parameters:

Name Type Mandatory Description

orderId ANS36 yes Order number in the payment gate. Unique within the gate.

language A2 no Language according to ISO 639-1. If not specified, the system uses the default language from the merchant's settings. Error
message will be stated in this language.

Response parameters:

Name Type Mandatory Description

errorCode N3 no Code of the error that occurred during reversal.

 errorMessage AN..512 no Description of the error in the language specified in the Language field of the request.

Possible codes for errors (the errorCode field):

Value Description

0 No system error

5 Access denied

5 The user must change his password

5 [orderId] is empty

6 No such order

7 Reversal is impossible for current transaction state

7 System error

Request example:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:mer="http://engine.paymentgate.ru/webservices/merchant">
<soapenv:Header/>
<soapenv:Body>
<mer:reverseOrder>
<order language="en"
orderId="f88a2bbf-2021-4ccc-8783-8a13068a89f9">
<!–Zero or more repetitions:-->
<params name=" " value=" "/>
</order>
</mer:reverseOrder>
</soapenv:Body>
</soapenv:Envelope>

Response example:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:reverseOrderResponse
xmlns:ns1="http://engine.paymentgate.ru/webservices/merchant">
<return errorCode="7" errorMessage="Reversal is impossible for
current transaction state"/>
</ns1:reverseOrderResponse>
</soap:Body>
</soap:Envelope>
6.2.4. Refund request
Use refundOrder request to refund deposited money.

This request returns money paid for the order back to the client. Request causes an error if the client is not charged. The payment gate allows
multiple refunds, but their total amount cannot exceed the amount that was diposited from the client's account as a result of the order.

A user must have a corresponding permission in the system to perform this operation.

Request parameters:

Name Type Mandatory Description

orderId ANS36 yes Order number in the payment gate. It is unique within the gate.

refundAmount N..5 yes Refund amount in the order currency. May be less or equal to the current charged amount (which is lowered by
previous refunds).

language A2 no Language according to ISO 639-1. If not specified, the system uses the default language from the merchant's settings.
Error messages will be stated in this language.

Response parameters:

Name Type Mandatory Description

errorCode N3 no Code of the error that occurred in the process of the refund.

errorMessage AN..512 no Description of the error in the language specified in the Language field of the request.

Possible codes for errors (the errorCode field):

Value Description

0 No system error

5 Access denied

5 The user must change his password

5 [orderId] is empty

5 Amount is invalad

6 No such order

7 Refund is impossible for current transaction state

7 Refund amount exceeds deposited amount

7 System error

Request example:
 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:mer="http://engine.paymentgate.ru/webservices/merchant">
<soapenv:Header/>
<soapenv:Body>
<mer:refundOrder>
<order language=" "
orderId="4302d369-a5e8-4432-a5e5-42acfab52c86" refundAmount="20000">
<!--Zero or more repetitions:-->
<params name=" " value=" "/>
</order>
</mer:refundOrder>
</soapenv:Body>
</soapenv:Envelope>

Response example:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:refundOrderResponse
xmlns:ns1="http://engine.paymentgate.ru/webservices/merchant">
<return errorCode="7" errorMessage="Refund amount exceeds
deposited amount"/>
</ns1:refundOrderResponse>
</soap:Body>
</soap:Envelope>

6.2.5. Order status request

To inquire state of a registered order, use the getOrderStatus request.

The order status must be determined by the value of orderStatus parameter.

authCode field is deprecated.

Request parameters:

Name Type Mandatory Description

orderId ANS36 yes Order identifier in the payment gate. Unique within the gate.

language A2 no Language according to ISO 639-1. If not specified, the system uses the default language from the merchant's settings. Error
messages, if any, will be returned in this language.

Response parameters:

Name Type Mandatory Description

 orderStatus N2 no This paramater shows order status in the payment gate. Possible values are listed in the table below.
Parameter is absent if no order with the specified ID was found.

errorCode N3 no Code of the error that occurred in the course of processing the request.

errorMessage AN..512 no Description of the error in the language specified in the Language field of the request.

orderNumber AN..32 yes Order number (identifier) in the merchant's system

pan N..19 no Masked number of the card that was used for payment. Specified only for paid orders.

expiration N6 no Card expiration date in the YYYYMM format. Specified only for paid orders.

cardholderName A..64 no Cardholder name. Specified only for paid orders.

amount N..20 yes Order amount in minimal currency units (e.g. cents)

currency N3 no Code of the payment's currency (according to ISO 4217).

approvalCode AN6 no IPS authorization code. The field has fixed length of six characters, it can contain both numbers and letters.

authCode N3 no This parameter is deprecated. Its value is always "2", regardless of the order status and processing system
authorization code.

ip AN..20 no IP address of the computer that the order initiated on.

date ANS yes Date of order registration

orderDesctiption AN..512 yes Order description that was sent during registration

actionCodeDesctiption AN..512 yes Description of action code the language specified in the Language field of the request.

clientId AN..255 no Number of the client (identifier) in the merchant's system. Transferred, when order is registred. Present only if
creation of ligaments is allowed for merchant.

bindingId AN..255 no Identificator of the ligament created while paying an order or used to pay for. Present only if creation of
ligaments is allowed for merchant.

The orderStatus field may have the following statuses:

State number Description

0 The order is registered, but not paid yet.

1 Pre-authorisation amount was held (for two-phase payment)

2 The amount was deposited successfully

3 Authorization reversed

4 Transaction was refunded

5 Authorization through the issuer's ACS initiated

6 Authorization declined

Possible codes for errors (the errorCode field):

Value Description

0 No system error.

1 Order with this number is already registered in the system.

2 Payment is declined

5 The user must change his password

5 Access denied

5 [orderId] is empty

6 Unknown order id
 7 System error

Request example:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:mer="http://engine.paymentgate.ru/webservices/merchant">
<soapenv:Header/>
<soapenv:Body>
<mer:getOrderStatus>
<order orderId="b1221b79-5703-42c9-a4b1-ed0d0f36493e"
language="en"/>
</mer:getOrderStatus>
</soapenv:Body>
</soapenv:Envelope>

Response example:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:getOrderStatusResponse
xmlns:ns1="http://engine.paymentgate.ru/webservices/merchant">
<return orderStatus="2" errorCode="0"
orderNumber="456789012345678" pan="411111**1111" expiration="201512"
cardholderName="Ivan" amount="15000" currency="810" approvalCode="123456"
authCode="2" ip="212.5.125.194" date="2013-09-03T16:48:52.459+04:00"
orderDescription=" " actionCodeDescription="Request processed successfully"
clientId="666" bindingId="df0b1801-a754-4576-b174-c2485d98bc9b"/>
</ns1:getOrderStatusResponse>
</soap:Body>
</soap:Envelope>

6.2.6. Extended order status request

To inquire about state of a registered order, use the getOrderStatusExtended request.

Request parameters:

Name Type Mandatory Description

orderId ANS36 yes* Order identifier in the payment gate. Unique within the gate.

merchantOrderNumber AN..32 yes* Order number (identifier) in the merchant'system

language A2 no Language according to ISO 639-1. If not specified, the system uses the default language from the merchant's
settings. Error messages, if any, will be returned in this language.

* It is necessary to specify whether orderId or merchantOrderNumber in the request. If the request contains both parameters, orderId is a
priority.

There are 3 sets of response parameters. These sets depend on getOrderStatusExtended version, specified in merchant settings.
There are 3 sets of response parameters. These sets depend on getOrderStatusExtended version, specified in merchant settings.

Response parameters for versions 01, 02,03:

The following parameters are returned regardless gerOrderStatusExtended version.

Name Type Mandatory Description

orderNumber AN..32 yes Order number (identifier) in the merchant's system

orderStatus N2 no State of the order in the payment gate. The value is selected from the list below. Absent if no order with the
specified ID was found.

actionCode N3 yes Processing system authorization code.

actionCodeDescription AN..512 yes Action code description on the language passed in the parameter Language"

errorCode N3 no Code of the error that occurred in the course of processing the request.

errorMessage AN..512 no Description of the error in the language specified in the Language field of the request.

amount N..20 yes Order amount in minimal currency units (e.g. cents)

currency N3 no Code of the payment's currency (according to ISO 4217).If not specified, assumed to be 810 (Russian
rubles).

date ANS yes Date of order registration.

orderDescription AN..512 no Free-formed description of the order.

ip AN..20 yes IP address of the computer that the order initiated on.

Element merchantOrderParams is present in the reponse if the order contains merchant additional parameters. Each additional parameter is described in
separate element merchantOrderParams by the following fields:

name AN..20 no Name of additional parameter

value AN..1024 no Value of additional parameter

Element cardAuthInfo – the structure includes element secureAuthInfo and the following attributes:

maskedPan N..19 no Masked number of the card that was used for payment. Specified only for paid orders.

expiration N6 no Card expiration date in the YYYYMM format. Specified only for paid orders.

cardholderName A..64 no Cardholder name. Specified only for paid orders.

approvalCode AN6 no IPS authorization code.Specified only for paid orders. The field has fixed length of six characters, it can
contain both numbers and letters.

Element secureAuthInfo (includes element eci and element threeDSInfo with parameters cavv and xid):

eci N..4 no Electronic Commerce Indicator. Set just after the payment order in the case of a permit

cavv ANS..200 no Cardholder Authentication Verification Value. Set just after the payment order in the case of a permit.

xid ANS..80 no Electronic Commerce Transaction Identifier.Set just after the payment order in the case of a permit.

Element bindingInfo consits of the following fields:

clientId AN..255 no Client number (ID) in the shop system, transferred during the order registration. Presents only if a shop is
allowed to create bindings.

bindingId AN..255 no Binding identifier created during order payment or used for payment. Presents only if a shop is allowed to
create bindings.

Response parameters for versions 02, 03:

If getOrderStatusExtended version is 02 or higher, the following parameters are also returned along with parameters described above.

Name Type Mandatory Description

 authDateTime ANS no Authorisation date and time

authRefNum AN..24 no Reference number

terminalId AN..10 no Terminal Id

Response parameters for version 03:

If getOrderStatusExtended version is 03, the following parameters are also returned along with parameters described above.

Name Type Mandatory Description

Element paymentAmountInfo consists of the following parameters:

approvedAmount N..20 no Amount hold on the client's card (only for two-phase payments)

depositedAmount N..20 no Amount confirmed for deposit

refundedAmount N..20 no Refund amount

paymentState N2 no Payment state

Element bankInfo consist of:

bankName AN..200 no Name of issuing bank

bankCountryCode AN..4 no Code of issuing bank country

bankCountryName AN..160 no Country of issuing bank in language specified in language parameter or in user language if language parameter
is empty

The orderStatus field may have the following values:

State number Description

0 The order is registered, but not paid yet.

1 Pre-authorisation amount was held (for two-phase payment)

2 The amount was deposited successfully

3 Authorization reversed

4 Transaction was refunded

5 Authorization through the issuer's ACS initiated.

6 Authorization declined

Possible codes for errors (the errorCode field):

Value Description

0 No system error

1 Expected [orderId] or [orderNumber]

5 Access denied

5 The user must change his password

6 Order not found

7 System error
Request example:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:mer="http://engine.paymentgate.ru/webservices/merchant">
<soapenv:Header/>
<soapenv:Body>
<mer:getOrderStatusExtended>
<order orderId="942e8534-ac73-4e3c-96c6-f6cc448018f7"
language="en">
<!-Optional:->
<merchantOrderNumber> </merchantOrderNumber>
</order>
</mer:getOrderStatusExtended>
</soapenv:Body>
</soapenv:Envelope>

Response example:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:getOrderStatusExtendedResponse
xmlns:ns1="http://engine.paymentgate.ru/webservices/merchant">
<return orderNumber="0s7a84sPe49Hdsddd0134567a0"
orderStatus="2" actionCode="0" actionCodeDescription="Request processed
successfully" amount="33000" currency="810"
date="2013-11-13T16:51:02.785+04:00" orderDescription=" " errorCode="0"
errorMessage="Success">
<attributes name="mdOrder"
value="942e8534-ac73-4e3c-96c6-f6cc448018f7"/>
<cardAuthInfo maskedPan="411111**1111" expiration="201512"
cardholderName="Ivan" approvalCode="123456"/>
<authDateTime>2013-11-13T16:51:02.898+04:00</authDateTime>
<terminalId>111113</terminalId>
<authRefNum>111111111111</authRefNum>
<paymentAmountInfo paymentState="DEPOSITED"
approvedAmount="33000" depositedAmount="33000" refundedAmount="0"/>
<bankInfo bankName="TEST CARD" bankCountryCode="RU"
bankCountryName="Russian Federation"/>
</return>
</ns1:getOrderStatusExtendedResponse>
</soap:Body>
</soap:Envelope>

6.2.7. 3DS enrolled verification request

To inquire about state of 3DS enrolled verification, use the verifyEnrollment request.
Request parameters:

Name Type Mandatory Description

pan N12...19 yes Card number.

Response parameters:

Name Type Mandatory Description

errorCode N3 no Code of the error.

errorMessage AN..512 no Description of the ErrorCode error.

isEnrolled A1 no 3ds enrolled atribute. Available values: Y, N, U.

emitterName AN..160 no Name of the issuer bank

emitterCountryCode AN..4 no Country code of the issuer bank

Possible codes for errors (the errorCode field):

Value Description

0 No system error

1 PAN not specified

1 PAN must be a number from 13 to 19 digits

5 Access denied

5 User must change his password

6 No info found for specified PAN

7 System error

Request example:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mer="http://engine.paymentgate.ru/webservices/merc

hant">
<soapenv:Header/>
<soapenv:Body>
<mer:verifyEnrollment>
<pan>4111111111111111</pan>
</mer:verifyEnrollment>
</soapenv:Body>
</soapenv:Envelope>

Response example:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:verifyEnrollmentResponse xmlns:ns1="http://engine.paymentgate.ru/webservices/merchant">

<return isEnrolled="Y" emitterName="TEST CARD" emitterCountryCode="RU" errorCode="0"/>

</ns1:verifyEnrollmentResponse>
</soap:Body>
</soap:Envelope>
6.2.8. Request for additional parameters adding
To add new additional parameters to an order use addParams request.

If there is an additional parameter in the order and a parameter with the same name is going to be added, the latest passed value of the
parameter will be saved in the order.

Request parameters:

Name Type Mandatory Description

orderId ANS36 yes Order number in the payment gate. It is unique within the gate.

Tag of additional parameters - params:

name AN..20 yes Name of the additional parameter

value AN..1024 yes Value of the additional parameter

Response parameters:

Name Type Mandatory Description

errorCode N3 yes Code of the error.

errorMessage AN..512 no Description of the error. Is absent if the request is successful.

Possible codes for errors (the errorCode field):

Value Description

0 No system error

5 Access denied

5 User must change his password

6 orderId is not specified

6 Incorrect orderId format

7 System error

Request example:
 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:mer="http://engine.paymentgate.ru/webservices/merchant">
<soapenv:Header/>
<soapenv:Body>
<mer:addParams>
<request orderId="02988563-0cc4-4109-84ed-15781f0d718e">
<!--Zero or more repetitions:-->
<params name="Param1" value="Param1"/>
<params name="Param2" value="Param2"/>
</request>
</mer:addParams>
</soapenv:Body>
</soapenv:Envelope>

Response example:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:addParamsResponse
xmlns:ns1="http://engine.paymentgate.ru/webservices/merchant">
<return errorCode="0"/>
</ns1:addParamsResponse>
</soap:Body>
</soap:Envelope>

6.2.9. Payment statistics for a specified period

getLastOrdersForMerchants method allows you to obtain statistics on payments for a certain period.

Request parameters:

Name Type Mandatory Description

language A2 no Language according to ISO 639-1. If not specified, the system uses the default language from the merchant's
settings. Error messages, if any, will be returned in this language.

page N no The result of the request processing is a report divided into pages (each page contains size records).
The response will return a page at number specified in this parameter. Page numbering starts at 0.
If page parameter is not specified in the request, the response will return page number 0.

size N..3 yes Number of records on one page (maximum value is 200).

from ANS yes Date and time of the report period beginning. Format is YYYY-MM-DDTHH:mm:ss

to ANS yes Date and time of the report period end. Format is YYYY-MM-DDTHH:mm:ss

transactionStates A..9 yes This block is designed to specify order states you need to be included into the report. Possible values:
CREATED, APPROVED, DEPOSITED, DECLINED, REVERSED, REFUNDED.

merchants ANS yes List of merchant Logins. Only transactions of specified merchants will be included into the report.

Leave this block empty to receive transactions of all available merchants (which includes child merchants and
merchants specified as viewable in user settings).
searchByCreatedDate boolean no Possible values:

true – search for orders by date of order creation.

false – search for orders by date of payment (thus orders in state CREATED и DECLINED can not be
present in the report).

Default value – false.

Response parameters:

Name Type Mandatory Description

errorCode N..2 yes Code of the error that occurred in the course of the report processing. Description of possible codes is represented in
the table below - "Possible codes for errors (the errorCode field)".

errorMessage AN..512 no Description of the error. Present only in case of error (errorCode is not 0).

orderStatuses Blocks containing data on orders in the report. See the table below - "Parameters of orderStatuses tags".

totalCount N yes Total account of orders in the report (on all pages).

page N yes The number of the current page (it is equal to the page parameter, transferred in the request).

pageSize N..3 yes Maximum number of orders on one page of the report (it is equal to the size parameter, transferred in the request).

Parameters of orderStatuses tags:

Name Type Mandatory Description

orderNumber AN..32 yes Order number (identifier) in the merchant's system

orderStatus N..2 yes State of the order in the payment gate. The value is selected from the list below. Possible values are
represented in the table below - "The orderStatus field".

actionCode N..3 yes Processing system authorization code.

actionCodeDescription AN..512 yes Action code description in the language specified in the parameter language of the request.

amount N..20 yes Order amount in minimal currency units.

currency N3 yes Code of the payment's currency (according to ISO 4217).If not specified, assumed to be default currency.

date ANS yes Date of order registration.

orderDescription AN..512 no Free-formed description of the order from the order registration request.

ip AN..20 no IP address of the payer.

errorCode N..2 yes Error code.

merchantOrderParams no Tag with attributes, used to pass merchant additional parameters. See the table below - "Parameters of merc
hantOrderParams tag".

attributes yes Order attributes in the payment system (order number). See the table below - "Parameters of attributes
tag".

cardAuthInfo no Tag with payment attributes. See the table below - "Параметры блока cardAuthInfo".

bindingInfo no Tag with information on binding used for payment. See the table below - "Parameters of bindingInfo tag".

authDateTime ANS no Date and time of payment authorization.

terminalId AN..10 no Terminal ID.

authRefNum AN..24 no Reference number.

paymentAmountInfo no Tag with information on approved amount, deposited amount and refund.
See the table below - "Parameters of paymentAmountInfo tag".

bankInfo no Tag with information on Issuing Bank. See the table below - "Parameters of bankInfo tag".

Parameters of merchantOrderParams tag:

Name Type Mandatory Description

name AN..20 yes Name of the merchant additional parameter.

value AN..1024 yes Value of the merchant additional parameter.

Parameters of attributes tag:

Name Type Mandatory Description

name A7 yes Attribute name - "mdOrder".

value ANS36 yes Attribute value - order identifier in the payment system (unique in the system).

Parameters of cardAuthInfo tag:

Name Type Mandatory Description

maskedPan N..19 no Masked number of the card that was used for payment.

expiration N6 no Card expiration date in the YYYYMM format.

cardholderName A..64 no Cardholder name.

approvalCode AN6 no IPS authorization code. The field has fixed length of six characters, it can contain both numbers and letters.

Parameters of bindingInfo tag:

Name Type Mandatory Description

clientId AN..255 no Client number (ID) in the merchant system.

bindingId AN..255 no Identifier of the binding used for payment.

Parameters of paymentAmountInfo tag:

Name Type Mandatory Description

paymentState N..9 no Payment state.

approvedAmount N..20 no Amount confirmed for deposit.

depositedAmount N..20 no Deposited amount.

refundedAmount N..20 no Refund amount.

Parameters of bankInfo tag:

Name Type Mandatory Description

bankName AN..200 no Name of the Issuing Bank .

bankCountryCode AN..4 no Code of the Issuing Bank country.

bankCountryName AN..160 no Country of the Issuing Bank in language specified in language parameter or in user language if language para
meter is empty.

The orderStatus field may have the following statuses:

Value Description

0 The order is registered, but it is not paid yet.

1 Pre-authorisation amount is held (for two-phase payment)

2 The amount was deposited successfully

3 Authorization reversed
 4 Transaction was refunded

5 Authorization through the Issuer's ACS initiated.

6 Authorization declined

Possible codes for errors (the errorCode field):

Value Description

0 No system error

5 Mandatory fild is empty

5 Value of transactionStates parameter is invalid

7 System error

10 Parameter size exceeds maximum value

10 Unsufficient rigts to view transactions of specified merchant.

Request example:

<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:mer="http://engine.paymentgate.ru/webservices/merchant">
<soapenv:Header/>
<soapenv:Body>
<mer:getLastOrdersForMerchants>
<request language="en">
<page>0</page>
<size>200</size>
<!-- Optional: -->
<from>2014-09-10T00:00:00</from>
<!-- Optional: -->
<to>2014-11-11T00:00:00</to>
<!-- Optional: -->
<transactionStates>
<!-- Zero or more repetitions: -->
<transactionStates>DEPOSITED</transactionStates>
</transactionStates>
<!-- Optional: -->
<merchants>
<!-- Zero or more repetitions: -->
<merchants>MerchantLogin</merchants>
<searchByCreatedDate>false</searchByCreatedDate>
</merchants>
</request>
</mer:getLastOrdersForMerchants>
</soapenv:Body>
</soapenv:Envelope>
Response example:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:getLastOrdersForMerchantsResponse
xmlns:ns1="http://engine.paymentgate.ru/webservices/merchant">
<return errorCode="0">
<orderStatuses orderNumber="58drs0Pes459Hdsddd0567a0"
orderStatus="2" actionCode="0" actionCodeDescription="Request processed
successfully" amount="250000" currency="810"
date="2014-10-28T12:40:49.233+04:00" orderDescription="Opisanie"
ip="212.5.125.194" errorCode="0">
<merchantOrderParams name="registr1" value="registr1"/>
<attributes name="mdOrder"
value="f1a3365b-542c-4c8d-b34c-e9a7ee8dbc9c"/>
<cardAuthInfo maskedPan="411111**1111" expiration="201512"
cardholderName="Ivan" approvalCode="123456"/>
<bindingInfo clientId="666"
bindingId="1eabfb8e-b90e-4dc8-bef6-14bd392b1cec"/>
<authDateTime>2014-10-28T12:41:01.207+04:00</authDateTime>
<terminalId>111113</terminalId>
<authRefNum>111111111111</authRefNum>
<paymentAmountInfo paymentState="DEPOSITED"
approvedAmount="250000" depositedAmount="250000" refundedAmount="0"/>
<bankInfo bankName="TEST CARD" bankCountryCode="RU"
bankCountryName="Russian Federation"/>
</orderStatuses>
<orderStatuses orderNumber="57drs0Pes459Hdsddd0567a0"
orderStatus="2" actionCode="0" actionCodeDescription="Request processed
successfully" amount="250000" currency="810"
date="2014-10-28T12:34:37.286+04:00" orderDescription="Opisanie"
ip="212.5.125.194" errorCode="0">
<merchantOrderParams name="registr1" value="registr1"/>
<attributes name="mdOrder"
value="09489184-bc5e-44a7-b6c4-3ca1feb8ef69"/>
<cardAuthInfo maskedPan="411111**1111" expiration="201512"
cardholderName="Ivan" approvalCode="123456"/>
<bindingInfo clientId="666"
bindingId="1eabfb8e-b90e-4dc8-bef6-14bd392b1cec"/>
<authDateTime>2014-10-28T12:34:56.046+04:00</authDateTime>
<terminalId>111113</terminalId>
<authRefNum>111111111111</authRefNum>
<paymentAmountInfo paymentState="DEPOSITED"
approvedAmount="250000" depositedAmount="250000" refundedAmount="0"/>
<bankInfo bankName="TEST CARD" bankCountryCode="RU"
bankCountryName="Russian Federation"/>
</orderStatuses>
<totalCount>2</totalCount>
<page>0</page>
<pageSize>200</pageSize>
</return>
</ns1:getLastOrdersForMerchantsResponse>
</soap:Body>
</soap:Envelope>
6.2.10. Request to add a card number to the list of SSL-cards
The updateSSLCardListr equest allows merchant to add a number of a card used for payment to "SSL PAN list".

This method is available for merhcant only at the agreement with the bank. In order to use this method the user must have access rights to work
with fraud lists.

Request parameters:

Name Type Mandatory Description

orderId ANS36 yes Order number in the payment gate. Unique within the gate.

Параметры ответа:

Название Тип Обязательно Описание

errorCode N3 no Error code.

errorMessage AN..512 no Description of the error in the user default language.

Error codes (values of the errorCode field):

Value Description

0 No system error

1 Access denied

2 The user must change his password

3 [mdorder] is not specified

4 There is no payment in the system or [mdorder] is incorrect

6 The card number is already present in the list

7 System error

Request example:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:mer="http://engine.paymentgate.ru/webservices/merchant">
<soapenv:Header/>
<soapenv:Body>
<mer:updateSSLCardList>
<mdorder>e40927ef-6fa2-43f3-bf97-f1f2bc61d4fd</mdorder>
</mer:updateSSLCardList>
</soapenv:Body>
</soapenv:Envelope>
Response example:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:updateSSLCardListResponse
xmlns:ns1="http://engine.paymentgate.ru/webservices/merchant">
<return errorCode="0" errorMessage="Request processing took place
without system errors"/>
</ns1:updateSSLCardListResponse>
</soap:Body>
</soap:Envelope>

7. REST interface

Interactions are implemented as HTTP requests with GET or POST methods to certain URLs, separate for each individual request type
(see "Address data for connections" section for exact addresses). Parameters of interactions are sent as parameters of GET or POST requests;
values should be URL encoded.

Result of processing the request returns as a JSON object. Example:

{"errorCode":"12","errorMessage":"Empty amount"}

For authorization purposes each request should include login and password of the merchant that were produced during its registration. Login and
password values are sent as the following parameters:

Name Type Mandatory Description

userName AN..30 yes Login of a user received during registration.

password AN..30 yes Password of a user received during registration.

Requests for one- and two-phase schemes may differ. Requests for each scheme are described below.

In design of the pages (payment page, the error page) you hve to use Unicode (UTF-8).

Special characters in REST requests must be screened in accordance with the URL-code. The table of characters is represented here - http://web
-developer.name/urlcode/. For example, password "qwe?rt%y" should be transferred as "qwe%0Frt%25y".

If the Error code = 0, the request was processed by the Payment gate without system errors (error code does not show the status of the order).

To get the status of an order should use the request getOrderStatus.do or getOrderStatusExtended.do (one of these methods must
necessarily be implemented under TSP integration with payment gate ).

7.1. Testing of REST requests in an Internet browser

Testing of REST requests with simultaneous work with administrative console in the same Internet browser will entail errors in the console. If you
login in the console, then execute one or more REST requests in the other tab, any try to perform an action in the console after that cause an
error. To make administrative console work correctly:

In some cases it is enough to logout and login again;

Sometimes it is necessary to delete cookie files or to wait untill the session timeout.
 Sometimes it is necessary to delete cookie files or to wait untill the session timeout.

Such situation may be avoided due to one of the following ways:

Use incognito mode for REST requests, while working in the administrative console in the regular window;
Use different Internet browsers for REST requests and administrative console.

7.2. One-phase payment requests

7.2.1. Order registration request

To register an order in the payment gate use register.do request (see "Address data for connections" section).

Request parameters:

Name Type Mandatory Description

userName AN..30 yes Merchant's login received during registration.

password AN..30 yes Merchant's password received during registration.

orderNumber AN..32 yes Number (identifier) of the order in the merchant's system.

amount N..20 yes Order amount in minimal currency units (e.g. cents).

currency N3 yes Code of the payment currency, according to ISO 4217.

returnUrl AN..512 yes Web address that the client should be redirected to after successful payment. Absolute link must be specified.

failUrl AN..512 no Web address that the client should be redirected if the payment failed. Absolute link must be specified.

description AN..512 no Free-formed description of the order.

language A2 no Language according to ISO 639-1. If not specified, the system uses the default language from the merchant's
settings.

pageView ANS..20 no This parameter indicates what type of payment interface pages should be uploaded for the payer. Possible
values:

DESKTOP – to upload pages designed for displaying on PC monitors (pages with names payment_<loc
ale>.html and errors_<locale>.html from archive of payment interface pages);
MOBILE – to upload pages designed for displaying on mobile devices (pages with names mobile_paym
ent_<locale>.html and mobile_errors_<locale>.html from archive of payment interface
pages);
If the merchant has pages with names formed by adding of some prefix to the template part of the page
name, then you can specify necessary prefix in the pageView parameter in order to redirect client to the
corresponding page. For example, if pageView=iphone then pages with names iphone_payment_<l
ocale>.html and iphone_error_<locale>.html will be used.

Where:

locale – the page language in 2-alpha code according to ISO 639-1, e.g. ru for Russian and en for
English.

Default value is pageView=DESKTOP.

clientId AN..255 no Client number (ID) in the shop system. It is used for bundles functionality implementation. Presents only if a
shop is allowed to create links.

merchantLogin AN..255 no To register the order from the name of the child merchant, specify its login in this parameter.

jsonParams AN..1024 no Block for sending of merchant additional parameters. Fields of additional information for storage, should be
sent as:

{"<name1>":"<value1>",...,"<nameN>":"<valueN>"},

These fields may be passed to the bank processing for their representation in registers.*

This functionality can be switched on during the integration period at the agreement with bank.

If notification of the client is switched on for the merchant, this block should contain parameter with name emai
l which value is a client's email.
sessionTimeoutSecs N...9 no Duration of order life in seconds.

If the parameter is not specified, then the value from merchant settings is used, otherwise - the default value
(1200 seconds - 20 minutes).

If the request contains expirationDate parameter, the parameter sessionTimeoutSecs is ignored.

expirationDate ANS no Date and time of termination of order life. Format: yyyy-MM-ddTHH:mm:ss.

If this parameter is not specified, the sessionTimeoutSecs parameter is used to determine date and time of
termination of order life.

bindingId AN..255 no Identificator of the binding, that was created earlier. May be used only if the merchant has permission to work
with bindings. If this parameter is sent in the request, that means:
1. This order may be payed only by binding;
2. The payer will be redirected to a payment page, where entering of CVC only is required.

* By default the following fields are passed to the bank processing:

orderNumber – order number in the merchant system;

description – order description (not more than 99 simbols, the following simbols are forbidden to use - %, +, \r, \n).

If additional parameter with name merchantOrderId is sent with the order, then its value will be passed to the bank processing as
order number (instead of value of orderNumber field).

Response parameters:

Name Type Mandatory Description

orderId ANS36 no Order number in the payment gate. Unique within the gate. Absent if order registration failed (error is described in err
orCode).

formUrl AN..512 no URL of the payment form that the client should be redirectd to. Absent if order registration failed (error is described in e
rrorCode).

errorCode N3 no Code of the error that occurres during registration.

errorMessage AN..512 no Description of the error in the language sent in the language parameter of the request.

Error codes (values of the errorCode field)

Errors classification:

Value Description

0 No system error.

1 Order number is duplicated, order with given order number is processed already

3 Unknown currency

4 Mandatory request parameter was not specified

5 Erroneous value of a request parameter.

7 System error.

Possible error messages:

Value Description

0 No system error

1 Order with this number was already processed.

1 Order with this number was registered, but was not paid off.

1 Invalid orderNumber
 3 Unknown currency.

4 Order number is empty

4 Empty merchant user name

4 Empty amount

4 Return URL cannot be empty

4 Password cannot be empty

5 Invalid value of one of the parameters

5 Access denied

5 The user must change his password

5 Invalid [jsonParams]

7 System error

GET Request example:

https://web.rbsuat.com/ab/rest/register.do?amount=100&currency=810&languag
e=ru&orderNumber=87654321&password=password&returnUrl=https://web.rbsuat.c
om/ab/finish.html&userName=userName&jsonParams={"orderNumber":1234567890}&
pageView=MOBIL&expirationDate=2014-09-08T14:14:14&merchantLogin=merch_child

POST Request example:

amount=100&currency=810&language=ru&orderNumber=87654321&returnUrl=https:/
/web.rbsuat.com/ab/finish.html&jsonParams={"orderNumber":1234567890}&pageV
iew=MOBIL&expirationDate=2014-09-08T14:14:14&merchantLogin=merch_child

Response example:

{"orderId":"70906e55-7114-41d6-8332-4609dc6590f4","formUrl":"https://web.r
bsuat.com/ab/merchants/test/mobile_payment_ru.html?mdOrder=70906e55-7114-4
1d6-8332-4609dc6590f4"}

7.2.2. Order reversal request

To cancel payment of the order, use reverse.do request. This functionflity is available for a limited period, that is specified by the Bank.

The reversal operation may be performed only once. If the reversal request caused an error, the next try will not be successful.

The reversal operation is available for merchants only under agreement with the Bank. To perform the reversal request a user must have an
appropriate permission.

Request parameters:
Request parameters:

Name Type Mandatory Description

userName AN..30 yes Merchant's login received during registration.

password AN..30 yes Merchant's password received during registration.

orderId ANS36 yes Order number in the payment gate. Unique within the gate.

language A2 no Language according to ISO 639-1. If not specified, the system uses the default language from the merchant's settings.

Error messages returned will be written in this very language.

Response parameters:

Name Type Mandatory Description

errorCode N3 no Error code.

errorMessage AN..512 no Description of the error.

Error codes (values of the errorCode field):

Error classification:

Value Description

0 No system error.

5 Erroneous value of a request parameter.

6 Unregistered OrderId.

7 System error.

Possible error messages:

Value Description

0 No system error

5 Access denied

5 The user must change his password

5 [orderId] is empty

6 No such order

7 Payment must be in a correct state.

7 Reversal is impossible. Reason: wrong internal values, check hold and deposited amounts.

7 System error.

GET Request example:

 https://web.rbsuat.com/ab/rest/reverse.do?language=en&orderId=80c45f2e-8db
4-4d20-9324-5b784a1fd8c3&password=password&userName=userName

POST Request example:

language=en&orderId=80c45f2e-8db4-4d20-9324-5b784a1fd8c3

Response example:

{"errorCode":"0","errorMessage":"Success"}

7.2.3. Refund requеst.

Use refund.do request to refund deposited money.

This request returns money paid for the order back to the client. Request causes an error if the client is not charged. The payment gate allows
multiple refunds, but their total amount cannot exceed the amount that was diposited from the client's account as a result of the order.

A user must have a corresponding permission in the system to perform this operation.

Request parameters:

Name Type Mandatory Description

userName AN..30 yes Merchant's login received during registration.

password AN..30 yes Merchant's password received during registration.

orderId ANS36 yes Order number in the payment gate. Unique within the gate.

amount N..20 yes Order amount in minimal currency units (e.g. cents).

Response parameters:

Name Type Mandatory Description

errorCode N3 no Error code.

errorMessage AN..512 no Description of the error.

Error codes (values of the errorCode field)

Classification:

Value Description

0 No system error.

5 Erroneous value of a request parameter.

6 Unregistered OrderId.
 7 System error.

Possible error messages:

Value Description

0 No system error

5 Access denied

5 The user must change his password

5 [orderId] is empty

6 No such order

7 Payment must be in a correct state.

7 Wrong deposit amount (less than 1 currency unit, e.g. 1 euro).

7 System error.

GET Request example:

https://web.rbsuat.com/ab/rest/refund.do?amount=500&currency=810&language=
ru&orderId=5e97e3fd-1d20-4b4b-a542-f5995f5e8208&password=password&userName
=userName

POST Request example:

amount=500&currency=810&language=ru&orderId=5e97e3fd-1d20-4b4b-a542-f5995f
5e8208

Response example:

{"errorCode":0}

7.2.4. Order state request

To get the current state of a registered order send data with getOrderStatus.do method (GET or POST) to the corresponding URL (see
"Address data for connections" section).

The order status should be determined by the value of OrderStatus parameter.

authCode field is deprecated.

Request parameters:

Name Type Mandatory Description

userName AN..30 yes Merchant's login received during registration.

password AN..30 yes Merchant's password received during registration.

orderId ANS36 yes Order number in the payment gate. Unique within the gate.

language A2 no Language according to ISO 639-1. If not specified, the system uses the default language from the merchant's settings.

Error messages returned will be written in this very language.

Response parameters:

Name Type Mandatory Description

OrderStatus N2 no This paramater shows order status in the payment gate. Possible values are listed in the table
below. Parameter is absent if no order with the specified ID was found.

ErrorCode N3 no Error code.

ErrorMessage AN..512 no Description of the error in the language sent in the Language parameter of the request.

OrderNumber AN..32 yes Number (identifier) of the order in the merchant's system.

Pan N..19 no Masked number of the card that was used in payment. Specified only for paid orders.

expiration N6 no Card expiration date in the YYYYMM format. Specified only for paid orders.

cardholderName A..64 no Cardholder name. Specified only for paid orders.

Amount N..20 yes Order amount in minimal currency units (e.g. cents).

currency N3 no Code of the payment currency, according to ISO 4217.

approvalCode AN6 no IPS authorization code. The field has fixed length of six characters, it can contain both numbers
and letters.

authCode N3 no This parameter is deprecated. Its value is always "2", regardless of the order status and
processing system authorization code.

Ip AN..20 no IP address of the user who payed for the order.

bindingInfo (element consits of

clientId and bindingId):

clientId AN..255 no Number of the client (identifier) in the merchant's system. Used to implement a functional of
ligament.May be present, if the merchant is allowed to create the ligament.

bindingId AN..255 no Identificator of the ligament created while paying an order or used to pay for. Present only if
creation of ligaments is allowed for merchant.

The OrderStatus field may have the following values:

State number Description

0 Order registered, but not paid off.

1 Pre-authorisation amount was held (for two-phase payment)

2 The amount was deposited successfully

3 Authorization reversed

4 Transaction was refunded.

5 Authorization through the issuer's ACS initiated

6 Authorization declined

Error codes (values of the ErrorCode field):

Value Description

0 No system error
 2 The order is declined because of an error in the payment credentials.

5 Access denied

5 The user must change his password

5 [orderId] is empty

6 Unknown order id

7 System error

GET request example:

https://web.rbsuat.com/ab/rest/getOrderStatus.do?
language=ru&orderId=5e97e3fd-1d20-4b4b-a542-f5995f5e8208&password=password
&userName=userName

POST request example:

orderId=b8d70aa7-bfb3-4f94-b7bb-aec7273e1fce&language=en

Response example:

{"expiration":"201512","cardholderName":"tr
tr","depositAmount":789789,"currency":"810","approvalCode":"123456","authC
ode":2,"clientId":"666","bindingId":"07a90a5d-cc60-4d1b-a9e6-ffd15974a74f"
,"ErrorCode":"0","ErrorMessage":"Success","OrderStatus":2,"OrderNumber":"2
3asdafaf","Pan":"411111**1111","Amount":789789}

7.2.5. Extended order state request

To inquire about state of a registered order, use the getOrderStatusExtended.do request.

Request parameters

Name Type Mandatory Description

userName AN..30 yes Merchant's login received during registration.

password AN..30 yes Merchant's password received during registration.

orderId ANS36 yes* Order number in the payment gate. Unique within the gate.

orderNumber AN..32 yes* Number (identifier) of the order in the merchant's system.

language A2 no Language according to ISO 639-1. If not specified, the system uses the default language from the merchant's settings.

Error messages returned will be written in this very language.

* It is necessary to specify whether orderId or orderNumber in the request. If the request contains both parameters, orderId is a priority.

There are 3 sets of response parameters. These sets depend on "getOrderStatusExtended version" specified in merchant settings.

Response parameters for versions 01, 02,03:

The following parameters are returned regardless getOrderStatusExtended version.

Name Type Mandatory Description

orderNumber AN..32 yes Number (identifier) of the order in the merchant's system.

orderStatus N2 no Order status in the payment gate. The value is selected from the variants listed below. Absent, if no
matching order was found.

actionCode N3 yes Processing system authorization code.

actionCodeDescription AN..512 yes Action code description on the language passed in the parameter "Language".

errorCode N3 no Error code.

errorMessage AN..512 no Description of the error in the language sent in the Language parameter of the request.

amount N..20 yes Order amount in minimal currency units (e.g. cents).

currency N3 no Code of the payment currency, according to ISO 4217. If not specified, assumed to be 810 (Russian rubles).

date ANS yes Date of order registration.

orderDescription AN..512 no Free-formed description of the order.

ip N.. yes IP address of the user who payed for the order.

Element merchantOrderParams is present in the reponse if the order contains merchant additional parameters. Each additional parameter is described in a
separate block by the following fields:

name AN..20 no Name of additional parameter

value AN..1024 no Value of additional parameter

Element cardAuthInfo has structure which includes the list of element secureAuthInfo and the following fields:

pan N..19 no Masked number of the card that was used in payment. Specified only for paid orders.

expiration N6 no Card expiration date in the YYYYMM format. Specified only for paid orders.

cardholderName A..64 no Cardholder name. Specified only for paid orders.

approvalCode AN6 no IPS authorization code. The field has fixed length of six characters, it can contain both numbers and letters.

Element secureAuthInfo (includes eci parameter and element threeDSInfo with parameters cavv and xid):

eci N..4 no Electronic Commerce Indicator. Set just after the payment order in the case of a permit.

cavv ANS..200 no Cardholder Authentication Verification Value. Set just after the payment order in the case of a permit

xid ANS..80 no Electronic Commerce Transaction Identifier.Set just after the payment order in the case of a permit.

Element bindingInfo consits of the following fields:

clientId AN..255 no Client number (ID) in the shop system, transferred during the order registration. Presents only if a shop is
allowed to create links.

bindingId AN..255 no The identifier of a link created during order payment or used for payment. Presents only if a shop is allowed
to create links.

Response parameters for versions 02, 03:

If getOrderStatusExtended version is 02 or higher, the following parameters are also returned along with parameters described above.
 Name Type Mandatory Description

authDateTime ANS no Authorisation date and time

authRefNum AN..24 no Reference number

terminalId AN..10 no Terminal Id

Response parameters for version 03:

If getOrderStatusExtended version is 03, the following parameters are also returned along with parameters described above.

Name Type Mandatory Description

Element paymentAmountInfo consists of the following fields:

approvedAmount N..20 no Amount hold on the client's card (only for two-phase payments)

epositedAmount N..20 no Amount confirmed for deposit

refundedAmount N..20 no Refund amount

paymentState N2 no Payment state

Element bankInfo consists of the following fields:

bankName AN..200 no Name of issuing bank

bankCountryCode AN..4 no Code of issuing bank country

bankCountryName AN..160 no Country of issuing bank in language specified in language parameter or in user language if language parameter
is empty

The orderStatus field may have the following statuses:

State number Description

0 Order registered, but not paid off

1 Pre-authorisation amount was held (for two-phase payment)

2 The amount was deposited successfully

3 Authorization reversed

4 Transaction was refunded

5 Authorization through the issuer's ACS initiated

6 Authorization declined

Error codes (values of the errorCode field):

Value Description

0 No system error

1 Expected [orderId] или [orderNumber]

2 The order is declined because of an error in the payment credentials

5 Access denied

5 The user must change his password

 6 Order not found

7 System error

GET Request example:

https://web.rbsuat.com/ab/rest/getOrderStatusExtended.do?userName=userName
&password=password&orderId=285b2973-4d02-4980-a54e-57c4d0d2xxx9&language=ru

POST Request example:

orderId=285b2973-4d02-4980-a54e-57c4d0d2xxx9&language=ru

Response example:

{"attributes":[],"date":1342007119386,"currency":"810","amount":100,"actio
nCode":0,"orderNumber":"1212x31334z15","orderDescription":"test","orderSta
tus":2,"ip":"217.12.97.50","actionCodeDescription":"
","merchantOrderParams":[],"cardAuthInfo":{"expiration":"201512","pan":"41
1111**1111","approvalCode":"123456","cardholderName":"dsdqdqd","secureAuth
Info":{"eci":5,"threeDSInfo":{"cavv":"AAABCpEAUBNCAHEgBQAAAAAAAAA=","xid":
"MDAwMDAwMDEzNDIwMDcxMTk3Njc="}}}}

7.2.6. 3DS enrolled verification request

To inquire about state of 3DS enrolled verification, use the verifyEnrollment request.

Requiest parameters:

Name Type Mandatory Description

userName AN..30 yes User login (API)

password AN..30 yes User password (API)

pan N12...19 yes Card number.

Response parameters:

Name Type Mandatory Description

errorCode N3 no Code of the error.

 errorMessage AN..512 no Description of the ErrorCode error.

enrolled A1 no 3ds enrolled atribute. Available values: Y, N, U.

emitterName AN..160 no Name of the issuer bank

emitterCountryCode AN..4 no Country code of the issuer bank

Possible codes for errors (the errorCode field):

Значение Описание

0 No system error

1 PAN not specified

1 PAN must be a number from 13 to 19 digits

5 The user must change his password

5 Access denied

6 No info found for specified PAN.

7 System error.

GET request example::

https://test.paymentgate.ru/testpayment/rest/verifyEnrollment.do?
userName=api&password=***&pan=4111111111111111]

POST request example:

pan=4111111111111111

Response example:

{"errorCode":"0","errorMessage":"Успешно","emitterName":"TEST CARD", "emitterCountryCode":"RU","enrolled":"Y"}

7.2.7. Payment statistics for a specified period

getLastOrdersForMerchants.do method allows you to obtain statistics on payments for a certain period.

Request parameters:

Name Type Mandatory Description

userName AN..30 yes Merchant's login received during registration..

password AN..30 yes Merchant's login received during registration..

language A2 no Language according to ISO 639-1. If not specified, the system uses the default language from the merchant's
settings.
Error messages returned will be written in this very language.

page N no The result of the request processing is a report divided into pages (each page contains size records).
The response will return a page at number specified in this parameter. Page numbering starts at 0.
If page parameter is not specified in the request, the response will return page number 0.
size N..3 yes Number of records on one page (maximum value is 200).

from ANS yes Date and time of the report period beginning. Format is YYYYMMDDHHmmss.

to ANS yes Date and time of the report period end. Format is YYYYMMDDHHmmss.

transactionStates A..9 yes This block is designed to specify order states you need to be included into the report.
Several values should be separated by comma. Possible values: CREATED, APPROVED, DEPOSITED,
DECLINED, REVERSED, REFUNDED.

merchants ANS yes List of merchant Logins. Only transactions of specified merchants will be included into the report. Several
values should be separated by comma.

Leave this field empty to receive transactions of all available merchants (which includes child merchants and
merchants specified as viewable in user settings).

searchByCreatedDate boolean no Possible values:

true – search for orders by date of order creation.

false – search for orders by date of payment (thus orders in state CREATED и DECLINED can not be
present in the report).

Default value – false.

Response parameters:

Name Type Mandatory Description

errorCode N..2 yes Code of the error that occurred in the course of the report processing. Description of possible codes is represented in
the table below - "Possible codes for errors (the errorCode field)".

errorMessage AN..512 no Description of the error. Present only in case of error (errorCode is not 0).

orderStatuses Block containing data on orders in the report. See the table below - "Parameters of orderStatuses tags".

totalCount N yes Total account of orders in the report (on all pages).

page N yes The number of the current page (it is equal to the page parameter, transferred in the request).

pageSize N..3 yes Maximum number of orders on one page of the report (it is equal to the size parameter, transferred in the request).

Parameters of orderStatuses tags:

Name Type Mandatory Description

orderNumber AN..32 yes Order number (identifier) in the merchant's system

orderStatus N..2 yes State of the order in the payment gate. The value is selected from the list below. Possible values are
represented in the table below - "The orderStatus field".

actionCode N..3 yes Processing system authorization code.

actionCodeDescription AN..512 yes Action code description in the language specified in the parameter language of the request.

amount N..20 yes Order amount in minimal currency units.

currency N3 yes Code of the payment's currency (according to ISO 4217).If not specified, assumed to be default currency.

date ANS yes Date of order registration.

orderDescription AN..512 no Free-formed description of the order from the order registration request.

ip AN..20 no IP address of the payer.

errorCode N..2 yes Error code.

merchantOrderParams no Tag with attributes, used to pass merchant additional parameters. See the table below - "Parameters of merc
hantOrderParams tag".

attributes yes Order attributes in the payment system (order number). See the table below - "Parameters of attributes
tag".

cardAuthInfo no Tag with payment attributes. See the table below - "Параметры блока cardAuthInfo".

bindingInfo no Tag with information on binding used for payment. See the table below - "Parameters of bindingInfo tag".

authDateTime ANS no Date and time of payment authorization.

terminalId AN..10 no Terminal ID.

authRefNum AN..24 no Reference number

paymentAmountInfo no Tag with information on approved amount, deposited amount and refund.
See the table below - "Parameters of paymentAmountInfo tag".

bankInfo no Tag with information on Issuing Bank. See the table below - "Parameters of bankInfo tag"

Parameters of merchantOrderParams tag:

Name Type Mandatory Description

name AN..20 yes Name of the merchant additional parameter.

value AN..1024 yes Value of the merchant additional parameter.

Parameters of attributes tag:

Name Type Mandatory Description

name A7 yes Attribute name - "mdOrder".

value ANS36 yes Attribute value - order identifier in the payment system (unique in the system).

Parameters of cardAuthInfo tag:

Name Type Mandatory Description

pan N..19 no Masked number of the card that was used for payment.

expiration N6 no Card expiration date in the YYYYMM format.

cardholderName A..64 no Cardholder name.

approvalCode AN6 no IPS authorization code. The field has fixed length of six characters, it can contain both numbers and letters.

Parameters of bindingInfo tag:

Name Type Mandatory Description

clientId AN..255 no Client number (ID) in the merchant system.

bindingId AN..255 no Identifier of the binding used for payment.

Parameters of paymentAmountInfo tag:

Name Type Mandatory Description

paymentState N..9 no Payment state.

approvedAmount N..20 no Amount confirmed for deposit.

depositedAmount N..20 no Deposited amount.

refundedAmount N..20 no Refund amount.

Parameters of bankInfo tag:

Name Type Mandatory Description

bankName AN..200 no Name of the Issuing Bank .

bankCountryCode AN..4 no Code of the Issuing Bank country.

 bankCountryName AN..160 no Country of the Issuing Bank in language specified in language parameter or in user language if language para
meter is empty.

The orderStatus field may have the following statuses:

Value Description

0 The order is registered, but it is not paid yet.

1 Pre-authorisation amount is held (for two-phase payment)

2 The amount was deposited successfully

3 Authorization reversed

4 Transaction was refunded

5 Authorization through the Issuer's ACS initiated.

6 Authorization declined

Possible codes for errors (the errorCode field):

Value Description

0 No system error

5 Mandatory fild is empty

5 Value of transactionStates parameter is invalid

5 Access denied

7 System error

10 Parameter size exceeds maximum value

10 Unsufficient rigts to view transactions of specified merchant.

GET request example:

https://web.rbsuat.com/ab/rest/getLastOrdersForMerchants.do?userName=userN
ame&password=password&language=en&page=0&size=100&from=20141009160000&to=2
0141111000000&transactionStates=DEPOSITED,REVERSED&merchants=SevenEightNin
e&searchByCreatedDate=true

POST request example:

language=en&page=0&size=100&from=20141009160000&to=20141111000000&transact
ionStates=DEPOSITED,REVERSED&merchants=SevenEightNine&searchByCreatedDate=
true
Response example:

{"errorCode":0,

"orderStatuses":[

{"errorCode":"0","orderNumber":"58drs0Pes459Hdsddd0567a0","orderStatus":2,
"actionCode":0,"actionCodeDescription":"Request processed
successfully","amount":250000,"currency":"810","date":1414485649233,"order
Description":"Opisanie","ip":"212.5.125.194","merchantOrderParams":[{"name
":"registr1","value":"registr1"}],"attributes":[{"name":"mdOrder","value":
"f1a3365b-542c-4c8d-b34c-e9a7ee8dbc9c"}],"cardAuthInfo":{"expiration":"201
512","cardholderName":"Ivan","approvalCode":"123456","pan":"411111**1111"}
,"bindingInfo":{"clientId":"666","bindingId":"1eabfb8e-b90e-4dc8-bef6-14bd
392b1cec"},"authDateTime":1414485661207,"terminalId":"111113","authRefNum"
:"111111111111","paymentAmountInfo":{"paymentState":"DEPOSITED","approvedA
mount":250000,"depositedAmount":250000,"refundedAmount":0},"bankInfo":{"ba
nkName":"TEST CARD","bankCountryCode":"RU","bankCountryName":"Russian
Federation"}},

{"errorCode":"0","orderNumber":"57drs0Pes459Hdsddd0567a0","orderStatus":2,
"actionCode":0,"actionCodeDescription":"Request processed
successfully","amount":250000,"currency":"810","date":1414485277286,"order
Description":"Opisanie","ip":"212.5.125.194","merchantOrderParams":[{"name
":"registr1","value":"registr1"}],"attributes":[{"name":"mdOrder","value":
"09489184-bc5e-44a7-b6c4-3ca1feb8ef69"}],"cardAuthInfo":{"expiration":"201
512","cardholderName":"Ivan","approvalCode":"123456","pan":"411111**1111"}
,"bindingInfo":{"clientId":"666","bindingId":"1eabfb8e-b90e-4dc8-bef6-14bd
392b1cec"},"authDateTime":1414485296046,"terminalId":"111113","authRefNum"
:"111111111111","paymentAmountInfo":{"paymentState":"DEPOSITED","approvedA
mount":250000,"depositedAmount":250000,"refundedAmount":0},"bankInfo":{"ba
nkName":"TEST CARD","bankCountryCode":"RU","bankCountryName":"Russian
Federation"}}],

"totalCount":2,"page":0,"pageSize":100}

7.2.8. Request to add a card number to the list of SSL-cards

The updateSSLCardList.do request allows merchant to add a number of a card used for payment to "SSL PAN list".

This method is available for merhcant only at the agreement with the bank. In order to use this method the user must have access rights to work
with fraud lists.

Request parameters:

Name Type Mandatory Description

mdorder ANS36 yes Order number in the payment gate. Unique within the gate.
Response parameters:

Name Type Mandatory Description

errorCode N3 no Error code.

errorMessage AN..512 no Description of the error in the user default language.

Error codes (values of the errorCode field):

Value Description

0 No system error

1 Access denied

2 The user must change his password

3 [mdorder] is not specified

4 There is no payment in the system or [mdorder] is incorrect

6 The card number is already present in the list

7 System error

Request example:

https://web.rbsuat.com/ab/rest/updateSSLCardList.do?mdorder=a4d7d5e5-441d-
401c-b25e-bd5d9fffe227&userName=987&password=111111

Response example:

{"errorCode":"0","errorMessage":" "}

7.3. Two-phase payment requests

7.3.1. Preauthorized order registration request

Use registerPreAuth.do request for order registration (see "Address data for connections" section).

Request parameters:

Name Type Mandatory Description

userName AN..30 yes Merchant's login received during registration.

password AN..30 yes Merchant's password received during registration.

orderNumber AN..32 yes Number (identifier) of the order in the merchant's system.

amount N..20 yes Order amount in minimal currency units (e.g. cents).

currency N3 yes Code of the payment currency, according to ISO 4217.

returnUrl AN..512 yes Web address that the client should be redirected to after successful payment. Absolute link must be specified.

failUrl AN..512 no Web address that the client should be redirected if the payment failed. Absolute link must be specified.

description AN..512 no Free-formed description of the order.

language A2 no Language according to ISO 639-1. If not specified, the system uses the default language from the merchant's
settings.

pageView ANS..20 no This parameter indicates what type of payment interface pages should be uploaded for the payer. Possible
values:

DESKTOP – to upload pages designed for displaying on PC monitors (pages with names payment_<loc
ale>.html and errors_<locale>.html from archive of payment interface pages);
MOBILE – to upload pages designed for displaying on mobile devices (pages with names mobile_paym
ent_<locale>.html and mobile_errors_<locale>.html from archive of payment interface
pages);
If the merchant has pages with names formed by adding of some prefix to the template part of the page
name, then you can specify necessary prefix in the pageView parameter in order to redirect client to the
corresponding page. For example, if pageView=iphone then pages with names iphone_payment_<l
ocale>.html and iphone_error_<locale>.html will be used.

Where:

locale – the page language in 2-alpha code according to ISO 639-1, e.g. ru for Russian and en for
English.

Default value is pageView=DESKTOP.

clientId AN..255 no Client number (ID) in the merchant system. It is used for bundles functionality implementation. Presents only if
a merchant is allowed to create bindings.

merchantLogin AN..255 no To register the order from the name of the child merchant, specify its login in this parameter.

jsonParams AN..1024 no Block for sending of merchant additional parameters. Fields of additional information for storage, should be
sent as:

{"<name1>":"<value1>",...,"<nameN>":"<valueN>"},

These fields may be passed to the bank processing for their representation in registers.*

This functionality can be switched on during the integration period at the agreement with bank.

If notification of the client is switched on for the merchant, this block should contain parameter with name emai
l which value is a client's email.

sessionTimeoutSecs N...9 no Duration of order life in seconds.

If the parameter is not specified, then the value from merchant settings is used, otherwise - the default value
(1200 seconds - 20 minutes).

If the request contains expirationDate parameter, the parameter sessionTimeoutSecs is ignored.

expirationDate ANS no Date and time of termination of order life. Format: yyyy-MM-ddTHH:mm:ss.

If this parameter is not specified, the sessionTimeoutSecs parameter is used to determine date and time of
termination of order life.

bindingId AN..255 no Identificator of the binding, that was created earlier. May be used only if the merchant has permission to work
with bindings. If this parameter is sent in order registration request, that means:
1. This order may be payed only by binding;
2. The payer will be redirected to a payment page, where entering of CVC only is required.

* By default the following fields are passed to the bank processing:

orderNumber – order number in the merchant system;

description – order description (not more than 99 simbols, the following simbols are forbidden to use - %, +, \r, \n).

If additional parameter with name merchantOrderId is sent with the order, then its value will be passed to the bank processing as
order number (instead of value of orderNumber field).
Response parameters:

Name Type Mandatory Description

orderId ANS36 no Order number in the payment gate. Unique within the gate. Absent if order registration failed (error is described in
ErrorCode).

formUrl AN..512 no URL of the payment form that the client should be redirectd to. Absent if order registration failed (error is described in
ErrorCode).

errorCode N3 no Code of the error that occurres during registration.

errorMessage AN..512 no Description of the error in the language sent in the Language parameter of the request.

Error codes (values of the errorCode field)

Errors classification:

Value Description

0 No system error

1 Order number is duplicated, order with given order number is processed already

3 Unknown currency

4 Mandatory request parameter was not specified

5 Erroneous value of a request parameter.

7 System error.

Possible error messages:

Value Description

0 No system error

1 Order with this number was already processed.

1 Order with this number was registered, but was not paid off.

1 Invalid orderNumber

3 Unknown currency.

4 Order number is empty

4 Empty merchant user name

4 Empty amount

4 Return URL cannot be empty

4 Password cannot be empty

5 Wrong amount.

5 Wrong value of the Language parameter.

5 Merchant login is invalid

5 Access denied

5 The user must change his password

 5 Invalid [jsonParams]

5 Pre-authorization payment is restricted

7 System error.

GET request example:

https://web.rbsuat.com/ab/rest/registerPreAuth.do?amount=100&currency=810&
language=ru&orderNumber=87654321&password=password&returnUrl=https://web.r
bsuat.com/ab/finish.html&userName=userName&jsonParams={"orderNumber":12345
67890}&pageView=DESKTOP&merchantLogin=merch_child

POST request example:

amount=100&currency=810&language=ru&orderNumber=87654321&returnUrl=https:/
/web.rbsuat.com/ab/finish.html&jsonParams={"orderNumber":1234567890}&pageV
iew=DESKTOP&merchantLogin=merch_child

Response example:

{"orderId":"61351fbd-ac25-484f-b930-4d0ce4101ab7","formUrl":"https://web.r
bsuat.com/ab/merchants/test/payment_ru.html?mdOrder=61351fbd-ac25-484f-b93
0-4d0ce4101ab7"}

7.3.2. Order completion request

Use deposit.do request to complete preauthorized payment.

This operation can be performed if there is a corresponding permission in the system.

Request parameters:

Name Type Mandatory Description

userName AN..30 yes Merchant's login received during registration.

password AN..30 yes Merchant's password received during registration.

orderId ANS36 yes Order number in the payment gate. Unique within the gate.

amount N..20 yes Order amount in minimal currency units (e.g. cents).

Attention!!! If you do not specify zero in "DepositAmount" parameter, completion occurs for the entire pre-authorized amount.
Attention!!! If you do not specify zero in "DepositAmount" parameter, completion occurs for the entire pre-authorized amount.

Response parameters

Name Type Mandatory Description

errorCode N3 no Error code.

errorMessage AN..512 no Description of the error.

Error codes (values of the errorCode field)

Error classification:

Value Description

0 No system error.

5 Erroneous value of a request parameter.

6 Unregistered OrderId.

7 System error.

Possible error messages:

Value Description

0 No system error

5 Access denied

5 The user must change his password

5 Invalid amount

5 Deposit amount must be zero, or more than 1 currency unit (e.g. 1 euro).

6 No such order

7 Payment must be in a correct state.

7 System error.

GET Request example:

[https://server/testpayment/rest/deposit.do?
amount=100&currency=810&language=ru&orderId=e5b59d3d-746b-4828-9da4-06f126e01b68

&password=testPwd&userName=testtest]

POST Request example:

amount=100&currency=810&language=ru&orderId=e5b59d3d-746b-4828-9da4-06f126e01b68
Response example:

{"errorCode":0}

7.3.3. Order reversal request

To cancel payment of the order, use reverse.do request. This functionflity is available for a limited period, that is specified by the Bank.

The reversal operation may be performed only once. If the reversal request caused an error, the next try will not be successful.

The reversal operation is available for merchants only under agreement with the Bank. To perform the reversal request a user must have an
appropriate permission.

Request parameters:

Name Type Mandatory Description

userName AN..30 yes Merchant's login received during registration.

password AN..30 yes Merchant's password received during registration.

orderId ANS36 yes Order number in the payment gate. Unique within the gate.

language A2 no Language according to ISO 639-1. If not specified, the system uses the default language from the merchant's settings.

Error messages returned will be written in this very language.

Response parameters:

Name Type Mandatory Description

errorCode N3 no Error code.

errorMessage AN..512 no Description of the error.

Error codes (values of the errorCode field):

Error classification:

Value Description

0 No system error.

5 Erroneous value of a request parameter.

6 Unregistered OrderId.

7 System error.

Possible error messages:

Value Description

0 No system error

5 Access denied
 5 The user must change his password

5 [orderId] is empty

6 No such order

7 Payment must be in a correct state.

7 Reversal is impossible. Reason: wrong internal values, check hold and deposited amounts.

7 System error.

GET Request example:

https://web.rbsuat.com/ab/rest/reverse.do?language=en&orderId=80c45f2e-8db
4-4d20-9324-5b784a1fd8c3&password=password&userName=userName

POST Request example:

language=en&orderId=80c45f2e-8db4-4d20-9324-5b784a1fd8c3

Response example:

{"errorCode":"0","errorMessage":"Success"}

7.3.4. Rеfund requеst.

Use refund.do request to refund deposited money.

This request returns money paid for the order back to the client. Request causes an error if the client is not charged. The payment gate allows
multiple refunds, but their total amount cannot exceed the amount that was diposited from the client's account as a result of the order.

A user must have a corresponding permission in the system to perform this operation.

Request parameters:

Name Type Mandatory Description

userName AN..30 yes Merchant's login received during registration.

password AN..30 yes Merchant's password received during registration.

orderId ANS36 yes Order number in the payment gate. Unique within the gate.

amount N..20 yes Order amount in minimal currency units (e.g. cents).

Response parameters:

Name Type Mandatory Description

errorCode N3 no Error code.

errorMessage AN..512 no Description of the error.

Error codes (values of the errorCode field)

Classification:

Value Description

0 No system error.

5 Erroneous value of a request parameter.

6 Unregistered OrderId.

7 System error.

Possible error messages:

Value Description

0 No system error

5 Access denied

5 The user must change his password

5 [orderId] is empty

6 No such order

7 Payment must be in a correct state.

7 Wrong deposit amount (less than 1 currency unit, e.g. 1 euro).

7 System error.

GET Request example:

https://web.rbsuat.com/ab/rest/refund.do?amount=500&currency=810&language=
ru&orderId=5e97e3fd-1d20-4b4b-a542-f5995f5e8208&password=password&userName
=userName

POST Request example:

amount=500&currency=810&language=ru&orderId=5e97e3fd-1d20-4b4b-a542-f5995f
5e8208

Response example:

{"errorCode":0}

7.3.5. Order state request

To get the current state of a registered order send data with getOrderStatus.do method (GET or POST) to the corresponding URL (see
"Address data for connections" section).

The order status should be determined by the value of OrderStatus parameter.

authCode field is deprecated.

Request parameters:

Name Type Mandatory Description

userName AN..30 yes Merchant's login received during registration.

password AN..30 yes Merchant's password received during registration.

orderId ANS36 yes Order number in the payment gate. Unique within the gate.

language A2 no Language according to ISO 639-1. If not specified, the system uses the default language from the merchant's settings.

Error messages returned will be written in this very language.

Response parameters:

Name Type Mandatory Description

OrderStatus N2 no This paramater shows order status in the payment gate. Possible values are listed in the table
below. Parameter is absent if no order with the specified ID was found.

ErrorCode N3 no Error code.

ErrorMessage AN..512 no Description of the error in the language sent in the Language parameter of the request.

OrderNumber AN..32 yes Number (identifier) of the order in the merchant's system.

Pan N..19 no Masked number of the card that was used in payment. Specified only for paid orders.

expiration N6 no Card expiration date in the YYYYMM format. Specified only for paid orders.

cardholderName A..64 no Cardholder name. Specified only for paid orders.

Amount N..20 yes Order amount in minimal currency units (e.g. cents).

currency N3 no Code of the payment currency, according to ISO 4217.

approvalCode AN6 no IPS authorization code. The field has fixed length of six characters, it can contain both numbers
and letters.

authCode N3 no This parameter is deprecated. Its value is always "2", regardless of the order status and
processing system authorization code.

Ip AN..20 no IP address of the user who payed for the order.

bindingInfo (element consits of

clientId and bindingId):

clientId AN..255 no Number of the client (identifier) in the merchant's system. Used to implement a functional of
ligament.May be present, if the merchant is allowed to create the ligament.

bindingId AN..255 no Identificator of the ligament created while paying an order or used to pay for. Present only if
creation of ligaments is allowed for merchant.

The OrderStatus field may have the following values:

State number Description

0 Order registered, but not paid off.

1 Pre-authorisation amount was held (for two-phase payment)

2 The amount was deposited successfully

3 Authorization reversed
 4 Transaction was refunded.

5 Authorization through the issuer's ACS initiated

6 Authorization declined

Error codes (values of the ErrorCode field):

Value Description

0 No system error

2 The order is declined because of an error in the payment credentials.

5 Access denied

5 The user must change his password

5 [orderId] is empty

6 Unknown order id

7 System error

GET request example:

https://web.rbsuat.com/ab/rest/getOrderStatus.do?
language=ru&orderId=5e97e3fd-1d20-4b4b-a542-f5995f5e8208&password=password
&userName=userName

POST request example:

orderId=b8d70aa7-bfb3-4f94-b7bb-aec7273e1fce&language=en

Response example:

{"expiration":"201512","cardholderName":"tr
tr","depositAmount":789789,"currency":"810","approvalCode":"123456","authC
ode":2,"clientId":"666","bindingId":"07a90a5d-cc60-4d1b-a9e6-ffd15974a74f"
,"ErrorCode":"0","ErrorMessage":"Success","OrderStatus":2,"OrderNumber":"2
3asdafaf","Pan":"411111**1111","Amount":789789}

7.3.6. Extended order state request

To inquire about state of a registered order, use the getOrderStatusExtended.do request.
Request parameters

Name Type Mandatory Description

userName AN..30 yes Merchant's login received during registration.

password AN..30 yes Merchant's password received during registration.

orderId ANS36 yes* Order number in the payment gate. Unique within the gate.

orderNumber AN..32 yes* Number (identifier) of the order in the merchant's system.

language A2 no Language according to ISO 639-1. If not specified, the system uses the default language from the merchant's settings.

Error messages returned will be written in this very language.

* It is necessary to specify whether orderId or orderNumber in the request. If the request contains both parameters, orderId is a priority.

There are 3 sets of response parameters. These sets depend on "getOrderStatusExtended version" specified in merchant settings.

Response parameters for versions 01, 02,03:

The following parameters are returned regardless getOrderStatusExtended version.

Name Type Mandatory Description

orderNumber AN..32 yes Number (identifier) of the order in the merchant's system.

orderStatus N2 no Order status in the payment gate. The value is selected from the variants listed below. Absent, if no
matching order was found.

actionCode N3 yes Processing system authorization code.

actionCodeDescription AN..512 yes Action code description on the language passed in the parameter "Language".

errorCode N3 no Error code.

errorMessage AN..512 no Description of the error in the language sent in the Language parameter of the request.

amount N..20 yes Order amount in minimal currency units (e.g. cents).

currency N3 no Code of the payment currency, according to ISO 4217. If not specified, assumed to be 810 (Russian rubles).

date ANS yes Date of order registration.

orderDescription AN..512 no Free-formed description of the order.

ip N.. yes IP address of the user who payed for the order.

Element merchantOrderParams is present in the reponse if the order contains merchant additional parameters. Each additional parameter is described in a
separate block by the following fields:

name AN..20 no Name of additional parameter

value AN..1024 no Value of additional parameter

Element cardAuthInfo has structure which includes the list of element secureAuthInfo and the following fields:

pan N..19 no Masked number of the card that was used in payment. Specified only for paid orders.

expiration N6 no Card expiration date in the YYYYMM format. Specified only for paid orders.

cardholderName A..64 no Cardholder name. Specified only for paid orders.

approvalCode AN6 no IPS authorization code. The field has fixed length of six characters, it can contain both numbers and letters.

Element secureAuthInfo (includes eci parameter and element threeDSInfo with parameters cavv and xid):

eci N..4 no Electronic Commerce Indicator. Set just after the payment order in the case of a permit.

cavv ANS..200 no Cardholder Authentication Verification Value. Set just after the payment order in the case of a permit

xid ANS..80 no Electronic Commerce Transaction Identifier.Set just after the payment order in the case of a permit.
Element bindingInfo consits of the following fields:

clientId AN..255 no Client number (ID) in the shop system, transferred during the order registration. Presents only if a shop is
allowed to create links.

bindingId AN..255 no The identifier of a link created during order payment or used for payment. Presents only if a shop is allowed
to create links.

Response parameters for versions 02, 03:

If getOrderStatusExtended version is 02 or higher, the following parameters are also returned along with parameters described above.

Name Type Mandatory Description

authDateTime ANS no Authorisation date and time

authRefNum AN..24 no Reference number

terminalId AN..10 no Terminal Id

Response parameters for version 03:

If getOrderStatusExtended version is 03, the following parameters are also returned along with parameters described above.

Name Type Mandatory Description

Element paymentAmountInfo consists of the following fields:

approvedAmount N..20 no Amount hold on the client's card (only for two-phase payments)

epositedAmount N..20 no Amount confirmed for deposit

refundedAmount N..20 no Refund amount

paymentState N2 no Payment state

Element bankInfo consists of the following fields:

bankName AN..200 no Name of issuing bank

bankCountryCode AN..4 no Code of issuing bank country

bankCountryName AN..160 no Country of issuing bank in language specified in language parameter or in user language if language parameter
is empty

The orderStatus field may have the following statuses:

State number Description

0 Order registered, but not paid off

1 Pre-authorisation amount was held (for two-phase payment)

2 The amount was deposited successfully

3 Authorization reversed

4 Transaction was refunded

5 Authorization through the issuer's ACS initiated

6 Authorization declined
Error codes (values of the errorCode field):

Value Description

0 No system error

1 Expected [orderId] или [orderNumber]

2 The order is declined because of an error in the payment credentials

5 Access denied

5 The user must change his password

6 Order not found

7 System error

GET Request example:

https://web.rbsuat.com/ab/rest/getOrderStatusExtended.do?userName=userName
&password=password&orderId=285b2973-4d02-4980-a54e-57c4d0d2xxx9&language=ru

POST Request example:

orderId=285b2973-4d02-4980-a54e-57c4d0d2xxx9&language=ru

Response example:

{"attributes":[],"date":1342007119386,"currency":"810","amount":100,"actio
nCode":0,"orderNumber":"1212x31334z15","orderDescription":"test","orderSta
tus":2,"ip":"217.12.97.50","actionCodeDescription":"
","merchantOrderParams":[],"cardAuthInfo":{"expiration":"201512","pan":"41
1111**1111","approvalCode":"123456","cardholderName":"dsdqdqd","secureAuth
Info":{"eci":5,"threeDSInfo":{"cavv":"AAABCpEAUBNCAHEgBQAAAAAAAAA=","xid":
"MDAwMDAwMDEzNDIwMDcxMTk3Njc="}}}}

7.3.7. 3DS enrolled verification request

To inquire about state of 3DS enrolled verification, use the verifyEnrollment request.

Requiest parameters:
 Name Type Mandatory Description

userName AN..30 yes User password (API)

password AN..30 yes User password (API)

pan N12...19 yes Card number.

Response parameters:

Name Type Mandatory Description

errorCode N3 no Code of the error.

errorMessage AN..512 no Description of the ErrorCode error.

enrolled A1 no 3ds enrolled atribute. Available values: Y, N, U.

emitterName AN..160 no Name of the issuer bank

emitterCountryCode AN..4 no Country code of the issuer bank

Possible codes for errors (the errorCode field):

Value Description

0 No system error

1 PAN not specified

1 PAN must be a number from 12 to 19 digits

5 The user must change his password

5 Access denied

6 No info found for specified PAN.

7 System error.

GET request example::

https://test.paymentgate.ru/testpayment/rest/verifyEnrollment.do?
userName=api&password=***&pan=4111111111111111

POST request example:

pan=4111111111111111

Response example:

{"errorCode":"0","errorMessage":"Успешно","emitterName":"TEST CARD", "emitterCountryCode":"RU","enrolled":"Y"}

7.3.8. Payment statistics for a specified period

getLastOrdersForMerchants.do method allows you to obtain statistics on payments for a certain period.
getLastOrdersForMerchants.do method allows you to obtain statistics on payments for a certain period.

Request parameters:

Name Type Mandatory Description

userName AN..30 yes Merchant's login received during registration..

password AN..30 yes Merchant's login received during registration..

language A2 no Language according to ISO 639-1. If not specified, the system uses the default language from the merchant's
settings.
Error messages returned will be written in this very language.

page N no The result of the request processing is a report divided into pages (each page contains size records).
The response will return a page at number specified in this parameter. Page numbering starts at 0.
If page parameter is not specified in the request, the response will return page number 0.

size N..3 yes Number of records on one page (maximum value is 200).

from ANS yes Date and time of the report period beginning. Format is YYYYMMDDHHmmss.

to ANS yes Date and time of the report period end. Format is YYYYMMDDHHmmss.

transactionStates A..9 yes This block is designed to specify order states you need to be included into the report.
Several values should be separated by comma. Possible values: CREATED, APPROVED, DEPOSITED,
DECLINED, REVERSED, REFUNDED.

merchants ANS yes List of merchant Logins. Only transactions of specified merchants will be included into the report. Several
values should be separated by comma.

Leave this field empty to receive transactions of all available merchants (which includes child merchants and
merchants specified as viewable in user settings).

searchByCreatedDate boolean no Possible values:

true – search for orders by date of order creation.

false – search for orders by date of payment (thus orders in state CREATED и DECLINED can not be
present in the report).

Default value – false.

Response parameters:

Name Type Mandatory Description

errorCode N..2 yes Code of the error that occurred in the course of the report processing. Description of possible codes is represented in
the table below - "Possible codes for errors (the errorCode field)".

errorMessage AN..512 no Description of the error. Present only in case of error (errorCode is not 0).

orderStatuses Block containing data on orders in the report. See the table below - "Parameters of orderStatuses tags".

totalCount N yes Total account of orders in the report (on all pages).

page N yes The number of the current page (it is equal to the page parameter, transferred in the request).

pageSize N..3 yes Maximum number of orders on one page of the report (it is equal to the size parameter, transferred in the request).

Parameters of orderStatuses tags:

Name Type Mandatory Description

orderNumber AN..32 yes Order number (identifier) in the merchant's system

orderStatus N..2 yes State of the order in the payment gate. The value is selected from the list below. Possible values are
represented in the table below - "The orderStatus field".

actionCode N..3 yes Processing system authorization code.

actionCodeDescription AN..512 yes Action code description in the language specified in the parameter language of the request.

amount N..20 yes Order amount in minimal currency units.

currency N3 yes Code of the payment's currency (according to ISO 4217).If not specified, assumed to be default currency.

date ANS yes Date of order registration.

orderDescription AN..512 no Free-formed description of the order from the order registration request.

ip AN..20 no IP address of the payer.

errorCode N..2 yes Error code.

merchantOrderParams no Tag with attributes, used to pass merchant additional parameters. See the table below - "Parameters of merc
hantOrderParams tag".

attributes yes Order attributes in the payment system (order number). See the table below - "Parameters of attributes
tag".

cardAuthInfo no Tag with payment attributes. See the table below - "Параметры блока cardAuthInfo".

bindingInfo no Tag with information on binding used for payment. See the table below - "Parameters of bindingInfo tag".

authDateTime ANS no Date and time of payment authorization.

terminalId AN..10 no Terminal ID.

authRefNum AN..24 no Reference number

paymentAmountInfo no Tag with information on approved amount, deposited amount and refund.
See the table below - "Parameters of paymentAmountInfo tag".

bankInfo no Tag with information on Issuing Bank. See the table below - "Parameters of bankInfo tag"

Parameters of merchantOrderParams tag:

Name Type Mandatory Description

name AN..20 yes Name of the merchant additional parameter.

value AN..1024 yes Value of the merchant additional parameter.

Parameters of attributes tag:

Name Type Mandatory Description

name A7 yes Attribute name - "mdOrder".

value ANS36 yes Attribute value - order identifier in the payment system (unique in the system).

Parameters of cardAuthInfo tag:

Name Type Mandatory Description

pan N..19 no Masked number of the card that was used for payment.

expiration N6 no Card expiration date in the YYYYMM format.

cardholderName A..64 no Cardholder name.

approvalCode AN6 no IPS authorization code. The field has fixed length of six characters, it can contain both numbers and letters.

Parameters of bindingInfo tag:

Name Type Mandatory Description

clientId AN..255 no Client number (ID) in the merchant system.

bindingId AN..255 no Identifier of the binding used for payment.

Parameters of paymentAmountInfo tag:

Name Type Mandatory Description

paymentState N..9 no Payment state.

 approvedAmount N..20 no Amount confirmed for deposit.

depositedAmount N..20 no Deposited amount.

refundedAmount N..20 no Refund amount.

Parameters of bankInfo tag:

Name Type Mandatory Description

bankName AN..200 no Name of the Issuing Bank .

bankCountryCode AN..4 no Code of the Issuing Bank country.

bankCountryName AN..160 no Country of the Issuing Bank in language specified in language parameter or in user language if language para
meter is empty.

The orderStatus field may have the following statuses:

Value Description

0 The order is registered, but it is not paid yet.

1 Pre-authorisation amount is held (for two-phase payment)

2 The amount was deposited successfully

3 Authorization reversed

4 Transaction was refunded

5 Authorization through the Issuer's ACS initiated.

6 Authorization declined

Possible codes for errors (the errorCode field):

Value Description

0 No system error

5 Mandatory fild is empty

5 Value of transactionStates parameter is invalid

5 Access denied

7 System error

10 Parameter size exceeds maximum value

10 Unsufficient rigts to view transactions of specified merchant.

GET request example:

https://web.rbsuat.com/ab/rest/getLastOrdersForMerchants.do?userName=userN
ame&password=password&language=en&page=0&size=100&from=20141009160000&to=2
0141111000000&transactionStates=DEPOSITED,REVERSED&merchants=SevenEightNin
e&searchByCreatedDate=true
POST request example:

language=en&page=0&size=100&from=20141009160000&to=20141111000000&transact
ionStates=DEPOSITED,REVERSED&merchants=SevenEightNine&searchByCreatedDate=
true

Response example:

{"errorCode":0,

"orderStatuses":[

{"errorCode":"0","orderNumber":"58drs0Pes459Hdsddd0567a0","orderStatus":2,
"actionCode":0,"actionCodeDescription":"Request processed
successfully","amount":250000,"currency":"810","date":1414485649233,"order
Description":"Opisanie","ip":"212.5.125.194","merchantOrderParams":[{"name
":"registr1","value":"registr1"}],"attributes":[{"name":"mdOrder","value":
"f1a3365b-542c-4c8d-b34c-e9a7ee8dbc9c"}],"cardAuthInfo":{"expiration":"201
512","cardholderName":"Ivan","approvalCode":"123456","pan":"411111**1111"}
,"bindingInfo":{"clientId":"666","bindingId":"1eabfb8e-b90e-4dc8-bef6-14bd
392b1cec"},"authDateTime":1414485661207,"terminalId":"111113","authRefNum"
:"111111111111","paymentAmountInfo":{"paymentState":"DEPOSITED","approvedA
mount":250000,"depositedAmount":250000,"refundedAmount":0},"bankInfo":{"ba
nkName":"TEST CARD","bankCountryCode":"RU","bankCountryName":"Russian
Federation"}},

{"errorCode":"0","orderNumber":"57drs0Pes459Hdsddd0567a0","orderStatus":2,
"actionCode":0,"actionCodeDescription":"Request processed
successfully","amount":250000,"currency":"810","date":1414485277286,"order
Description":"Opisanie","ip":"212.5.125.194","merchantOrderParams":[{"name
":"registr1","value":"registr1"}],"attributes":[{"name":"mdOrder","value":
"09489184-bc5e-44a7-b6c4-3ca1feb8ef69"}],"cardAuthInfo":{"expiration":"201
512","cardholderName":"Ivan","approvalCode":"123456","pan":"411111**1111"}
,"bindingInfo":{"clientId":"666","bindingId":"1eabfb8e-b90e-4dc8-bef6-14bd
392b1cec"},"authDateTime":1414485296046,"terminalId":"111113","authRefNum"
:"111111111111","paymentAmountInfo":{"paymentState":"DEPOSITED","approvedA
mount":250000,"depositedAmount":250000,"refundedAmount":0},"bankInfo":{"ba
nkName":"TEST CARD","bankCountryCode":"RU","bankCountryName":"Russian
Federation"}}],

"totalCount":2,"page":0,"pageSize":100}
7.3.9. Request to add a card number to the list of SSL-cards
The updateSSLCardList.do request allows merchant to add a number of a card used for payment to "SSL PAN list".

This method is available for merhcant only at the agreement with the bank. In order to use this method the user must have access rights to work
with fraud lists.

Request parameters:

Name Type Mandatory Description

mdorder ANS36 yes Order number in the payment gate. Unique within the gate.

Response parameters:

Name Type Mandatory Description

errorCode N3 no Error code.

errorMessage AN..512 no Description of the error in the user default language.

Error codes (values of the errorCode field):

Value Description

0 No system error

1 Access denied

2 The user must change his password

3 [mdorder] is not specified

4 There is no payment in the system or [mdorder] is incorrect

6 The card number is already present in the list

7 System error

Request example:

https://web.rbsuat.com/ab/rest/updateSSLCardList.do?mdorder=a4d7d5e5-441d-
401c-b25e-bd5d9fffe227&userName=987&password=111111

Response example:

{"errorCode":"0","errorMessage":" "}
8. Payment interface design
File with pages of payment interface must be a ZIP archive that contains pages and forlers with js scripts, css styles and images in its root folder.
An example of the archive with payment interface pages could be provided by Bank.

It is advised to use the 7-zip archiver.

8.1. Requirements to the payment interface pages

The page (payment page. error page) should comply with XHTML standards, with a mandatory DTD declaration.

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

Note!!! XHTML declaration is mandatory, otherwise the payment page may not work properly in some browsers.

Any use of absolute URLs for linking additional resources (pictures, scripts, CSS) is prohibited. All necessary resources must be linked relatively (
http:host/images/test.jpg – not allowed, images/test.jpg – correct).

The ZIP-archive must contain payment interface pages, that are intended for displaying on PC monitors. Names of these pages must match the
following pattern (lower case):

payment_<locale>.html – payment page;

errors_<locale>.html – error page.
Where:
<locale> – the page language in 2-alpha code according to ISO 639-1, e.g. ru for Russian and en for English.

Specific payment interface pages could be created for mobile devices in order to provide compact and high-quality displaying on mobile screens.
Theese pages must also be included into the ZIP-archive. Names of the pages must be in lower case and match the following pattern:

mobile_payment_<locale>.html – payment page for mobile devices;

mobile_errors_<locale>.html – error page for mobile devices.
Where
<locale> – the page language in 2-alpha code according to ISO 639-1, e.g. ru for Russian and en for English.

An arbitrary prefix may be added to the template part of the page name (see template below). It makes possible to specify necessary prefix in the
pageView parameter of order registration request in order to redirect client to the corresponding page. Names of the pages must be in lower case
and match the following pattern:

<prefix>_payment_<locale>.html – payment page for a particular type ofmobile device;

<prefix>_errors_<locale>.html – error page for a particular type ofmobile device.
Where:
<prefix> – an arbitrary value (up to 20 characters, may include letters, number and symbol " _ " ). If this value is sent in pageV
iew parameter of the order registration request, then the payer will be redirected to the corresponding page.
<locale> – the page language in 2-alpha code according to ISO 639-1, e.g. ru for Russian and en for English.

A special parameter, pageView, in order registration requests indicates which type of pages (ordinary, mobile or pages with prefixes in their
names) should be loaded for the client. Description of pageView parameter is represented in paragraphs "Order registration request" and "Order
preauthorization request".

Payment interface archive may also contain the following pages:

Payment page, that opens for a client if binding ID was sent in the registration request.

Final page (if the merchant has an appropriate permission, a client will be redirected to the final page after a payment attempt).
 Final page (if the merchant has an appropriate permission, a client will be redirected to the final page after a payment attempt).
Page of check (check in pdf-format will be formed after a client press the appropriate button on the final page).

It is necessary to use Unicode (UTF-8) while creating pages of payment interface.

8.2. Payment page requirements

The page must contain a number of mandatory objects, as well as a set of fields with predefined names for entering payment information.

8.2.1. Page name

Name of the file of the ordinary page – payment_<locale>.html,

Name of the file of the mobile page – mobile_payment_<locale>.html,

Name of the file with the arbitrary prefix – <prefix>_payment_<locale>.html

Where:

<prefix> – part of the page name that may be sent in pageView parameter of the order registration request in order to redirect the
payer to the corresponding page.
<locale> – the page language in 2-alpha code according to ISO 639-1, e.g. ru for Russian and en for English.

8.2.2. Page header

Header of the page should attach the following scripts:

Standard version:

<script type="text/javascript" src="../../js/jquery-1.8.1.min.js"></script>

<script type="text/javascript"
src="../../js/jquery.timers-1.2.js"></script>
<script type="text/javascript" src="../../js/jquery.url.js"></script>
<script type="text/javascript"
src="../../js/jquery.payment_new.js"></script>
<script>
$(document).payment({
});
</script>

Extended version:
 <script type="text/javascript" src="../../js/jquery-1.8.1.min.js"></script>

<script type="text/javascript"
src="../../js/jquery.timers-1.2.js"></script>
<script type="text/javascript" src="../../js/jquery.url.js"></script>
<script type="text/javascript"
src="../../js/jquery.payment_new.js"></script>
<script>
$(document).payment({
language: "ru",
messageAjaxError: " . .",
messageTimeRemaining: " #MIN#:#SEC#",
visualValidationEnabled: true,
agreementCheckboxEnabled: true,
bindingCheckboxEnabled: true,
getFeeEnabled: true
});
</script>

Fields of the scripts should be filled accordingly:

language — language code, the same as in the name of the page file;
messageAjaxError — message about internal AJAX error (appears, for example, when the system is inaccessible).
messageTimeRemaining — session counter description. It must contain keywords "#MIN#" and "#SEC#" that in a browser will be
swapped for minutes and seconds of the time left until the end of the session.
visualValidationEnabled - switch on/off of visual confirmation of validation results. With true value: if the value entered into the
field is correct, the field is highlighted with green colour; if the value is incorrect, the field is highlighted with red colour. With false value
or absense of this string: visual validation is swithched off, fields do not change their colour.
agreementCheckboxEnabled – switch on/off of merchant offer checkbox. True value switches on the validation of checkbox tick, that
confirms the client's agreement to pay.
bindingCheckboxEnabled – switch on/off of possibility to save card details.
getFeeEnabled – switch on/off of payment commission displaying.

8.2.3. Page body

8.2.3.1. Mandatory elements on the payment page

All blocks and controls described in this section must be present in the body of the payment page.

<div id="orderNumber"></div>

block with the unique order number;

<div id="amount"></div>

block with the order payment amount;

 <div id="feeAmount"></div>

block with commission amount;

<div id="description"></div>

block with the description of the order.

The page must contain the payment form:

<form name="PaymentForm" action="#" method="post" id="formPayment">

<input type="hidden" id="expiry" >
<input type="hidden" id="mdOrder" >
<input type="hidden" id="location" value="/../" >
<input type="hidden" id="language" value="<locale>" >
</form>

All hidden fields listed above are mandatory. Value of the field "language" should contain 2-alpha code of the page's language (ISO 639-1).

The form should also contain fields for entering data for the payment:

<input name="$PAN" id="iPAN" maxlength="19" type="text" autocomplete="off"

/>

a field for card number input;

 <select name="MM" id="month">
<option value="01" selected> 1 - </option>
<option value="02"> 2 - february</option>
<option value="03"> 3 - march</option>
<option value="04"> 4 - april</option>
<option value="05"> 5 - may</option>
<option value="06"> 6 - june</option>
<option value="07"> 7 - july</option>
<option value="08"> 8 - august</option>
<option value="09"> 9 - september</option>
<option value="10">10 - october</option>
<option value="11">11 - november</option>
<option value="12">12 - december</option>
</select> /
<select name="YYYY" id="year">
<option value='2012' selected>2012</option>
<option value='2013'>2013</option>
<option value='2014'>2014</option>
<option value='2015'>2015</option>
<option value='2016'>2016</option>
<option value='2017'>2017</option>
<option value='2018'>2018</option>
<option value='2019'>2019</option>
<option value='2020'>2020</option>
<option value='2021'>2021</option>
<option value='2022'>2022</option>
</select>

2 dropdown lists for month and year of the card's expiry date. These fields are filled in automatically as the page is loaded;

<input name="TEXT" id="iTEXT" maxlength="90" type="text" autocomplete="off"

/>

a field for the cardholder name;

<input name="$CVC" id="iCVC" maxlength="4" type="password"

autocomplete="off" />

a field for CVC/CVV;

<input value="SendPayment2" type="button" id="buttonPayment">

a button for payment confirmation.

The following code must be placed below the payment form:

<form id="acs" method="post" action="">

<input type="hidden" id="MD" name="MD"/>
<input type="hidden" id="PaReq" name="PaReq"/>
<input type="hidden" id="TermUrl" name="TermUrl"/>
</form>

The payment page must also contain the following objects:

<div id="errorBlock" style="color:red;"></div>

block for displaying error messages (e.g. wrong data on the card);

<div id="numberCountdown"></div>

block with the message about time left until the end of the payment session;

<div id="infoBlock"></div>

block for displaying an information message when the user comes to the payment results page;

<div id="indicator" style="display:none;"><img

src="../../img/ajax-loader.gif" height="19" width="220"
alt="indicator"></div>

block with indicator of progress for the server request (during payment authorization and subsequent requests);

<label class="ch-wrap"><input type="checkbox" class="checkbox"

id="createBinding"> </label>

block with condition to save card details of this payment. The header must contain bindingCheckboxEnabled: true.
 <label><input type="checkbox" class="checkbox" id="iAgree"> <br><a
href="#">-</a></label>

block with information on merchant offer. The payment is unavailable untill the client checked the field confirming his agreement. The header must
contain agreementCheckboxEnabled: true.

When all requirements are met for payment of the order on the payment page will be displayed:

- order amount;

- commission;

- number (identifier) of the order in the merchant's system;

- block with condition to save card details of this payment;

- block with information on merchant offer;

- order description (only displayed when filling out the field description);

- field for payer's email.

8.2.3.2. Additional elements on the payment page

8.2.3.2.1. Notification of the client about transaction

If functionality of notification of the payer about deposit/reversal/refund/decline is enabled, you need to add the following block:

<input type="text" id="email"/>

a field for payer's email.

8.2.3.2.2. Displaying of payment parameters

To display payment parameters on the payment page, use the following blocks:

<tr valign="top" id="Parameter_name">

<td valign="top">

where Parameter_name may be one of the following values:

amount - order amount in the minimun units;

amountFormatted - order amount formatted (with a thousands separator and decimal point);
approvedAmount - held amount;
approvedAmountFormatted - held amount formatted (with a thousands separator and decimal point);
currency - three-digit code of the currency;
currencyName - three-letter code of the currency;
date - date of payment completion, dd.MM.yyyy HH:mm:ss;
depositedAmount - deposited amount;
depositedAmountFormatted - deposited amount formatted (with a thousands separator and decimal point);
depositFlag - flag of two-phase transaction;

ipCountryCode - code of payer's country;

 ipCountryCode - code of payer's country;
mdorder - order number in the payment system;
mdOrder - order number in the payment system;
merchantFullName - merchant's full name;
merchantLogin - merchant's login;
orderDescription - order description;
orderNumber - order number in the merchant system;
panCountryCode - code of the country of the payer's card;
paymentState - payment state (started / payment_approved / payment_declined / payment_void/payment_deposited / refunded);
paymentWay - payment way;
processingId - merchant identifier in the processing;
terminalId - terminal ID.

8.2.3.2.3. Displaying of order additional parameters

In order to add any additional parameters use queriedParams. It is necessaty to add paramNames into the header of the payment page.
Parameter to be displayed must be specified in square brackets separated by comma:

$(document).payment({
paramNames:[parameter_name1, parameter_name2, parameter_name3]
});

To display a paramer on the page, you need to add an element with id equal to parameter name. If the parameter contains a link, you need to add
element A with the same id:

<div id=” parameter_name1”></div>

<a href=”#” id=”parameter_name2”></div>

Example:

To display a link to the merchant site it is necessary to:

1. Add the following to the payment page:

Script:

<script>
$(document).payment(
{ paramNames:['backUrl'] }
);
</script>

Element of a link type with the same id as specified above in paramNames:

<a href="#" id="backUrl">Back to merchant site</a>

2. Send a link as additional parameter backUrl of order registration request (jsonParams of REST request; in params tag of SOAP request).

8.2.3.3. Validation of card details

To display for a Payer the process of card details validation, the payment page must contain the following code:

1. .valid
{ border: 1px solid #088A08; background-color: #CEF6CE; }
.invalid
{ border: 1px solid #8A0808; background-color: #F6CECE; }

2. visualValidationEnabled:true,

3. id="iPAN", id="iCVC", id="iTEXT", id="month", id="year

8.3. Payment page requirements if binding ID was sent in the registration request
If the order registration request contained bindingId, the payer will be redirected to a payment page, where entering of CVC only is required.

8.3.1. Page name.

Name of the file of the page – payment_binding_<locale>.html,

Where:

<locale> – the page language in 2-alpha code according to ISO 639-1, e.g. ru for Russian and en for English.

8.3.2. Page header.

Header of the page should attach the following scripts:

<script type="text/javascript" src="../../js/jquery-1.4.2.min.js"></script>

<script type="text/javascript"
src="../../js/jquery.timers-1.2.js"></script>
<script type="text/javascript" src="../../js/jquery.url.js"></script>
<script type="text/javascript"
src="../../js/jquery.payment_binding.js"></script>
<script type="text/javascript">
$(document).payment_binding({
visualValidationEnabled:true
});
$(document).ready(function () {
$(document).payment_binding("validate");
$(document).payment_binding("showError", "");
});
</script>
8.3.3. Page body.
Optional fields:

<div id="orderNumber"></div>

block with the unique order number.

<div id="amount"></div>

block with the order payment amount.

<div id="description"></div>

block with order description.

<div id="maskedPan"></div>

block with masked card number.

The page must contain the payment form:

<form action="" method="post" id="bindingPaymentForm">

The form should also contain fields for entering data for the payment:

<input name="$CVC" id="cvc" maxlength="3" type="password"

autocomplete="off" />

fild for entering of cvc/cvv/cid -code.

<input value="" type="button" id="sendPayment">

a button for payment confirmation.

The following code must be placed below the payment form:

<form id="acs" method="post" action="">

<input type="hidden" id="md" name="MD"/>
<input type="hidden" id="paReq" name="PaReq"/>
<input type="hidden" id="termUrl" name="TermUrl"/>
</form>

The payment page must also contain the following objects:

<div id="errorBlock" style="color:red;"></div>

block for displaying error messages.

<div id="countdown"></div>

block with the message about time left until the end of the payment session.

<div id="infoBlock"></div>

block for displaying an information message when the user comes to the payment results page;

<div id="indicator" style="display:none;"><img

src="../../img/ajax-loader.gif" height="19" width="220"
alt="indicator"></div>

block with indicator of progress for the server request block with indicator of progress for the server request.

8.4. Error page requirements

The page must contain a number of mandatory objects.

8.4.1. Page name

Name of the file of the ordinary page – error_<locale>.html,

Name of the file of the mobile page – mobile_error_<locale>.html,

Name of the file of the page for a particular mobile device – <prefix>_error _<locale>.html

Where:

<prefix> – part of the page name that may be sent in pageView parameter of the order registration request in order to redirect the
payer to the corresponding page.
<locale> – the page language in 2-alpha code according to ISO 639-1, e.g. ru for Russian and en for English.

8.4.2. Page header

Page header should link the following scripts:

<script type="text/javascript" src="../../js/jquery-1.4.2.min.js"></script>

<script type="text/javascript"
src="../../js/jquery.timers-1.2.js"></script>
<script type="text/javascript" src="../../js/jquery.url.js"></script>
<script type="text/javascript" src="../../js/error_page.js"></script>

<script type="text/javascript">
var lang = "<locale>";
</script>

, where <locale> is the 2-alpha code of page locale (ISO 639-1).

8.4.3. Page body

All blocks and controls described below must be put in the page body.

Form:

<form name="errorForm" action="#" method="post" id="errorForm">

<input type="hidden" id="language" value="<locale>" type="hidden">
</form>

, where <locale> is the 2-alpha code of page locale (ISO 639-1).

The form should also contain a block where error messages are displayed (for example, about expired session or payment confirmation).

<div id="errorBlock" style="color:red;"></div>

8.5. Requirements to final page design
If the merchant has an appropriate permission, a client will be redirected to the final page after a payment attempt

8.5.1. Pаge name

Page name – finish.html.

8.5.2. Pаge header

Header of the page should attach the following scripts:

<script type="text/javascript" src="../../js/jquery-1.9.1.min.js"></script>

<script type="text/javascript"
src="../../js/jquery-ui-1.9.2.custom.min.js"></script>
<script type="text/javascript" src="../../js/select.js"></script>
<script type="text/javascript" src="../../js/maskedinput.js"></script>
<script type="text/javascript"
src="../../js/jquery.finish.main.js"></script>
<script type="text/javascript"
src="../../js/jquery.finishpayment.js"></script>
<script type="text/javascript" src="../../js/jquery.url.js"></script>
<script type="text/javascript" src="../../js/localization.js"></script>

<script type="text/javascript">
$(document).paymentFinished();
$( document ).ready(function() {
var logo = $(".user-logo");
function isLogoImg(logodiv){
var img = new Image();
img = logodiv.find(".bg");
img.error(function(){
logodiv.remove();
});
img.load(function(){
logodiv.find(".title-logo").remove();
});
}
isLogoImg(logo);
});
localizePage();
</script>

8.5.3. Pаge body

span elements are used in page desing:
 <span langLbl="<LOCALIZE_PROPERTY>">

Values of <LOCALIZE_PROPERTY> could be seen in localization.js

Also div elements are used in page desing:

<div id="<PROPERTY>"></div>

, where <PROPERTY> – order parameter. Possible values:

status – order status;

paymentDate – pament date;
orderNumber – order number in the payment system;
approvalCode – payment authorization code in IPS;
terminalId – terminal identifier;
refNum – reference number;
amount – order amount;
formattedAmount – formatted amount of the order (with thousands and decimal separator);
feeAmount – fee amount;
formattedFeeAmount – formatted fee amount (with thousands and decimal separator);
currency – payment currency;
panMasked – masked pan number;
expiry – expiry date;
cardholderName – card holder name;
orderDescription – order description;
merchantShortName – merchant name;
merchantFullName – merchant full name;
merchantUrl – merchant URL;
actionCodeDescription – description of code received from processing;
orderParams.<ADDITIONAL_PARAM> – use to display values of additional parameters of transaction, where <ADDITIONAL_PARAM>
– name of additional parameter.

The following elements also could be placed on the final page:

Element of return to the merchant from the final page:

<a class="back-btn" href="#"><span langLbl="backToShop"> </span></a>

Element of PDF file generation:

<a class="pdf" href="#"><span langLbl="saveToPDF"> PDF</span></a>

Scrollbar:
 <div class="load-wrapper">
<div class="bg"></div>
<div class="clock"><span class="hour"></span><span
class="minute"></span></div>
</div>

8.6. Requirements to check page

The client recreives this page as a PDF file after he press "Save as PDF" on the final page.

8.6.1. Page nаme

Page name (successful payment) – finish_template_success_<locale>.html.

Page name (payment declined) – finish_template_error_<locale>.html.

Where:

<locale> – the page language in 2-alpha code according to ISO 639-1, e.g. ru for Russian and en for English.

8.6.2. Requirement to pаge dising

JavaScript should not be used while create this page.

Name of order parameters should be specified in the following way:

${<PROPERTY>}

, where <PROPERTY> – name of order parameter. Possible values:

status – order status;

paymentDate – pament date;
orderNumber – order number in the payment system;
approvalCode – payment authorization code in IPS;
terminalId – terminal identifier;
refNum – reference number;
amount – order amount;
formattedAmount – formatted amount of the order (with thousands and decimal separator);
feeAmount – fee amount;
formattedFeeAmount – formatted fee amount (with thousands and decimal separator);
currency – payment currency;
panMasked – masked pan number;
expiry – expiry date;
cardholderName – card holder name;
orderDescription – order description;
merchantShortName – merchant name;
merchantFullName – merchant full name;
merchantUrl – merchant URL;
actionCodeDescription – description of code received from processing;
orderParams.<ADDITIONAL_PARAM> – use to display values of additional parameters of transaction, where <ADDITIONAL_PARAM>
– name of additional parameter.
 – name of additional parameter.

9. Address data for connections

Employees of a merchant can access the console or make API requests using logins and passwords of a user associated with the merchant.

Description of the test service (WSDL) can be found at the address https://test.paymentgate.ru/testpayment/webservices/merchant-ws?wsdl.

URLs for access to REST methods:

Method name URL

Order registration https://test.paymentgate.ru/testpayment/rest/register.do

Preauthorized order registration https://test.paymentgate.ru/testpayment/rest/registerPreAuth.do

Request for order completion https://test.paymentgate.ru/testpayment/rest/deposit.do

Order reversal request https://test.paymentgate.ru/testpayment/rest/reverse.do

Refund request https://test.paymentgate.ru/testpayment/rest/refund.do

Request for status of an order https://test.paymentgate.ru/testpayment/rest/getOrderStatus.do

Request for extended status of an order https://test.paymentgate.ru/testpayment/rest/getOrderStatusExtended.do

3DS enrolled verification request https://test.paymentgate.ru/testpayment/rest/verifyEnrollment.do

Payment statistics for a specified period https://test.paymentgate.ru/testpayment/rest/getLastOrdersForMerchants.do

Request to add a card number to the list of SSL-cards https://test.paymentgate.ru/testpayment/rest/updateSSLCardList.do

"mpi-host" is a stub for the production server address, it should be replaced with the domain provided by the bank.

10. Test cards

В качестве Cardholder name (Имя владельца карты) указывайте от 2 слов в английской раскладке. / Use two or more words in Roman
letters as the name of the cardholder.

Для всех карт, вовлечённых в 3-D Secure (veres=y, pares=y или a) пароль на ACS: 12345678. / For cards involeved into 3-D Secure (veres=y,
pares=y or a) ACS password is 12345678.

Тестовая среда не предназначена для нагрузочного тестирования - в случае необходимости проведения такого тестирования
ТСП должно обратиться в Банк.

Тестовые карты / Test cards:

pan: 4111 1111 1111 1111

exp date: 2019/12
cvv2: 123
3dsecure: veres=y, pares=y
 pan: 5100 0000 0000 0008
exp date: 2017/12
cvv2: 123
3dsecure: veres=y, pares=y

pan: 6011 0000 0000 0004

exp date: 2019/12
cvv2: 123
3dsecure: veres=y, pares=y

pan: 6390 0200 0000 000003

exp date: 2019/12
cvv2: 123(необязательный параметр)

3dsecure: veres=y, pares=a

pan: 5555 5555 5555 5599

exp date: 2019/12
cvv2: 123
3dsecure: veres=n

pan: 4444 0000 0000 1111

exp date: 2019/12
cvv2: 123
3dsecure: veres=n

pan: 2200 0000 0000 0004

exp date: 2019/12
cvc: 123
3dsecure: veres=n

pan: 2200 0000 0000 0012

exp date: 2019/12
cvc: 123
3dsecure: veres=y pares=n

pan: 2200 0000 0000 0020

exp date: 2019/12
cvc: 123
3dsecure: veres=u

pan: 2200 0000 0000 0038

exp date: 2019/12
cvc: 123
3dsecure: veres=y pares=u

pan: 2200 0000 0000 0046

exp date: 2019/12
cvc: 123
3dsecure: veres=y pares=a

pan: 2200 0000 0000 0053

exp date: 2019/12
cvc: 123
3dsecure: veres=y pares=y

Карта МИР

pan: 2200 0000 0000 0053

exp date: 2019/12
cvv2: 123
3dsecure: VeRes=Y, PaRes=Y

Карта МИР
 pan: 2200 0000 0000 0046
exp date: 2019/12
cvv2: 123
3dsecure: VeRes=Y, PaRes=A

Карта МИР

pan: 2200 0000 0000 0012

exp date: 2019/12
cvv2: 123
3dsecure: VeRes=Y, PaRes=N

Карта МИР

pan: 2200 0000 0000 0038

exp date: 2019/12
cvv2: 123
3dsecure: VeRes=Y, PaRes=U

Карта МИР

pan: 2200 0000 0000 0020

exp date: 2019/12
cvv2: 123
3dsecure: VeRes=U

Карта МИР

pan: 2200 0000 0000 0004

exp date: 2019/12
cvv2: 123
3dsecure: VeRes=N

Карты, возвращающие ошибки /

Cards returning errors:

pan: 5555 5555 5555 5557

exp date: 2019/12
cvv2: 123
3dsecure: veres=y, pares=u

pan: 4444 3333 2222 1111

exp date: 2019/12
cvv2: 123
3dsecure: veres=y, pares=u

Declined. PaRes status is U (-2011)

pan: 4000 0000 0000 0002

exp date: 2019/12
cvv2: 123
3dsecure: veres=u

pan: 5555 5555 4444 4442

exp date: 2019/12
cvv2: 123
3dsecure: veres=u

Declined. VeRes status is U (-2016)

 pan: 4444 4444 4444 4422
exp date: 2019/12
cvv2: 123

Invalid message format (913)

pan: 4444 4444 4444 4455

exp date: 2019/12
cvv2: 123

Card limitations exceeded (902)

pan: 4444 4444 4444 3333

exp date: 2019/12
cvv2: 123

Limit exceeded (123)

pan: 4444 4444 4444 6666

exp date: 2019/12
cvv2: 123

BLOCKED_BY_LIMIT (-20010)

pan: 4444 4444 1111 1111

exp date: 2019/12
cvv2: 123

Network refused transaction (5)

pan: 4444 4444 9999 9999

exp date: 2019/12
cvv2: 123

TDSEC_COMM_ERROR (151017)

pan: 5432 5432 5432 5430

exp date: 2018/08
cvv2: 521

INSUFFICIENT_FUNDS (116)

11. Appendix 1. Binding functionality

11.1. Functionality description
This functionality is used to bind the card number to the buyer id in the merchant system (for example, to login). There are two ways of bindings
use: #displaying on the payment page and #sending of a request.

The first case, #displaying on the payment page:

A user, after his autorization on the merchant site, performs a successful order payment by card. Then he create another order on this site under
the same id. When the payment page opens it will be prompted to auto-complete all card details, except CVC/CVV.

The second case, #sending of a request:

If a binding for a card exists, then during a payment you do not need to specify any card detail, just binding id is necessary.
If a binding for a card exists, then during a payment you do not need to specify any card detail, just binding id is necessary.

In any case the payer has an opportunity to use another card for payment.

11.2. Displaying on the payment page. Form of binding choosing

If the merchant is supposed to use a binding functionality, the payment page may contain a form of binding chooosing for payment.

The form must meet the following conditions:

The form must have an identifier id = "formBinding".

The form should be hidden by default using the CSS property "display: none;".
The form must contain a bindings drop-down list with the name = "bindingId".
The drop-down list should contain one option choice: <option value="" selected="selected">other</option>, when a user chooses to
perform a standard payment without using a binding functionality.
The form must have the input box CVC/CVV with name = "cvc".
The form must contain the button "Pay": <input value="Accept" type="button" id="buttonBindingPayment"> with id =
"buttonBindingPayment".
The input field CVC/CVV and the button "Pay" must be framed by the elements with class="rbs_hidden". When you choose a payment
without binding, these elements will be hidden by setting the CSS "display: none;".

An example of the form:

<form action="" id="formBinding" style="display: none;">

<table cellpadding="10">
<tbody>
<tr valign="TOP">
<td valign="top" width="50%" align="right">
<span> :</span>
</td>
<td valign="top">
<select name="bindingId">
<option value="" selected="selected"></option>
</select>
</td>
</tr>
<tr class="rbs_hidden">
<td align="right">
<span> CVC2/CVV2/CID :</span><br>(on the back side of the card)
</td>
<td>
<input name="cvc" maxlength="4" type="password" autocomplete="off" />
</td>
</tr>
<tr class="rbs_hidden">
<td> </td>
<td valign="top" >
<input value="" type="button" id="buttonBindingPayment">
</td>
</tr>
</tbody>
</table>
</form>
11.3. Requests with bindings

11.3.1. WеbService interface

11.3.1.1. Payment by binding request

paymentOrderBinding request is used for performing the payment by bindings.

Request parameters:

Name Type Mandatory Description

mdOrder ANS36 yes Order number in payment system. Is unique within payment system.

bindingId ANS36 yes The identifier of a link created during order payment or used for payment. Presents only if a shop is allowed to create links.

params no An additional tag with the attributes for passing additional parameters of the merchant.*

language A2 no Language in ISO 639-1 code. If it is not specified then the language which is specified in shop settings will be used by
default (default language)

ip NS15 yes Customer IP address

cvc N4 no CVC cod.

This parameter is mandatory, if the merchant does not have a permission "Can pay without CVC".

email ANS..* no Customer E-mail address

* Fields of additional informaiton to be stored. These filds may be transferred to a bank processing in order to display them in registers.**

This functionality may be enabled under the agreement with the bank during the integration. To send N parameters, the request must contain N
Params tags, where the name attribute contains the name and value attribute contains the value:

Name Type Mandatory Description

name AN..20 yes Name of the additional parameter

value AN..1024 yes Value of the additional parameter

** Fields "orderNumber" and its "description" are sent to the bank processing by default (not more than 99 simbols, the following simbols are
forbidden to use - %, +, \r, \n)

Response parameters:

Name Type Mandatory Description

redirect ANS..* if there is no any errors URL for redirection (SSL)/URL back with ACS (for 3DS)

info ANS..* yes The result of the payment attempt. Possible values are represented below:

Your order is proceeded, redirecting...

Operation declined. Please check the data and available balance of the card. Redirecting...
Sorry, payment cannot be complete. Redirecting...
Payment declined. Please, contact with merchant. Redirecting...
Payment declined. Please, contact with merchant. Redirecting...
Payment declined. Please, contact with your bank. Redirecting...
Payment declined. Please, contact with your bank. Redirecting...
Can't connect with your bank. Please, contact with your bank. Redirecting...
Processing timeout. Please, try again later. Redirecting...

errorCode N1 yes Completion code

errorMessage ANS..* in case of error Description of the ErrorCode error

acsUrl ANS..* in case of 3DS payment URL redirection to ACS

paReq ANS..* iin case of 3DS payment Payment Authentication Request

Possible codes for errors (the errorCode field):

 Value Description

0 Successful

1 It is necessary to specify CVC2/CVV2, since the merchant does not have a permission to provide payments without CVC.

1 Incorrect CVC format

1 [mdOrder] is empty

1 [bindingId] is empty

1 Email address does not satisfy the pattern

1 Invalid language

2 No such order for specified user

2 Unknown binding

5 Access denied

5 User must change his password

5 Session is expired

7 System error

Request example:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"

xmlns:mer="http://engine.paymentgate.ru/webservices/merchant">
<soapenv:Header/>
<soapenv:Body>
<mer:paymentOrderBinding>
<order mdOrder="9213bc5f-5d5b-43d6-a408-b6b93cdde992"
bindingId="ca91a4ab-b6d4-495d-b606-8fb0114e679e" language="ru"
ip="127.0.0.1" cvc="123" email=" ">
<!-Zero or more repetitions:->
<params name=" " value=" "/>
</order>
</mer:paymentOrderBinding>
</soapenv:Body>
</soapenv:Envelope>

Response example:
 <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:paymentOrderBindingResponse
xmlns:ns1="http://engine.paymentgate.ru/webservices/merchant">
<return errorCode="0" info="Your order is proceeded,
redirecting..."

redirect="http://example.ru?orderId=9213bc5f-5d5b-43d6-a408-b6b93cdde992"/>

</ns1:paymentOrderBindingResponse>
</soap:Body>
</soap:Envelope>

11.3.1.2. Unbind card request

Use unBindCard request to deactivate binding.

Request parameters:

Name Type Mandatory Description

bindingId ANS36 yes Identifier of the binding created with payment or used for payment. It can exist only if the merchant is allowed to use bindings

Response parameters:

Name Type Mandatory Description

errorCode N1 yes Completion code

errorMessage ANS..* in case of error Description of the error

Possible codes for errors (the errorCode field):

Value Description

5 Access denied

5 User must change his password

2 Binging isn't active

2 Binding doesn't exist

7 System error

Request example:
 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"

xmlns:mer="http://engine.paymentgate.ru/webservices/merchant">
<soapenv:Header/>
<soapenv:Body>
<mer:unBindCard>
<bindingId>fd3afc57-c6d0-4e08-aaef-1b7cfeb093dc</bindingId>
</mer:unBindCard>
</soapenv:Body>
</soapenv:Envelope>

Response example:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:unBindCardResponse
xmlns:ns1="http://engine.paymentgate.ru/webservices/merchant">
<return errorCode="2" errorMessage="Binging isn't active"/>
</ns1:unBindCardResponse>
</soap:Body>
</soap:Envelope>

11.3.1.3. Bind card request

Use bindCard request to activate binding deactivated earlier.

Request parameters:

Name Type Mandatory Descrption

bindingId ANS36 yes Identifier of the binding created with payment or used for payment. It can exist only if the merchant is allowed to use bindings

Response parameters:

Name Type Mandatory Descrption

errorCode N1 yes Completion code

errorMessage ANS..* in case of error Description of the error

Possible codes for errors (the errorCode field):

Value Description

2 Binding is active

2 Binding doesn't exist

 5 Access denied

5 User must change his password

7 System error

Request example:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"

xmlns:mer="http://engine.paymentgate.ru/webservices/merchant">
<soapenv:Header/>
<soapenv:Body>
<mer:bindCard>
<bindingId>fd3afc57-c6d0-4e08-aaef-1b7cfeb093dc</bindingId>
</mer:bindCard>
</soapenv:Body>
</soapenv:Envelope>

Response example:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:bindCardResponse
xmlns:ns1="http://engine.paymentgate.ru/webservices/merchant">
<return errorCode="2" errorMessage="Binding is active"/>
</ns1:bindCardResponse>
</soap:Body>
</soap:Envelope>

11.3.1.4. Request to change binding expiry date

To change expiry date of the binding use extendBinding request.

Request parameters:

Name Type Mandatory Description

bindingId ANS36 yes Identifier of the binding created with payment or used for payment. It can exist only if the merchant is allowed to use
bindings

newExpiry N6 yes New date (year and month) of binding expiry in YYYYMM format

language А2 no Language in ISO 639-1 code. If it is not specified then the language which is specified in shop settings will be used by
default (default language)

Response parameters:
 Name Type Mandatory Description

errorCode N1 yes Completion code

errorMessage ANS..* in case of error Description of the error

Possible codes for errors (the errorCode field):

Value Description

0 No system error

1 One or more mandatory parameters are not specified or specified incorrectly

2 Binding not found

5 Access denied

5 User must change his password

7 System error

Request example:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:mer="http://engine.paymentgate.ru/webservices/merchant">
<soapenv:Header/>
<soapenv:Body>
<mer:extendBinding>
<request language=" "
bindingId="1eabfb8e-b90e-4dc8-bef6-14bd392b1cec"
newExpiry="201807"/>
</mer:extendBinding>
</soapenv:Body>
</soapenv:Envelope>

Response example:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:extendBindingResponse
xmlns:ns1="http://engine.paymentgate.ru/webservices/merchant">
<return errorCode="0" errorMessage="Success"/>
</ns1:extendBindingResponse>
</soap:Body>
</soap:Envelope>

11.3.1.5. Merchant bindings list request

Use getBindings request to receive a list of merchant bindings.

Request parameters:;
Request parameters:;

Name Type Mandatory Description

clientId AN..255 yes Client number (identifier) in the merchant system, transferred during the order registration. Presents only if a merchant is
allowed to create bindings.

Response parameters:

Name Type Mandatory Description

errorCode N1 yes Completion code.

errorMessage ANS..* in case of Description of the error.

error

binding element (consists of bindingId, mask

edPan, expiryDate):

bindingId AN..255 no Identifier of the binding created with payment or used for payment. It can exist
only if the merchant is allowed to use bindings.

maskedPan N..19 no Masked number of the card that was used for payment. Specified only for paid
orders.

expiryDate N6 no Card expiration date in the YYYYMM format. Specified only for paid orders.

Possible codes for errors (the errorCode field):

Value Description

1 [clientId] is empty

2 Data not found

5 Access denied

5 User must change his password

7 System error

Request example:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"

xmlns:mer="http://engine.paymentgate.ru/webservices/merchant">
<soapenv:Header/>
<soapenv:Body>
<mer:getBindings>
<request clientId="client"/>
</mer:getBindings>
</soapenv:Body>
</soapenv:Envelope>

Response example:
 <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:getBindingsResponse
xmlns:ns1="http://engine.paymentgate.ru/webservices/merchant">
<return errorCode="0" errorMessage="">
<bindings>
<binding bindingId="fd3afc57-c6d0-4e08-aaef-1b7cfeb093dc"
maskedPan="400000**0002"
expiryDate="201512"/>
</bindings>
</return>
</ns1:getBindingsResponse>
</soap:Body>
</soap:Envelope>

11.3.1.6. Request for list of bindings of a bank card

Merchant with appropriate permissions can request information on all bindings of a certain bank card. For that card number or known binding id
must be sent in the request.

In order to receive list of bindings of a certain bank card use getBindingsByCardOrId.do method.

Response will contain all bindings available for the merchant in accordance with merchant settings.

Request parameters:

Name Type Mandatory Description

pan N..19 no Card number. Mandatory if bindingid is not specified.

Search by pan is available only for merchant with appropriate permission.

bindingId AN..255 no Binding identifier. Mandatory if pan is not specified.

If pan is specified, the value of bindingId is ignored.

showExpired boolean no This parameter is used to specify necessity of expired binding displaying. Possible values: true, false. Default value
is false.

language A2 no Language according to ISO 639-1. If not specified, the system uses the default language from the user's settings.
Error messages returned will be written in this very language.

Response request:

Name Type Mandatory Description

errorCode N1 yes Error code.

errorMessage ANS..* yes Description of error.

bindings (contains binding tags):

binding (contains information on bindings – bindingId, maskedPan, expiryDate and client

Id):

bindingId AN..255 no Binding identifier.

 maskedPan N..19 no Masked card number.

expiryDate N6 no Expirition date in YYYYMM format

.

clientId AN..255 no Client dentifier in merchant

system.

Error codes (values of the errorCode field):

Value Description

0 No system error.

1 Both [pan] and [bindingId] are empty.

2 Data not found.

5 Access denied.

5 The user must change his password.

7 System error.

Request example:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:mer="http://engine.paymentgate.ru/webservices/merchant">
<soapenv:Header/>
<soapenv:Body>
<mer:getBindingsByCardOrId>
<request pan="4111111111111111" bindingId=" " showExpired="true"
language="ru"/>
</mer:getBindingsByCardOrId>
</soapenv:Body>
</soapenv:Envelope>

Response example:
 <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:getBindingsByCardOrIdResponse
xmlns:ns1="http://engine.paymentgate.ru/webservices/merchant">
<return errorCode="0" errorMessage="Success">
<bindings>
<binding bindingId="9f43e86d-9744-42a5-8646-c4bb7cf8799a"
maskedPan="411111**1111" expiryDate="201912" clientId="12345"/>
<binding bindingId="51c0750b-1a23-424b-8989-5e8f669124b4"
maskedPan="411111**1111" expiryDate="201512" clientId="123456"/>
<binding bindingId="6a8c0738-cc88-4200-acf6-afc264d66cb0"
maskedPan="411111**1111" expiryDate="201912" clientId="666"/>
<binding bindingId="97a70989-c1fb-49f7-8a42-27c19dc160dw"
maskedPan="411111**1111" expiryDate="201512" clientId="666"/>
</bindings>
</return>
</ns1:getBindingsByCardOrIdResponse>
</soap:Body>
</soap:Envelope>

11.3.2. REST interfacе

11.3.2.1. Payment by binding request

paymentOrderBinding.do request is used for performing the payment by bindings (see "Address data for connections (bindings functionality)"
section).

Request parameters:

Name Type Mandatory Description

userName AN..30 yes Merchant login obtained during connection

password AN..30 yes Merchant password obtained during connection

mdOrder ANS36 yes Order number in payment system. Is unique within payment system.

bindingId AN..255 yes The identifier of a link created during order payment or used for payment. Presents only if a shop is allowed to create
links.

cvc N..3 no CVC code.

This parameter is mandatory, if the merchant does not have a permission "Can pay without CVC".

language A2 no Language in ISO 639-1 code. If it is not specified then the language which is specified in shop settings will be used by
default (default language)

Response parameters:

Name Type Mandatory Description

redirect ANS..* in case of SSL payment URL to which the user is redirected after the payment
 info ANS..* yes The result of the payment attempt. Possible values are represented below:

Your order is proceeded, redirecting...

Operation declined. Please check the data and available balance of the card. Redirecting...
Sorry, payment cannot be complete. Redirecting...
Payment declined. Please, contact with merchant. Redirecting...
Payment declined. Please, contact with merchant. Redirecting...
Payment declined. Please, contact with your bank. Redirecting...
Payment declined. Please, contact with your bank. Redirecting...
Can't connect with your bank. Please, contact with your bank. Redirecting...
Processing timeout. Please, try again later. Redirecting...

success N1 yes Code of the error

error AN..* in case of error Description of the ErrorCode error

acsUrl ANS..* in case of 3DS payment URL for redirection from ACS

paReq ANS..* in case of 3DS payment Payment Authentication Request

termUrl ANS..* in case of 3DS payment Payment Authentication Request

Possible codes for errors (the success field):

Value Description

0 Success

1 It is necessary to specify CVC2/CVV2, since the merchant does not have a permission to provide payments without CVC.

1 Incorrect CVC format

1 Invalid language

2 No binding found

2 No order found

5 User must change his password

5 Access denied

7 System error

POST request example:

mdOrder=65401edc-3fa1-4112-87fd-a569ca69fb6a&bindingId=41954212-70a7-4eae-
8430-90c1a87beda7

Response example:

{"info":"Your order is proceeded,

redirecting...","redirect":"finish.html?login=username&password=testPwd&or
derId=65401edc-3fa1-4112-87fd-a569ca69fb6a","success":0}

11.3.2.2. Unbind card request

Use unBindCard.do request to deactovate binding (see "Address data for connections (bindings functionality)" section).

Request parameters:

Name Type Mandatory Description

userName AN..30 yes Merchant's login received during registration

password AN..30 yes Merchant's password received during registration

bindingId AN..255 yes Identifier of the binding created with payment or used for payment. It can exist only if the merchant is allowed to use
bindings

Response parameters:

Name Type Mandatory Description

errorCode N3 yes Completion code

errorMessage AN..512 in case of error Description of the error

Possible codes for errors (the errorCode field):

Value Description

2 Binding doesn't exist

2 Binging isn't active

5 User must change his password

5 Access denied

7 System error

GET Request example:

https://test.paymentgate.ru/testpayment/rest/unBindCard.do?userName=bindin
g_api&password=testPwd&bindingId=fd3afc57-c6d0-4e08-aaef-1b7cfeb093dc

POST Request example:

bindingId=fd3afc57-c6d0-4e08-aaef-1b7cfeb093dc

Response example:

{"errorCode":"2","errorMessage":"Binging isn't active"}

11.3.2.3. Bind card request

Use bindCard.do request to activate binding (see "Address data for connections (bindings functionality)" section).

Request parameters:

Name Type Mandatory Description

userName AN..30 yes Merchant's login received during registration.

password AN..30 yes Merchant's password received during registration.

bindingId AN..255 yes Identifier of the binding created with payment or used for payment. It can exist only if the merchant is allowed to use
bindings

Response parameters:

Name Type Mandatory Description

errorCode N3 yes Completion code

errorMessage AN..512 in case of error Description of the error

Possible codes for errors (the errorCode field):

Value Description

2 Binging is active

2 Binding doesn't exist

5 User must change his password

5 Access denied

7 System error

GET Request example:

https://test.paymentgate.ru/testpayment/rest/bindCard.do?userName=binding_
api&password=testPwd&bindingId=fd3afc57-c6d0-4e08-aaef-1b7cfeb093dc

POST Request example:

bindingId=fd3afc57-c6d0-4e08-aaef-1b7cfeb093dc

Response example:
 {"errorCode":"2","errorMessage":"Binding is active"}

11.3.2.4. Request to change binding expiry date

To change expiry date of the binding use extendBinding.do request (see "Address data for connections (bindings functionality)" section).

Request parameters:

Name Type Mandatory Description

userName AN..30 yes Merchant's login received during registration.

password AN..30 yes Merchant's password received during registration.

bindingId ANS36 yes Identifier of the binding created with payment or used for payment. It can exist only if the merchant is allowed to use
bindings

newExpiry N6 yes New date (year and month) of binding expiry in YYYYMM format

language А2 no Language in ISO 639-1 code. If it is not specified then the language which is specified in merchant settings will be used by
default (default language).

Response parameters:

Name Type Mandatory Description

errorCode N1 yes Completion code

errorMessage ANS..* in case of error Description of the error

Possible codes for errors (the errorCode field):

Value Description

0 No system error

1 One or more mandatory parameters are not specified or specified incorrectly

2 Binding not found

5 Access denied

5 User must change his password

7 System error

GET request example:

https://test.paymentgate.ru/testpayment/rest/extendBinding.do?
userName=login&password=password&bindingId=1eabfb8e-b90e-4dc8-bef6-14bd392
b1cec&
newExpiry=201612&language=ru

POST request example:

POST request example:

bindingId=1eabfb8e-b90e-4dc8-bef6-14bd392b1cec&
newExpiry=201612&language=ru

Response example:

{"errorCode":"0","errorMessage":"Success"}

11.3.2.5. Merchant bindings list request

Use getBindings.do request to receive a list of merchant bindings (see "Address data for connections (bindings functionality)" section).

Request parameters:

Name Type Mandatory Description

userName AN..30 yes Merchant's login received during registration.

password AN..30 yes Merchant's password received during registration.

clientId AN..255 yes Client number (identifier) in the merchant system, transferred during the order registration. Presents only if a merchant is
allowed to create bindings.

Response parameters:

Name Type Mandatory Description

errorCode N1 yes Completion code

errorMessage AN..512 in case of Description of the error

error

binding element (consists of bindingId,

maskedPan, expiryDate):

bindingId AN..255 no Identifier of the binding created with payment or used for payment. It can exist only if
the merchant is allowed to use bindings

maskedPan N..19 no Masked number of the card that was used for payment. Specified only for paid orders.

expiryDate N6 no Card expiration date in the YYYYMM format. Specified only for paid orders.

Possible codes for errors (the errorCode field):

Value Description

1 [clientId] is empty

2 Data not found

5 Access denied

5 User must change his password

7 System error
GET Request example:

https://test.paymentgate.ru/testpayment/rest/getBindings.do?userName=bindi
ng_api&password=testPwd&clientId=client

POST Request example:

clientId=client

Response example:

{"bindings":[{"bindingId":"fd3afc57-c6d0-4e08-aaef-1b7cfeb093dc","maskedPa
n":"400000**0002","expiryDate":"201512"}],
"errorCode":"0","errorMessage":"Success"}

11.3.2.6. Request for list of bindings of a bank card

Merchant with appropriate permissions can request information on all bindings of a certain bank card. For that card number or known binding id
must be sent in the request.

In order to receive list of bindings of a certain bank card use getBindingsByCardOrId.do method.

Response will contain all bindings available for the merchant in accordance with merchant settings.

Request parameters:

Name Type Mandatory Description

userName AN..30 yes Merchant's login received during registration.

password AN..30 yes Merchant's password received during registration.

pan N..19 no Card number. Mandatory if bindingid is not specified.

Search by pan is available only for merchant with appropriate permission.

bindingId AN..255 no Binding identifier. Mandatory if pan is not specified.

If pan is specified, the value of bindingId is ignored.

showExpired boolean no This parameter is used to specify necessity of expired binding displaying. Possible values: true, false. Default value
is false.

Response parameters:
 Name Type Mandatory Description

errorCode N1 yes Error code.

errorMessage ANS..* yes Description of error.

bindings (contains blocks with parameters bindingId, maskedPan, expiryDate and client
Id):

bindingId AN..255 no Binding identifier.

maskedPan N..19 no Masked card number.

expiryDate N6 no Expirition date in YYYYMM format.

clientId AN..255 no Client dentifier in merchant

system.

Error codes (values of the errorCode field):

Value Description

0 No system error.

1 Both [pan] and [bindingId] are empty.

2 Data not found.

5 Access denied.

5 The user must change his password.

7 System error.

Request example:

https://web.rbsuat.com/ab/rest/getBindingsByCardOrId.do?userName=login&pas
sword=password&pan=4111111111111111

Response example:

{"errorCode":"0","errorMessage":"","bindings":[{"bindingId":"0b8edeb2-8380
-4092-bf7e-1e1a78f2b15e","maskedPan":"411111**1111","expiryDate":"201912",
"clientId":"12"},{"bindingId":"6a8c0738-cc88-4200-acf6-afc264d66cb0","mask
edPan":"411111**1111","expiryDate":"201912","clientId":"666"},{"bindingId"
:"97a70989-c1fb-49f7-8a42-27c19dc160dw","maskedPan":"411111**1111","expiry
Date":"201512","clientId":"666"}]}

11.4. Address data for connections (bindings functionality)

Employees of a merchant can access the console or make API requests using logins and passwords of a user associated with the merchant.

Description of the test service (WSDL) can be found at the address https://test.paymentgate.ru/testpayment/webservices/merchant-ws?wsdl.
Description of the test service (WSDL) can be found at the address https://test.paymentgate.ru/testpayment/webservices/merchant-ws?wsdl.

URLs for access to REST methods:

Method name URL

Payment by binding request https://test.paymentgate.ru/testpayment/rest/paymentOrderBinding.do

Unbind card request https://test.paymentgate.ru/testpayment/rest/unBindCard.do

Bind card request https://test.paymentgate.ru/testpayment/rest/bindCard.do

Request to change binding expiry date https://test.paymentgate.ru/testpayment/rest/extendBinding.do

Merchant bindings list request https://test.paymentgate.ru/testpayment/rest/getBindings.do

Request for list of bindings of a bank card https://test.paymentgate.ru/testpayment/rest/getBindingsByCardOrId.do

12. Appendix 3. External fee for payment

The possibility of this functionality use by a merchant must be agreed with the Bank.

12.1. Addition the to payment page description

1. Enable checking for necessity to charge payment fee by the following row in the payment script settings (in the page header):

getFeeEnabled: true

2. The payment script execute a request to the payment gate in order to define if a fee for a payment should be charged. In case of a positive
response the fee amount is displayed on the payment page.

For this purpose the following block must be included into the payment page body:

<div id="feeBlock" class="row" style="display: none;">

<div class="price">
<span class="size24">
<div id="feeAmount" style="float: left; margin-right: 8px;">0.00</div>
<img src="images/ruble.gif" id="fee-ruble-sign" class="ruble-img" style="display: none; float: right;"/>

</span>
</div>
<div class="name"><span>Комиссия за платеж</span></div>
</div>

12.2. Testing
1. You can register your oder on the following page: https://nginx01.rbs.bpc.in/alfapayment/merchants/test/test.html:
It is necessary to specify: user's Login and Password (the merchant of this user must have permission "Allow to charge a commission from
client"), order number in the merchant system, order amount and back URL.
Note: Back URL should be actual, for instance http://bpc.ru

2. Enter all necessary data and press button "Зарегистрировать заказ (списание)" or "Зарегистрировать заказ (предавторизация)",
depending on merchant scheme of work - one- or two-phase.

3. A redirect to the payment page is performed - [https://nginx01.rbs.bpc.in/alfapayment/merchants/[merchant_name]/payment_ru.html?mdOrder

=[order_id].
On the picture below as an example [merchant_name] = 789:

4. Replace [merchant_name] by rbs in the URL and press Enter. This will open a new payment page supporting work with payment fees:
5. The page contains the fee amount in the payment currency and a checkbox "Я ознакомлен и принимаю условия договора-оферты".
To see conditions press the corresponding link. You will be redirected to the URL, specified in the merchant settings.

6. To complete payment enter card details, check "Я ознакомлен и принимаю условия договора-оферты" field and press "Оплатить".

The fee amount will be passed in the additional parameter payment_fee of the payment request. It will be displayed in the administrative
console:

On the Orders page in the "Additional parameters" column;

On the order details page in the "Additional parameters" section.

13. Appendix 4. Specification of additional fields for payments in

air-commerce
Unable to render {include} The included page could not be found.
14. Appendix 5. Dynamically formed pages
Displaying of optional fields on payment pages, payment result pages and error pages depends on merchant settings, in other words on merchant
permissions.

14.1. Dinamically formed payment page

14.1.1. External commission

Functionality activation

To activate the merchat work with external commissions, the administrator must configure the following settings through the administrative
console:

The merchant must have permission "Allow to charge a commission from client".
It is necessary to specify a URL where a payer will be redirected after pressing a corresponding link to see merchant offer. The
URL must be entered in the "Merchant Information" window --> "Common info" tab --> "Merchant offer address" field, that
becomes available only after "Allow to charge a commission from client" permission enabling.

Displaying on the payment page

If the merchant works with external commissions, the corresponding user interface elements become activated on the payment page:

Field "Commission amount" ("Комиссия за платёж") shows comission amount in the order currency.
Checkbox of the agreement with terms of the commission charging and the link to the Contract. The payment becomes available
only after this field is checked.

Payment page of the merchant that has a permission to work with external commissions:
14.1.2. Bindings
Functionality activation

To activate the merchat work with bindings, the administrator must configure the following settings through the administrative console:

The merchant must have permission "Merchant is allowed to use bindings".

To activate the binding functionality on the payment page:

The order registration request must contain client ID.

Displaying on the payment page

If the merchant works with bindings and the order registration request contains client ID, the corresponding user interface elements become
activated on the payment page (see the picture below):

The field for PAN entering contains a dropdown with masked card numbers that are bound to the client ID.

After choosing of a card from dropdown, other fields of card details become non-editable except "CVV2/CVC2" field.

The client also can use another card not bound to the client ID. In this case it is necessary to enter all card details into
appropriate fields.

Checkbox "Save details of this card" ("Запомнить данные этой карты") allows the client to bind the card to the client ID.

In order to do this the client must enter details of new card and check the field "Save details of this card" ("Запомнить
данные этой карты"). After the payment a new binding will be created.

During the next payment this card will be available in the dropdown in the PAN field.

Payment page of the merchant that has a permission to work with bindings:
14.1.3. Payment through Alfa-click
Functionality activation

To activate the merchat work with Alfa-click, the administrator must configure the following settings through the administrative console:

The merchant must have permission "Merchant is allowed to pay by other way".
It is necessary to specify additional parameters for "Alfa-click" payment way in the "Merchant information" window on the
"Alternative payment ways" tab.

Displaying on the payment page

If the merchant works with Alfa-click payment way, the corresponding user interface element becomes activated on the payment page (see
the picture below):

Button "You can pay through Alfa-click" ("Можно оплатить через Альфа-клик"). After pressing it the client will be redirected to
the Alfa-click page (the client should not fill in any fields on the payment page).

Payment page of the merchant that has a permission to work with Alfa-click:
14.1.4. Error of CVV/CVC entering
The format of "CVV2/CVC2" field content is checked on the payment page.

If the merchant has permission "Can pay without CVC", the "CVV2/CVC2" field is considered to be filled in correctly in the following cases:

The field is empty;

There are three digits in the field.

If the merchant does not have permission "Can pay without CVC", the "CVV2/CVC2" field is considered to be filled in correctly only in the
following case:

There are three digits in the field.

In all other cases the field is considered to be filled in incorrectly, and corresponding error message appears on the payment page after the client
confirms the payment:
14.2. Dinamically formed page of payment result
To be provided...

14.3. Dinamically formed error page

To be provided...

15. Appendix 6. Response codes - actionCode description (processing

answer)
Код ответа – это цифровое обозначение результата, к которому привело обращение к системе со стороны пользователя. В системе
определены следующие коды:

Action code – digital code of a result received after a client addressed to the system. The following codes exist in the system:

Action error_id error_message Описание / Description Рекомендованные сообщения для Клиента /

code Recommended messages for a Client
-20010 -20010 BLOCKED_BY_LIMIT Транзакция отклонена по причине того, что размер Ошибка проведения платежа. Попробуйте позднее. Если
платежа превысил установленные лимиты данная ошибка возникла повторно, обратитесь в Ваш банк
Банком-эмитентом / для разъяснения причин. Телефон банка должен быть
Transaction is rejected since the amount exceeds limits указан на обратной стороне карты. /
specified by the Issuing bank
Payment error. Try again later. If this error occures repeatedly,
please contact your bank for more details. You can find bank
telephone number on the back side of your bank card.

-9000 -9000 Started Состояние начала транзакции / State of transaction При возникновении данного actionCode сообщение Клиенту
start не отображается.

-3003 -3003 Неизвестно Неизвестно / Unkown Ошибка проведения платежа. Попробуйте позднее. /
Payment error. Please try again later.

-2102 -2102 Блокировка по имени Блокировка по имени пассажира / Regect by a Ошибка проведения платежа. Обратитесь к представителю
пассажира passanger name магазина для разъяснения причин. /

Payment error. Please contact representative of the merchant

for more details.

-2101 -2101 Блокировка по e-mail Блокировка по e-mail / Reject by email Ошибка проведения платежа. Обратитесь к представителю
магазина для разъяснения причин. /

Payment error. Please contact representative of the merchant

for more details.

-2020 -2020 Получен неверный ECI Получен неверный ECI. Код выставляется в том Ошибка проведения платежа. Попробуйте позднее. /
случае, если пришедший в PaRes ECI не Payment error. Please try again later.
соответствует допустимому значению для данной
МПС. Правило работает только для Mastercard
(01,02) и Visa (05,06), где значения в скобках -
допустимые для МПС. /
Invalid ECI. This code means that ECI received in PaRes
is not valid for the IPS. The rule applies only to
Mastercard (available values - 01,02) and Visa (available
values - 05,06).

-2019 -2019 Decline by iReq in PARes PARes от эмитента содержит iReq, вследствие чего Ошибка проведения платежа. Попробуйте позднее. Если
платеж был отклонен / данная ошибка возникла повторно, обратитесь в Ваш банк
PARes from the issuing bank contains iReq, which для разъяснения причин. Телефон банка должен быть
caused the payment rejection указан на обратной стороне карты. /

Payment error. Try again later. If this error occures repeatedly,

please contact your bank for more details. You can find bank
telephone number on the back side of your bank card.

-2018 -2018 Declined. DS connection timeout Directory server Visa или MasterCard либо недоступен, Ошибка проведения платежа. Попробуйте позднее. /
либо в ответ на запрос вовлеченности карты (VeReq) Payment error. Please try again later.
пришла ошибка связи. Это ошибка взаимодействия
платежного шлюза и серверов МПС по причине
технических неполадок на стороне последних. /
There is no access to Directory server Visa or MaterCard
or a connection error occured after card involvement
request (VeReq). This is an error of interacion between
payment gate and IPS servers due to technical problems
on the side of IPS servers.

-2017 -2017 Отклонено. Статус PARes-а не Отклонено. Статус PARes-а не "Y"/ Rejected. PARes Ошибка проведения платежа. Обратитесь к представителю
"Y" status is not "Y" магазина для разъяснения причин. /

Payment error. Please contact representative of the merchant

for more details.

-2016 -2016 Declined. VeRes status is Банк-эмитент не смог определить, является ли карта Ошибка проведения платежа. Попробуйте позднее. Если
unknown 3dsecure. / Issuing bank could not determine if the card данная ошибка возникла повторно, обратитесь в Ваш банк
is 3dsecure. для разъяснения причин. Телефон банка должен быть
указан на обратной стороне карты. /

Payment error. Try again later. If this error occures repeatedly,

please contact your bank for more details. You can find bank
telephone number on the back side of your bank card.

-2015 -2015 Decline by iReq in VERes VERes от DS содержит iReq, вследствие чего платеж Ошибка проведения платежа. Попробуйте позднее. Если
был отклонен. / VERes from DS contains iReq, which данная ошибка возникла повторно, обратитесь в Ваш банк
caused the payment rejection. для разъяснения причин. Телефон банка должен быть
указан на обратной стороне карты. /

Payment error. Try again later. If this error occures repeatedly,

please contact your bank for more details. You can find bank
telephone number on the back side of your bank card.

-2013 -2013 Исчерпаны попытки оплаты Исчерпаны попытки оплаты. / All payment attempts Ошибка проведения платежа. Попробуйте позднее. /
were used. Payment error. Please try again later.

-2012 -2012 Operation not supported Данная операция не поддерживается. / This operation Ошибка проведения платежа. Попробуйте позднее. /
is not supported. Payment error. Please try again later.
-2011 -2011 Declined. PaRes status is Банк-эмитент не смог провести авторизацию Ошибка проведения платежа. Попробуйте позднее. Если
unknown 3dsecure-карты / Issuing bank was not able to perform данная ошибка возникла повторно, обратитесь в Ваш банк
3dsecure card authorization. для разъяснения причин. Телефон банка должен быть
указан на обратной стороне карты. /

Payment error. Try again later. If this error occures repeatedly,

please contact your bank for more details. You can find bank
telephone number on the back side of your bank card.

-2010 -2010 Несовпадение XID Несовпадение XID. / Mismatching of XID. Ошибка проведения платежа. Попробуйте позднее. Если
данная ошибка возникла повторно, обратитесь в Ваш банк
для разъяснения причин. Телефон банка должен быть
указан на обратной стороне карты. /

Payment error. Try again later. If this error occures repeatedly,

please contact your bank for more details. You can find bank
telephone number on the back side of your bank card.

-2008 -2008 Неверный кошелёк Неверный кошелёк. / Wrong purse. Данный actionCode больше не используется.

-2007 2007 Decline. Payment time limit Истек срок, отведенный на ввод данных карты с Ошибка проведения платежа. Попробуйте позднее. /
момента регистрации платежа (таймаут по Payment error. Please try again later.
умолчанию - 20 минут; продолжительность сессии
может быть указана при регистрации заказа; если у
мерчанта установлена привилегия "Нестандартная
продолжительность сессии", то берётся период,
указнанный в настройках мерчанта). /

The period allotted for card details entering has expired

(by default timeout is 20 minutes; session duration may
be specified while order registering; if the merchant has
"Alternative session timeout" permission, then timeout
duration is specified in merchant settings).

-2006 2006 Decline. 3DSec decline Означает, что эмитент отклонил аутентификацию Ошибка проведения платежа. Попробуйте позднее. Если
(3DS авторизация не пройдена) / Means that issuing данная ошибка возникла повторно, обратитесь в Ваш банк
bank rejected authentication (3DS authorization has not для разъяснения причин. Телефон банка должен быть
been performed). указан на обратной стороне карты. /

Payment error. Try again later. If this error occures repeatedly,

please contact your bank for more details. You can find bank
telephone number on the back side of your bank card.

-2005 2005 Decline. 3DSec sign error Означает, что мы не смогли проверить подпись Ошибка проведения платежа. Попробуйте позднее. Если
эмитента, то есть PARes был читаемый, но подписан данная ошибка возникла повторно, обратитесь в Ваш банк
неверно. / Means that RBS could not check issuing для разъяснения причин. Телефон банка должен быть
bank sign, i.e. PARes was readable, but the sign was указан на обратной стороне карты. /
wrong.
Payment error. Try again later. If this error occures repeatedly,
please contact your bank for more details. You can find bank
telephone number on the back side of your bank card.

-2003 -2003 Блокировка по порту Блокировка по порту. / Blocking by port. Данный actionCode больше не используется.

-2002 2002 Decline. Payment over limit Транзакция отклонена по причине того, что размер Ошибка проведения платежа. Обратитесь к представителю
платежа превысил установленные лимиты. магазина для разъяснения причин. /
Примечание: имеется в виду либо лимиты
Банка-эквайера на дневной оборот Магазина, либо Payment error. Please contact representative of the merchant
лимиты Магазина на оборот по одной карте, либо for more details.
лимит Магазина по одной операции.
/
Transaction was rejected because payment amount
exceeded established limits. Note: it could be limit of day
withdrawal established by Bank-acquirer, or limit of
transaction by one card established by a merchant, or
limit for one transaction established by a merchant.

-2001 2001 Decline. IP blacklisted Транзакция отклонена по причине того, что IP-адрес Ошибка проведения платежа. Обратитесь к представителю
Клиента внесен в черный список. / Transaction is магазина для разъяснения причин. /
rejected since Client's IP-address is in the black list.
Payment error. Please contact representative of the merchant
for more details.

-2000 2000 Decline. PAN blacklisted Транзакция отклонена по причине того, что карта Ошибка проведения платежа. Обратитесь к представителю
внесена в черный список. / Transaction is rejected магазина для разъяснения причин. /
since card number in in the black list.
Payment error. Please contact representative of the merchant
for more details.

-102 -102 Платеж отменен платежным Платеж отменен платежным агентом. / The payment Ошибка проведения платежа. Попробуйте позднее. Если
агентом was cancelled by the payment agent. данная ошибка возникла повторно, обратитесь в Ваш банк
для разъяснения причин. Телефон банка должен быть
указан на обратной стороне карты. /

Payment error. Try again later. If this error occures repeatedly,

please contact your bank for more details. You can find bank
telephone number on the back side of your bank card.

-100 -100 no_payments_yet Не было попыток оплаты. / There were not payment При возникновении данного actionCode сообщение Клиенту
attempts. не отображается.
-1 -1 sv_unavailable Истекло время ожидания ответа от процессинговой Ошибка проведения платежа. Попробуйте позднее. /
системы. / The timer of waiting of processing response Payment error. Please try again later.
has expired.

0 0 Approved. Платеж успешно прошел. / Payment has been Операция успешна. / Successful transaction.
performed successfully.

1 1 Declined. Honor with id Для успешного завершения транзакции требуется Ошибка проведения платежа. Попробуйте позднее. Если
подтверждение личности. В случае данная ошибка возникла повторно, обратитесь в Ваш банк
интернет-транзакции (соот-но и в нашем) для разъяснения причин. Телефон банка должен быть
невозможно, поэтому считается как declined. / Proof of указан на обратной стороне карты. /
identity is necessary for successful completion of the
transaction. In case of internet transaction (our case) it is Payment error. Try again later. If this error occures repeatedly,
impossible, so transaction is considered as declined. please contact your bank for more details. You can find bank
telephone number on the back side of your bank card.

5 5 Decline. Unable to process Отказ сети проводить транзакцию. / Refuse of network Ошибка проведения платежа. Попробуйте позднее. Если
to process transaction. данная ошибка возникла повторно, обратитесь в Ваш банк
для разъяснения причин. Телефон банка должен быть
указан на обратной стороне карты. /

Payment error. Try again later. If this error occures repeatedly,

please contact your bank for more details. You can find bank
telephone number on the back side of your bank card.

15 15 DECLINED_BY_BADINSTIT МПС не смогла определить эмитента карты. / IPS Ошибка проведения платежа. Попробуйте позднее. Если
cannot identify the issuing bank. данная ошибка возникла повторно, обратитесь в Ваш банк
для разъяснения причин. Телефон банка должен быть
указан на обратной стороне карты. / Payment error. Try again
later. If this error occures repeatedly, please contact your bank
for more details. You can find bank telephone number on the
back side of your bank card.

53 53 DECLINED_BY_INVALID_ACCT Карты не существует в системах процессинга. / The Операция отклонена. Обратитесь в магазин. / Payment
card does not exist in processing systems. declined. Please, contact with merchant.

100 100 Decline. Card declined Ограничение по карте (Банк эмитент запретил Ошибка проведения платежа. Попробуйте позднее. Если
интернет транзакции по картe). / Card limits (Issuing данная ошибка возникла повторно, обратитесь в Ваш банк
bank forbade internet transactions by the card). для разъяснения причин. Телефон банка должен быть
указан на обратной стороне карты. /

Payment error. Try again later. If this error occures repeatedly,

please contact your bank for more details. You can find bank
telephone number on the back side of your bank card.

101 101 Decline. Expired card Истек срок действия карты. / Card is expired. Проверьте правильность ввода карточных данных. Если
данная ошибка возникла повторно, обратитесь в Ваш банк
для разъяснения причин. Телефон банка должен быть
указан на обратной стороне карты. /

Check your card balance and verify entered card details. If this
error occures repeatedly, please contact your bank for more
details. You can find bank telephone number on the back side
of your bank card.

103 103 Decline. Call issuer Нет связи с Банком-Эмитентом. Торговой точке Ошибка проведения платежа. Попробуйте позднее. Если
необходимо связаться с банком-эмитентом. / There is данная ошибка возникла повторно, обратитесь в Ваш банк
no connection with the Issuing bank. Sales oulet need to для разъяснения причин. Телефон банка должен быть
contact Issuing bank. указан на обратной стороне карты. /

Payment error. Try again later. If this error occures repeatedly,

please contact your bank for more details. You can find bank
telephone number on the back side of your bank card.

104 104 Decline. Card declined Попытка выполнения операции по счету, на Ошибка проведения платежа. Попробуйте позднее. Если
использование которого наложены ограничения. / данная ошибка возникла повторно, обратитесь в Ваш банк
This is an attempt to perform a transaction by an account для разъяснения причин. Телефон банка должен быть
that has restrictions for use. указан на обратной стороне карты. /

Payment error. Try again later. If this error occures repeatedly,

please contact your bank for more details. You can find bank
telephone number on the back side of your bank card.

106 106 Превышено допустимое число Превышено допустимое число попыток ввода ПИН. Ошибка проведения платежа. Попробуйте позднее. Если
попыток ввода ПИН. Вероятно Вероятно карта временно заблокирована. / The данная ошибка возникла повторно, обратитесь в Ваш банк
карта временно maximum number of attempts to enter PIN is exceeded. для разъяснения причин. Телефон банка должен быть
заблокирована. It is possible that the card is blocked temporary. указан на обратной стороне карты. /

Payment error. Try again later. If this error occures repeatedly,

please contact your bank for more details. You can find bank
telephone number on the back side of your bank card.

107 107 Decline. Call issuer Следует обратиться к Банку-Эмитенту. / Please, Ошибка проведения платежа. Попробуйте позднее. Если
contact Issuing bank. данная ошибка возникла повторно, обратитесь в Ваш банк
для разъяснения причин. Телефон банка должен быть
указан на обратной стороне карты. /

Payment error. Try again later. If this error occures repeatedly,

please contact your bank for more details. You can find bank
telephone number on the back side of your bank card.
109 109 Decline. Invalidnj merchant Неверно указан идентификатор мерчанта/терминала Ошибка проведения платежа. Попробуйте позднее. Если
или АСС заблокирован на уровне процессинга. данная ошибка возникла повторно, обратитесь к
/ представителю магазина для выяснения дальнейших
Merchant/terminal identifier is incorrect or ACC is действий. /
blocked on the processing level.
Payment error. Try again later. If this error occures repeatedly,
please contact representative of the merchant for more details.

110 110 Decline. Invalid amount Предпринята попытка выполнить транзакцию на Ошибка проведения платежа. Попробуйте позднее. Если
сумму, превышающую лимит, заданный данная ошибка возникла повторно, обратитесь к
банком-эмитентом. / Attempt to perform a transaction of представителю магазина для выяснения дальнейших
amount exceeding Issuing bank limit. действий. /

Payment error. Try again later. If this error occures repeatedly,

please contact representative of the merchant for more details.

111 111 Decline. No card record Неверный номер карты. / Card number is incorrect.йв Проверьте правильность ввода карточных данных. Если
данная ошибка возникла повторно, обратитесь в Ваш банк
для разъяснения причин. Телефон банка должен быть
указан на обратной стороне карты. /

Check your card balance and verify entered card details. If this
error occures repeatedly, please contact your bank for more
details. You can find bank telephone number on the back side
of your bank card.

116 116 Decline. Not enough money Сумма транзакции превышает доступный остаток Ошибка проведения платежа. Попробуйте позднее. Если
средств на выбранном счете. / Transaction amount данная ошибка возникла повторно, обратитесь в Ваш банк
exceeds the available balance of the selected account. для разъяснения причин. Телефон банка должен быть
указан на обратной стороне карты. /

Payment error. Try again later. If this error occures repeatedly,

please contact your bank for more details. You can find bank
telephone number on the back side of your bank card.

117 117 INCORRECT PIN Неверно указан пин код (не для интернет Ошибка проведения платежа. Попробуйте позднее. Если
транзакций). / Incorrect PIN (not for internet данная ошибка возникла повторно, обратитесь в Ваш банк
transactions). для разъяснения причин. Телефон банка должен быть
указан на обратной стороне карты. /

Payment error. Try again later. If this error occures repeatedly,

please contact your bank for more details. You can find bank
telephone number on the back side of your bank card.

118 118 Сервис не разрешен Сервис не разрешён (отказ от эмитента). / Service is Ошибка проведения платежа. Попробуйте позднее. Если
not allowed (rejection came from the issuer). данная ошибка возникла повторно, обратитесь в Ваш банк
для разъяснения причин. Телефон банка должен быть
указан на обратной стороне карты. /

Payment error. Try again later. If this error occures repeatedly,

please contact your bank for more details. You can find bank
telephone number on the back side of your bank card.

119 119 Decline. Транзакция незаконна. / Illegal transaction. Ошибка проведения платежа. Попробуйте позднее. Если
SECURITY_VIOLATION из SV данная ошибка возникла повторно, обратитесь в Ваш банк
для разъяснения причин. Телефон банка должен быть
указан на обратной стороне карты. /

Payment error. Try again later. If this error occures repeatedly,

please contact your bank for more details. You can find bank
telephone number on the back side of your bank card.

120 120 Decline. Not allowed Отказ в проведении операции - транзакция не Ошибка проведения платежа. Попробуйте позднее. Если
разрешена эмитентом. Код ответа платежной сети - данная ошибка возникла повторно, обратитесь в Ваш банк
57. Причины отказа необходимо уточнять у эмитента. для разъяснения причин. Телефон банка должен быть
указан на обратной стороне карты. /
/
Refusal to perform the operation - the transaction is not Payment error. Try again later. If this error occures repeatedly,
allowed by Issuing bank. Response code of the IPS - 57. please contact your bank for more details. You can find bank
Reasons for rejection should be specified an the issuing telephone number on the back side of your bank card.
bank.

121 121 Decline. Excds wdrwl limt Предпринята попытка выполнить транзакцию на Ошибка проведения платежа. Попробуйте позднее. Если
сумму, превышающую дневной лимит, заданный данная ошибка возникла повторно, обратитесь в Ваш банк
банком-эмитентом. / This is an attempt to perform для разъяснения причин. Телефон банка должен быть
transaction of amount exceeding the day limit указан на обратной стороне карты. /
established by the issuing bank.
Payment error. Try again later. If this error occures repeatedly,
please contact your bank for more details. You can find bank
telephone number on the back side of your bank card.

123 123 Decline. Excds wdrwl ltmt Превышен лимит на число транзакций: клиент Ошибка проведения платежа. Попробуйте позднее. Если
выполнил максимально разрешенное число данная ошибка возникла повторно, обратитесь в Ваш банк
транзакций в течение лимитного цикла и пытается для разъяснения причин. Телефон банка должен быть
провести еще одну. / The client has performed the указан на обратной стороне карты. /
maximum number of transactions during the limit cycle
and tries to perform another one. Payment error. Try again later. If this error occures repeatedly,
please contact your bank for more details. You can find bank
telephone number on the back side of your bank card.
125 125 Decline. Card declined Неверный номер карты. Подобная ошибка может Проверьте правильность ввода карточных данных. Если
означать ряд вещей: Попытка возврата на сумму, данная ошибка возникла повторно, обратитесь в Ваш банк
больше холда, попытка возврата нулевой для разъяснения причин. Телефон банка должен быть
суммы. Для AmEx - неверно указан срок действия указан на обратной стороне карты. /
карты. Check your card balance and verify entered card details. If this
/ error occures repeatedly, please contact your bank for more
Card number is incorrect. This error may have several details. You can find bank telephone number on the back side
meanings: Attempt to perform a refund of amount of your bank card.
exceeding the hold amount; Attempt to refund zero
amount; for AmEx - expiry date is specified incorrectly.

208 208 Decline. Card is lost Карта утеряна. / Card is lost. Ошибка проведения платежа. Попробуйте позднее. Если
данная ошибка возникла повторно, обратитесь в Ваш банк
для разъяснения причин. Телефон банка должен быть
указан на обратной стороне карты. /

Payment error. Try again later. If this error occures repeatedly,

please contact your bank for more details. You can find bank
telephone number on the back side of your bank card.

209 209 Decline. Card limitations Превышены ограничения по карте. / Card limitations Ошибка проведения платежа. Попробуйте позднее. Если
exceeded exceeded. данная ошибка возникла повторно, обратитесь в Ваш банк
для разъяснения причин. Телефон банка должен быть
указан на обратной стороне карты. /

Payment error. Try again later. If this error occures repeatedly,

please contact your bank for more details. You can find bank
telephone number on the back side of your bank card.

400 400 Реверсал обработан. Реверсал обработан. / Reversal is processed. Произведена отмена платежа. / Payment has been reversed.

902 902 Decline. Invalid trans Ограничение по карте (Владелец карты пытается Ошибка проведения платежа. Попробуйте позднее. Если
выполнить транзакцию, которая для него не данная ошибка возникла повторно, обратитесь в Ваш банк
разрешена). / Card limitations (Cardholder tries to для разъяснения причин. Телефон банка должен быть
perform a transaction that is forbidden for him). указан на обратной стороне карты. /

Payment error. Try again later. If this error occures repeatedly,

please contact your bank for more details. You can find bank
telephone number on the back side of your bank card.

903 903 Decline. Re-enter trans. Предпринята попытка выполнить транзакцию на Ошибка проведения платежа. Попробуйте позднее. Если
сумму, превышающую лимит, заданный данная ошибка возникла повторно, обратитесь в Ваш банк
банком-эмитентом. / Attempt to perform a transaction of для разъяснения причин. Телефон банка должен быть
amount exceeding Issuing bank limit. указан на обратной стороне карты. /

Payment error. Try again later. If this error occures repeatedly,

please contact your bank for more details. You can find bank
telephone number on the back side of your bank card.

904 904 Decline. Format error Ошибочный формат сообщения с точки зрения банка Ошибка проведения платежа. Попробуйте позднее. Если
эмитента. / The message format is incorrect in terms of данная ошибка возникла повторно, обратитесь в Ваш банк
the issuing bank. для разъяснения причин. Телефон банка должен быть
указан на обратной стороне карты. /

Payment error. Try again later. If this error occures repeatedly,

please contact your bank for more details. You can find bank
telephone number on the back side of your bank card.

907 907 Decline. Host not avail. Нет связи с Банком, выпустившим Вашу карту. Для Ошибка проведения платежа. Попробуйте позднее. Если
данного номера карты не разрешена авторизация в данная ошибка возникла повторно, обратитесь в Ваш банк
режиме stand-in (этот режим означает, что эмитент для разъяснения причин. Телефон банка должен быть
не может связаться с платежной сетью и поэтому указан на обратной стороне карты. /
транзакция возможна либо в оффлайне с
последующей выгрузкой в бэк офис, либо она будет Payment error. Try again later. If this error occures repeatedly,
отклонена). please contact your bank for more details. You can find bank
/ telephone number on the back side of your bank card.
There is no connection with the Issuing bank.
Authorization in stand-in mode is not allowed for this
card number (this mode means that the Issuing bank is
unable to connect to the IPS, and therefore the
transaction can be either offline with further unloading to
back office, or it can be declined).

909 909 Decline. Call issuer Невозможно провести операцию (Ошибка Ошибка проведения платежа. Попробуйте позднее. Если
функционирования системы, имеющая общий данная ошибка возникла повторно, обратитесь в Ваш банк
характер. Фиксируется платежной сетью или для разъяснения причин. Телефон банка должен быть
банком-эмитентом). / Operation is impossible (General указан на обратной стороне карты. /
error of the system functioning. May be detected by IPS
or the Issuing bank). Payment error. Try again later. If this error occures repeatedly,
please contact your bank for more details. You can find bank
telephone number on the back side of your bank card.

910 910 Decline. Host not avail. Банк-эмитент недоступен. / Issuing bank is not Ошибка проведения платежа. Попробуйте позднее. Если
available. данная ошибка возникла повторно, обратитесь в Ваш банк
для разъяснения причин. Телефон банка должен быть
указан на обратной стороне карты. /

Payment error. Try again later. If this error occures repeatedly,

please contact your bank for more details. You can find bank
telephone number on the back side of your bank card.
913 913 Decline. Invalid trans Неверный формат сообщения (Неправильный Ошибка проведения платежа. Попробуйте позднее. Если
формат транзакции с точки зрения сети). / The данная ошибка возникла повторно, обратитесь в Ваш банк
message format is incorrect in terms of IPS. для разъяснения причин. Телефон банка должен быть
указан на обратной стороне карты. /

Payment error. Try again later. If this error occures repeatedly,

please contact your bank for more details. You can find bank
telephone number on the back side of your bank card.

914 914 Decline. Orig trans not found Не найдена транзакция (когда посылается При возникновении данного actionCode сообщение Клиенту
завершение или reversal или refund). / Transaction is не отображается.
not found (when sending a completion, reversal or refund
request).

999 999 Declined by fraud Отсутствует начало авторизации транзакции. Ошибка проведения платежа. Попробуйте позднее. Если
Отклонено по фроду или ошибка 3dsec. / The данная ошибка возникла повторно, обратитесь к
beginning of the transaction authorization is missed. представителю магазина для выяснения дальнейших
Declined by fraud. действий. /

Payment error. Try again later. If this error occures repeatedly,

please contact representative of the merchant for more details.

1001 1001 Decline. Data input timeout Пусто (Выставляется в момент регистрации При возникновении данного actionCode сообщение Клиенту
транзакции, т.е. когда еще по транзакции не было не отображается.
введено данных карт). / Empty (is specified at the
moment of transaction authorization, when card details
are not entered yet).

1004 1004 Стадия авторизации 1 Стадия авторизации 1. / Authorization phase 1. При возникновении данного actionCode сообщение Клиенту
не отображается.

1005 1005 Стадия авторизации 2 Стадия авторизации 2. / Authorization phase 2. При возникновении данного actionCode сообщение Клиенту
не отображается.

2001 2001 Decline. Fraud Фродовая транзакция (по мнению процессинга или Ошибка проведения платежа. Попробуйте позднее. Если
платежной сети). / Fraud (in terms of IPS). данная ошибка возникла повторно, обратитесь к
представителю магазина для выяснения дальнейших
действий. /

Payment error. Try again later. If this error occures repeatedly,

please contact representative of the merchant for more details.

2002 2002 Неверная операция Неверная операция. / Incorrect operation. Ошибка проведения платежа. Попробуйте позднее. Если
данная ошибка возникла повторно, обратитесь к
представителю магазина для выяснения дальнейших
действий. /

Payment error. Try again later. If this error occures repeatedly,

please contact representative of the merchant for more details.

2003 2003 Decline. SSL restricted SSL (Не 3d-Secure/SecureCode) транзакции Ошибка проведения платежа. Попробуйте позднее. Если
запрещены Магазину. / SSL (not данная ошибка возникла повторно, обратитесь к
3D-Secure/SecureCode) transactions are forbidden for представителю магазина для выяснения дальнейших
the Merchant. действий. /

Payment error. Try again later. If this error occures repeatedly,

please contact representative of the merchant for more details.

2004 2004 SSL without CVC forbidden Оплата через SSL без ввода CVС2 запрещена. / Ошибка проведения платежа. Попробуйте позднее. Если
Payment through SSL without CVC2 is forbidden. данная ошибка возникла повторно, обратитесь к
представителю магазина для выяснения дальнейших
действий. /

Payment error. Try again later. If this error occures repeatedly,

please contact representative of the merchant for more details.

2005 2005 3DS rule failed Платеж не соотвествует условиям правила проверки Ошибка проведения платежа. Попробуйте позднее. Если
по 3ds. / Payment does not meet terms of the rule of 3ds данная ошибка возникла повторно, обратитесь к
validation. представителю магазина для выяснения дальнейших
действий. /

Payment error. Try again later. If this error occures repeatedly,

please contact representative of the merchant for more details.

2006 2006 Однофазные платежи Однофазные платежи запрещены. / One-phase Ошибка проведения платежа. Попробуйте позднее. Если
запрещены payments are forbidden. данная ошибка возникла повторно, обратитесь к
представителю магазина для выяснения дальнейших
действий. /

Payment error. Try again later. If this error occures repeatedly,

please contact representative of the merchant for more details.

2007 2007 Заказ уже оплачен Заказ уже оплачен. / The order is payed. Заказ уже оплачен. / The order has already been paid.

2008 2008 Транзакция ещё не завершена Транзакция ещё не завершена. / The transaction is not При возникновении данного actionCode сообщение Клиенту
completed. не отображается.

2009 2009 Сумма возврата превышает Сумма возврата превышает сумму оплаты. / Refund Сумма возврата превышает сумму оплаты. / The refund
сумму оплаты amount exceeds deposited amount. amount exceeds the amount deposited.
2014 2014 Ошибка выполнения Ошибка выполнения 3DS-правила / Error of 3DS rule Ошибка проведения платежа. Попробуйте позднее. Если
3DS-правила execution. данная ошибка возникла повторно, обратитесь к
представителю магазина для выяснения дальнейших
действий. /

Payment error. Try again later. If this error occures repeatedly,

please contact representative of the merchant for more details.

2015 2015 Terminal select rule error Ошибка выполнения правила выбора терминала Ошибка проведения платежа. Обратитесь к представителю
(правило некорректно). / Terminal select rule error (rule магазина для выяснения дальнейших действий. /
is incorrect).
Payment error. Please contact representative of the merchant
for more details.

2016 2016 TDS_FORBIDDEN Мерчант не имеет разрешения на 3-D Secure, Ошибка проведения платежа. Обратитесь к представителю
необходимое для проведения платежа. / 3-D Secure магазина для выяснения дальнейших действий. /
payment is necessary, but the merchant does not have
permission for 3-D Secure payment. Payment error. Please contact representative of the merchant
for more details.

9001 9001 RBS internal error Внутренний код отказа РБС. / RBS internal error. Ошибка проведения платежа. Попробуйте позднее. /
Payment error. Please try again later.

71015 1015 Decline. Input error Введены неправильные параметры карты. / Entered Проверьте правильность ввода карточных данных. Если
card details are incorrect. данная ошибка возникла повторно, обратитесь в Ваш банк
для разъяснения причин. Телефон банка должен быть
указан на обратной стороне карты. /
Check your card balance and verify entered card details. If this
error occures repeatedly, please contact your bank for more
details. You can find bank telephone number on the back side
of your bank card.

151017 1017 Decline. 3DSec comm error 3-D Secure - ошибка связи. / 3-D Secure - Ошибка проведения платежа. Попробуйте позднее. Если
communication error. данная ошибка возникла повторно, обратитесь к
представителю магазина для выяснения дальнейших
действий. /

Payment error. Try again later. If this error occures repeatedly,

please contact representative of the merchant for more details.

151018 018 Decline. Processing timeout Таймаут в процессинге. Не удалось отправить. / Ошибка проведения платежа. Попробуйте позднее. Если
Processing timeout. Sending is failed. данная ошибка возникла повторно, обратитесь к
представителю магазина для выяснения дальнейших
действий. /

Payment error. Try again later. If this error occures repeatedly,

please contact representative of the merchant for more details.

151019 1019 Decline. Processing timeout Таймаут в процессинге. Удалось отправить, но не Ошибка проведения платежа. Попробуйте позднее. Если
получен ответ от банка. / Processing timeout. Sending данная ошибка возникла повторно, обратитесь к
is success, response from the bank was not received. представителю магазина для выяснения дальнейших
действий. /

Payment error. Try again later. If this error occures repeatedly,

please contact representative of the merchant for more details.

341014 1014 Decline. General Error Код отказа РБС. / RBS general error. Ошибка проведения платежа. Попробуйте позднее. Если
данная ошибка возникла повторно, обратитесь к
представителю магазина для выяснения дальнейших
действий. /

Payment error. Try again later. If this error occures repeatedly,

please contact representative of the merchant for more details.