Инструменты страницы
Request for making payment by binding
The request used for making a payment by binding is ''paymentOrderBinding«.
In this document, the following data type conventions are used when describing request and response parameters:
- A<n> – a sequence of Latin letters of length <n>;
- A..<n> – a sequence of Latin letters with a length not exceeding <n>;
- N<n> – a sequence of digits of length <n>;
- N..<n> – a sequence of digits with a length not exceeding <n>;
- AN<n> – a sequence of Latin letters and numbers of fixed length <n>;
- AN.. <n> – a sequence of Latin letters and numbers with a length not exceeding <n>;
- ANS<n> – a sequence of Latin letters, numbers and characters of fixed length <n>
- ANS.. <n> – a sequence of Latin letters, numbers and characters with a length not exceeding <n>;
- UTC – date and time, in this case: the date must be passed without specifying the time zone, Moscow time, for the SOAP protocol, the standard encoding xs: dateTime is used.
Request parameters:
Name | Type | Mandatory | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ANS..36 | Yes |
Order number in the payment gateway. Unique within the payment gateway. |
|||||||||
|
AN..255 | Yes |
Identifier of the binding created earlier. |
|||||||||
|
See column with the description. | No |
Additional tag with the attributes for passing additional parameters.
The fields for additional information and its subsequent storage. These fields can be submitted for processing by the bank for further display in the registers. By default, the order number
Enabling the functionality is possible upon agreement with the Bank during the integration period. To pass N parameters, a request must contain N
It is forbidden to pass reserved names in the parameter (if they are passed, the order may be rejected):
|
|||||||||
|
A2 | No |
Language in the ISO 639-1 encoding. If the language is not specified, the default language defined in the store settings is used. |
|||||||||
|
ANS..39 | Yes |
IP-address of the buyer. IPv6 is supported in all requests (up to 39 characters). |
|||||||||
|
N3 | No |
This parameter is mandatory, if Can process payments without confirmation of CVC is not selected for a Merchant. |
|||||||||
|
ANS..40 | No |
Customer's email address. |
|||||||||
|
See description | No |
Customer's registration data (street address, postal code). Required for AVS/AVV checks. Mandatory if «AVS/AVV use allowed» permission is enabled for merchant |
billingPayerData
billingPayerData block parameters
Name | Type | Mandatory | Description |
---|---|---|---|
|
AN..50 | No |
City registered for the card at the Issuer Bank. |
|
AN..50 | No |
|
|
AN..50 | No |
Address registered for the card at the Issuer Bank. Line 1. Mandatory if «AVS/AVV use allowed» permission is enabled for merchant. |
|
AN..50 | No |
Address registered for the card at the Issuer Bank. Line 2. |
|
AN..50 | No |
Address registered for the card at the Issuer Bank. Line 3. |
|
AN..50 | No |
Postal code registered for the card at the Issuer Bank. Mandatory if «AVS/AVV use allowed» permission is enabled for merchant. |
|
AN..50 | No |
State registered for the card at the Issuer Bank (ISO 3166-2). |
* By default, the orderNumber and description fields are passed to the bank's processing system (no more than 24 characters, %, +, carriage return \r and line feed \n cannot be used)
Response parameters:
Name | Type | Mandatory | Description |
---|---|---|---|
|
ANS..* | No |
The parameter is returned upon a successful response in the case of a payment in which there was no verification of the card's belonging to 3-D Secure. The URL to redirect to after payment. |
|
ANS..* | No |
On a successful response. Result of a payment attempt. The available values are presented below.
|
|
ANS..3 | Yes |
Error code. |
|
|
No |
|
|
AN..512 | No |
Redirect address to the address of the ACS server. |
|
AN..512 | No |
Request for the payer authentication. |
Error codes (errorCode field):
Value | Description |
---|---|
0 | The request has been processed without system errors. |
1 | It is necessary to specify CVC2/CVV2 because the merchant does not have a permission to process payments without CVC. |
1 | Incorrect format of CVC. |
1 | Incorrect language. |
1 | [mdOrder] is empty |
1 | [bindingId] is empty |
1 | The email address does not meet the template format |
2 | The binding is not found. |
2 | Order not found. |
5 | Access denied. |
5 | The user must change the password. |
5 | All payment attempts were used. |
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 payment has been processed, redirecting is taking place..." redirect="http://example.ru?orderId=9213bc5f-5d5b-43d6-a408-b6b93cdde992"/"/> </ns1:paymentOrderBindingResponse> </soap:Body> </soap:Envelope>