Request for order registration with pre-authorization, shopping cart (registerOrderPreAuth)

The request used for pre-authorizing an order in Payment Gateway is registerOrderPreAuth.

Use the following URL to connect to the Test Service (WSDL):
https://3dsec.sberbank.ru/payment/webservices/merchant-ws?wsdl.

Requests for registration of an order (with- and without pre-authorization) pass the cart data in the orderBundle parameter.

  • Prices of all the items within the cart must be specified in one currency (if the currency of an item is to be specified); and this currency must match the currency of the order.
  • The sum of all line items in the shopping cart must be equal to the order amount.
  • A passed value of the quantity parameter is to be checked for each line item. If the value is too large or too small, the request will result in an error.
  • All the parameters of the cart are to be checked for meeting the required format (length).

If at least one of the above conditions is not met, the order is considered incorrectly generated and the payment gateway returns an error.

Request parameters

If the cart and fiscalization data are not passed in the request, the default values specified in the personal account are passed to the Fiscal Data Operator (see setting up fiscalization data for more details).

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.

The request parameters are given in table below.

Name Type Mandatory Description FFD version

merchantOrderNumber

ANS..32

Yes

Order identifier in the Store system.

All versions.

description

ANS..512

No

Description of the order in any format. Only the first 24 characters of this field are transferred to Sberbank's processing for inclusion in the merchant's financial statements.

To enable sending this field to the processing system, contact the technical support service.

All versions.

amount

N..12

Yes

Payment amount in minimum currency units (kopecks, cents, etc.). Must match the total amount for all line items in the shopping cart.

Before summing up all line items, the product of quantity and price for each good item is rounded to an integer. If the value is followed by 5 or greater after the decimal point, it is rounded up. Below there are examples of rounding.

  1. If quantity = 0.111, and price = 5500, then the result is 611 (610.5 rounded up).
  2. If quantity = 1.455, and price = 6900, then the result is 10040 (10039.5 rounded up).
  3. If quantity = 1.211, and price = 6988, then the result is 8462 (8462.468 rounded down).

Therefore, the «amount» parameter value must be equal to the sum of the line items rounded.

All versions.

currency

N3

No

ISO 4217 code of the payment currency. If not specified, default value is used.

All versions.

language

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.

All versions.

pageView

ANS..20

No

The value of this parameter defines what kind of pages of the payment interface will be loaded for the Customer. The available values are:

  • DESKTOP – pages designed to be displayed on desktop computers (pages with names like payment_<locale>.html and errors_<locale>.html will be searched for in the payment service archive);
  • MOBILE – pages designed to be displayed on mobile devices (pages with names like mobile_payment_<locale>.html and mobile_errors_<locale>.html will be searched for in the payment service archive);
  • If a store has created payment interface pages with arbitrary prefixes added to the names of page files, pas the value of the necessary prefix in the pageView parameter to load corresponding pages. For example on passing the iphone value, a search will be carried out in the archive of payment interface pages for pages with the iphone_payment_<locale>.html and iphone_error_<locale>.html names.

Where:

  • locale – the language of the page in ISO 639-1. For example, ru for Russian or en for English.

If the parameter is missing or its value is in incorrect format, the default value is pageView=DESKTOP.

All versions.

sessionTimeoutSecs

N..9

No

Order lifetime in seconds.

If the parameter is not specified, the value specified in the Merchant settings or the default value (1200 seconds = 20 minutes) will be used.

If the request contains the expirationDate parameter, then the value of sessionTimeoutSecs parameter is disregarded.

All versions.

bindingId

AN..255

No

The identifier of the previously created binding. Can only be used if the merchant has permission to work with bindings. If this parameter is passed in the given request, it means that:
1. The given order can be paid only using a binding;
2. The payer will be redirected to the payment page on which only entering CVC is required.

All versions.

expirationDate

ANS

No

The date and time of the order lifetime expiration. Format: yyyy-MM-ddTHH:mm:ss.

If this parameter is not passed in the request, sessionTimeoutSecs parameter is used to determine the end of lifetime of the order.

All versions.

returnUrl

ANS..512

Yes

The URL to which the user is to be redirected in case of a successful payment (and also in case of a failed payment where the failUrl parameter is not passed). The address must be specified in full including the protocol used (for example, https://test.ru instead of test.ru). Otherwise, the user will be redirected to the address of the following type: http://<payment_gateway_address>/<merchant_address>.

All versions.

failUrl

ANS..512

No

The address to which the user is to be redirected in case of a failed payment. The address must be specified in full including the protocol used (for example, https://test.ru instead of test.ru). Otherwise, the user will be redirected to the address of the following type: http://<payment_gateway_address>/<merchant_address>.

The parameter is optional. In this case, an unsuccessful payment will lead to a redirect to returnUrl, in the same way it happens when the payment is successful.

All versions.

params

See column with the description.

No

Tag containing attributes to pass additional parameters of the Merchant. The fields for additional information and its subsequent storage. To pass N parameters, a request must contain N params tags, where the name attribute contains the name of a parameter and the value attribute contain its value:

Name Type Description
Name

name

Type

AN..20

Type2

ANS..255

Type3

A7

Type4

ANS..100

Description
REST

Name of the additional parameter.

REST Online Lending

The attribute name, always takes the value of mdOrder.

WS

Name of the additional parameter.

Spasibo

Name or the description of an item in any format.

Spasibo2

Name of the parameter describing the details of a line item

ANS..255

Name of the additional parameter.

value

AN..1024

The value of the additional parameter is up to 1024 characters.

These fields can be passed to the Bank processing system to be subsequently displayed in the registries.* Enabling the functionality is possible upon agreement with the Bank during the integration period. If sending notifications to Customers is set up for a Merchant, the email address of a Customer must be passed in this tag in the email parameter. The following can be passed as additional parameters:

  • email – if the customer's email address is passed, it will be displayed on the payment page;
  • phone – if the customer's cell phone number is passed, it will be displayed on the payment page;
  • backToShopUrl – if this parameter is passed, the payment page will display a button for returning the customer to the store. Specify the address of the store's website in this parameter.
  • backToShopName – the caption on the return-to-store button that will be displayed if the parameter backToShopUrl is passed.

It is forbidden to pass reserved names in the parameter (if they are passed, the order may be rejected):

  • sbrf_spasibo:amount_bonus
  • sbrf_sbermiles:amount_bonus
  • loyaltyId

All versions.

clientId

ANS..255

No

Identifier of the Customer in the Store system. This parameter is used for the binding functionality. May be present if the store is allowed to create bindings.

Specifying this parameter when processing payments with the use of bindings is mandatory. Otherwise, a payment will be unsuccessful.

All versions.

merchantLogin

AN..255

No

To register an order on behalf of a child Merchant, specify the Merchant login in this parameter.

All versions.

additionalOfdParams

Data block for transferring additional parameters of the OFD

Yes

Some parameters of additionalOfdParams block duplicate parameters of cartItems.items.itemAttributes block. The additionalOfdParams block is included for all line items of the order, whereas cartItems.items.itemAttributes applies to individual items. If the additionalOfdParams and cartItems.items.itemAttributes and additionalOfdParams blocks pass different values, then the priority value will be the one that was passed in cartItems.items.itemAttributes, that is, for an individual position.

The transfer of this block is possible only when using the following OFDs:

  • ATOL;
  • Business.Ru;
  • Evotor.

(Go to description.)

orderBundle

Not applicable

Yes

Block containg the cart of items of the order. The description of the attributes is given below.

(Go to description.)

All versions.

taxSystem

N..2

No

Tax system. The following values are available:

  • 0 – general;
  • 1 – simplified, with only revenue taken into account;
  • 2 – simplified, the revenue minus the expenditure;
  • 3 – uniform tax on imputed income;
  • 4 – unified agricultural tax;
  • 5 – patent tax system.

If the cart and fiscalization data are not included in the request, then the default values specified in the personal account are passed to the Fiscal Data Operator (see User Manual for personal account).

All versions.

autocompletionDate

ANS..19

No

Date and time of the two-phase payment autocompletion in the following format.

2017-12-29T13:02:51

To enable this functionality, please contact technical support.

All versions.

billingPayerData

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

All versions.

By default, the following fields are passed to the Bank processing system:

  • orderNumber – order number in the store system;
  • description – order description (no more than 24 characters; %, +, carriage return \r, and line feed \n cannot be used).

billingPayerData



billingPayerData block parameters

Name Type Mandatory Description

billingCity

AN..50

No

City registered for the card at the Issuer Bank.

billingCountry

AN..50

No

billingAddressLine1

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.

billingAddressLine2

AN..50

No

Address registered for the card at the Issuer Bank.

Line 2.

billingAddressLine3

AN..50

No

Address registered for the card at the Issuer Bank.

Line 3.

billingPostalCode

AN..50

No

Postal code registered for the card at the Issuer Bank.

Mandatory if «AVS/AVV use allowed» permission is enabled for merchant.

billingState

AN..50

No

State registered for the card at the Issuer Bank (ISO 3166-2).

orderBundle

orderBundle contains the following elements.

A parameter included in a block and indicated as mandatory is only mandatory within that block. If the section is optional and missing, then the parameters included in it should not be passed.

Name Type Mandatory Description FFD version

orderCreationDate

ANS..21

No

Order creation date in the format YYYY-MM-DDTHH:MM:SS.

All versions.

customerDetails

Not applicable

No

Block containing attributes with data about the customer. The description of the attributes is given below.

(Go to description.)

All versions.

cartItems

Not applicable

Yes

Block with the attributes of the items in the cart. The description of the attributes is given below.

(Go to description.)

All versions.

customerDetails

customerDetails contains the following elements.

A parameter included in a block and indicated as mandatory is only mandatory within that block. If the section is optional and missing, then the parameters included in it should not be passed.

Name Type Mandatory Description FFD version

email

ANS..40

See note below.

Customer's email address. You can specify several comma separated (without spaces) email addresses – in this case the receipt will be delivered to all specified addresses.

All versions.

phone

NS..12

See note below.

Customer's phone number. It can be of the following format: ^((+7|7|8)?([0-9]){10})$. Examples:

  • +79000000000
  • 89000000000
  • 9000000000
  • 79000000000

If the number is passed in a separate parameter and in additional parameters, the number specified in this phone parameter will be used.

When using ATOL fiscalization, the phone parameter should be sent in the following format:

The phone number must be passed together with the country code without spaces and additional characters except for the quotation marks (the number «371 2 1234567» must be passed as «+37121234567»). If the phone number belongs to Russia (prefix «+7»), then the value can be passed without a prefix (the number «+79251234567» can be sent as «9251234567»). The maximum string length is 64 characters. One of the fields must be filled in the request: email or phone.

All versions.

contact

ANS..40

No

Customer's preferred way of communication.

All versions.

deliveryInfo

Not applicable

No

Block containing the attributes of the delivery address. The description of the attributes is given below.

(Go to description.)

All versions.

fullName

ANS..100

No

Payer's first name, last name, and patronymic.

1.05 and later versions.

passport

ANS..100

No

The series and number of the payer's passport in the following format: 2222888888.

1.05 and later versions.

inn

N..12

No

Taxpayer identification number. From 10 to 12 digits can be passed.

1.05 and later versions.

It is mandatory to pass one of the two parameters: email or phone.

deliveryInfo

deliveryInfo contains the following elements.

Name Type Mandatory Description FFD version

deliveryType

ANS..20

No

Delivery method.

All versions.

country

A..2

Yes

The two-letter country code for the delivery country.

All versions.

city

ANS..40

Yes

Delivery city.

All versions.

postAddress

ANS..255

Yes

Delivery address.

All versions.

A parameter included in a block and indicated as mandatory is only mandatory within that block. If the section is optional and missing, then the parameters included in it should not be passed.

cartItems

cartItems contains the following elements.

A parameter included in a block and indicated as mandatory is only mandatory within that block. If the section is optional and missing, then the parameters included in it should not be passed.

Name Type Mandatory Description FFD version

items

Not applicable

Yes

Tag containing the parameters with the data about one item from the cart .

Item number is specified as an attribute of the tag: positionId – Unique identifier of a product item inside the order cart.

A request must contain a separate items tag for each line item. The description of the tag parameters is given below.

(Go to description.)

All versions.

items

items« contains the following elements.

A parameter included in a block and indicated as mandatory is only mandatory within that block. If the section is optional and missing, then the parameters included in it should not be passed.

Name Type Mandatory Description FFD version

positionId

ANS..12

Yes

Unique identifier of a line item within the order cart.

All versions.

Name

name

Type

ANS..100

Description

REST

Name or the description of an item in any format.

Use
- to pass \ use \«- to pass »

REST Online Lending

For Online Lending functionality, it's necessary to specify a description of the line item in accordance with the Yandex.Market catalog, subject to the following requirements:

  • The following words and character sequences are not allowed: file, exec, insert, as, select, or, procedure, limit, order, and, or, by, asc, desc, delete, update, distinct, having, truncate, replace, handler, like, regex, tz_offset, to_timestamp_tz, bfilename, union, sql-command, abort, alter, analyze, begin, audit, checkpoint, close, cluster, comment, commit, copy, create, deallocate, declare, delete, drop, end, execute, explain, fetch, grant, insert, lock, move, noaudit, notify, prepare, reindex, rename, reset, revoke, rollback, savepoint, select, set, show, shutdown, start, truncate, unlisten, update, vacuum
  • The following special characters are not allowed: ' & – # % | ; =
WS

Name or the description of an item in any format.

Use
- to pass \ use \«- to pass »

WS Online Lending

For online crediting functionality it's necessary to specify a description of the good item in accordance with the Yandex.Market.

ANS..100

Yes

Name or the description of an item in any format.

Use
- to pass \ use \«- to pass »

All versions.

itemDetails

Not applicable

No

Additional block containing the parameters describing a line item. The description of the attributes is given below.

The field size limit is 1024 bytes.

(Go to description.)

All versions.

quantity

N..18

Yes

Element describing the total of items of one positionId and its unit of measurement The description of the attributes is given below.

(Go to description.)

All versions.

itemAmount

N..18

No

The sum of the cost of all line items of one positionId in minimum currency units. Passing itemAmount is mandatory only if the itemPrice parameter was not passed. Otherwise passing of itemAmount is not required. If both parameters – itemPrice and itemAmount – are passed. then itemAmount must be equal to itemPrice * quantity, otherwise, the request will result in an error.

When calculating itemAmount = itemPrice*quantity parameter, the result is rounded up to the second digit after the decimal point. For example, if the calculation result is 100.255, then final value will be 100.26.

All versions.

itemCurrency

N3

No

Currency code of a line item according to ISO 4217. If the parameter is not specified, it is considered to be equal to the order currency.

All versions.

itemCode

ANS..100

Yes

Number (identifier) of a line item in the store system.

All versions.

tax

Not applicable

Only for stores with enabled fiscalization settings

An additional tag with attributes describing the tax. Nested tags are described below.

(Go to description.)

All versions.

itemPrice

N..18

Only for stores with enabled fiscalization settings

The price of one line item of one positionId specified in minimum currency units. Mandatory for merchants using fiscalization.

  • itemPrice cannot be less than 0.
  • itemPrice may be either string or integer.

All versions.

itemAttributes

See description.

Only for stores with enabled fiscalization settings

Tag that serves to pass a set of attributes of the line item. Attributes must be specified as follows. 

<attributes  name="attribute_name_1">attribute_value_1</attributes>
<attributes  name="attribute_name_2">attribute_value_2</attributes>

See description below.

1.05 and later versions.

==== itemAttributes ====

Name Type Mandatory Description FFD version

paymentMethod

N..2

Yes

Payment type. Possible values:

  • 1 – full pre-payment before the delivery date of the payment subject;
  • 2 – partial pre-payment before the delivery date of the payment subject;
  • 3 – advance payment;
  • 4 – full payment on the delivery date of the payment subject;
  • 5 – partial payment for the payment subject on the delivery date followed by payment on credit;
  • 6 – delivery of the payment subject on the delivery date without payment followed by payment on credit;
  • 7 – payment for the payment subject after its delivery using payment on credit.

Values are passed in the following priority (indicated in descending order of priority):

  1. Shopping cart from API request.
  2. Fiscalization settings in your personal account.
  3. Default values.

For paymentMethod, the default value is 1 (full prepayment before the transfer of the payment item).

1.05 and later versions.

paymentObject

N..2

Yes

Type of item being paid for. Possible values:

  • 1 – product;
  • 2 – excisable product;
  • 3 – work;
  • 4 – service;
  • 5 – gambling bet;
  • 6 – gambling winnings;
  • 7 – lottery ticket;
  • 8 – lottery winnings;
  • 9 – intellectual property;
  • 10 – payment;
  • 11 – agent's fee;
  • 12 – several subjects;
  • 13 – other payment subject.
  • * 14 – property rights;
  • 15 – non-operating income;
  • 16 – insurance premiums: on the amount of expenses that reduce the amount of tax (advance payments) in accordance with paragraph 3.1 of Article 346.21 of the Tax Code of the Russian Federation;
  • 17 – sales tax;
  • 18 – resort tax.

Values are passed in the following priority (indicated in descending order of priority):

  1. Shopping cart from API request.
  2. Fiscalization settings in your personal account.
  3. Default values.

The default value for paymentObject is 1 (item).

1.05 and later versions.

nomenclature

ANS

yes (if markQuantity is passed)

Trade item code in text representation. Maximum length – 32 bytes.

1.05 and later versions.

markQuantity

(Go to description.)

No

Fractional quantity of the labeled item.

1.2 and later versions.

userData

ANS..64

No

Value of user details. May be transferred only after approval by Federal Tax Service.

1.05 and later versions.

agent_info.type

N..2

Mandatory if agent_info object is passed.

Agent type. The following values are available:

  • 1 – banking payment agent;
  • 2 – banking payment subagent;
  • 3 – payment agent;
  • 4 – payment subagent;
  • 5 – attorney;
  • 6 – commission agent;
  • 7 – other agent.

1.05 and later versions.

agent_info.paying.operation

ANS..24

No

Name of the transaction of the paying agent.

1.05 and later versions.

agent_info.paying.phones

array ANS..19

No

Phone numbers array of the payments agent in +N format.

1.05 and later versions.

agent_info.paymentsOperator.phones

Array ANS..19

No

Phone numbers array of the payments operator in +N format.

1.05 and later versions.

agent_info.MTOperator.phones

array ANS..19

No

An array of Money Transfer operator phone numbers in +N format.

1.05 and later versions.

agent_info.MTOperator.name

ANS..64

No

Money Transfer operator name.

1.05 and later versions.

agent_info.MTOperator.address

ANS..256

No

Money Transfer operator address.

1.05 and later versions.

agent_info.MTOperator.inn

N10..12

No

Money Transfer operator TIN.

1.05 and later versions.

supplier_info.phones

Array ANS..19

No

An array of supplier phone numbers in +N format.

1.05 and later versions.

supplier_info.name

ANS..256

No

Supplier name.

1.05 and later versions.

supplier_info.inn

N10..12

No

Supplier TIN.

1.05 and later versions.

==== quantity ==== quantity contains the following elements.

Name Type Mandatory Description FFD version

measure

ANS..20

Yes

The unit of measurement for the quantity of line item instances.

All versions.

If the FFD is version 1.2 or later, then the following parameters are passed here:

Name Type Mandatory Description FFD version

value

N1

Yes

Quantity of line items in given positionId. For FFD version 1.2+, the value is always 1.

1.2 and later versions.

measure

N..3

Yes

Unit of measurement for the quantity of the payment subject. In case of FFD version 1.2+, if the 'nomenclature' and 'markQuantity' parameters are passed, the value is always 0. In other cases, it can have some value.

1.2 and later versions.

Possible values of measure

Value Description
0 Used for payment subjects that can be sold individually or in units (as well as in the event that the payment subject is a product subject to mandatory labeling with an identification tool (which can be known from mark_code being passed))
10 Gram
11 Kilogram
12 Ton
20 Centimeter
21 Decimeter
22 Meter
30 Square centimeter
31 Square decimeter
32 Square meter
40 Milliliter
41 Liter
42 Cubic meter
50 Kilowatt hour
51 Gigacalorie
70 Day (24h)
71 Hour
72 Minute
73 Second
80 Kilobyte
81 Megabyte
82 Gigabyte
83 Terabyte
255 Applicable when using other units of measurement

==== markQuantity ====

Parameters of markQuantity tag:

A parameter included in a tag and indicated as mandatory is only mandatory within that tag. If the tag itself is not mandatory and is not passed, its included parameters should not be passed.

Name Type Mandatory Description

numerator

N..12

yes

The numerator of the fractional part of the payment subject.

denominator

N..12

yes

The denominator of the fractional part of the payment subject.

==== itemDetails ==== 'itemDetails contains the following elements.

A parameter included in a block and indicated as mandatory is only mandatory within that block. If the section is optional and missing, then the parameters included in it should not be passed.

Name Type Mandatory Description FFD version

itemDetailsParams

ANS..255

Yes

Parameter describing additional information regarding a line item. The description of the attributes is given below.

(Go to description.)

All versions.

itemDetailsParams

'itemDetailsParams contains the following elements.

Name Type Mandatory Description FFD version

Name

name

Type

AN..255

Type2

ANS..255

Description

REST

Name of the parameter describing the details of a line item

WS

Name of the parameter describing the details of a line item

AN..255

Conditional. Mandatory if itemDetailsParams parameter is present.

Name of the parameter describing the details of a line item

All versions.

==== tax ==== tax contains the following elements.

A parameter included in a block and indicated as mandatory is only mandatory within that block. If the section is optional and missing, then the parameters included in it should not be passed.

Name Type Mandatory Description FFD version

taxType

N..2

No

VAT rate. The following values are available:

  • 0 – without VAT;
  • 1 – VAT at rate of 0%;
  • 2 – receipt VAT at rate of 10%;
  • 4 – receipt VAT at calculated rate of 10/110;
  • 6 – receipt VAT at rate of 20%;
  • 7 – receipt VAT at calculated rate of 20/120.

If the cart and fiscalization data are not included in the request, then the default values specified in the personal account are passed to the Fiscal Data Operator (see User Manual for personal account).

All versions.

taxSum

N..18

No

Amount of the tax calculated by the merchant. The amount is specified in minimum currency units

All versions.

==== additionalOfdParams ==== additionalOfdParams contains the following elements.

Name Type Mandatory Description FFD version

agent_info.type

N..2

Mandatory if agent_info object is passed.

Agent type. The following values are available:

  • 1 – banking payment agent;
  • 2 – banking payment subagent;
  • 3 – payment agent;
  • 4 – payment subagent;
  • 5 – attorney;
  • 6 – commission agent;
  • 7 – other agent.

1.05 and later versions.

agent_info.paying.operation

ANS..24

No

Name of the transaction of the paying agent.

1.05 and later versions.

agent_info.paying.phones

array ANS..19

No

Phone numbers array of the payments agent in +N format.

1.05 and later versions.

agent_info.paymentsOperator.phones

Array ANS..19

No

Phone numbers array of the payments operator in +N format.

1.05 and later versions.

agent_info.MTOperator.address

ANS..256

No

Money Transfer operator address.

1.05 and later versions.

agent_info.MTOperator.inn

N10..12

No

Money Transfer operator TIN.

1.05 and later versions.

agent_info.MTOperator.name

ANS..64

No

Money Transfer operator name.

1.05 and later versions.

agent_info.MTOperator.phones

array ANS..19

No

An array of Money Transfer operator phone numbers in +N format.

1.05 and later versions.

supplier_info.phones

Array ANS..19

No

An array of supplier phone numbers in +N format.

1.05 and later versions.

cashier

A..256

No

Cashier full name

1.05 and later versions.

additional_check_props

ANS..16

No

Additional property of the receipt.

1.05 and later versions.

additional_user_props.name

ANS..24

No

Name of the additional property of the user.

1.05 and later versions.

additional_user_props.value

ANS..24

No

Value of the additional property of the user.

1.05 and later versions.

cashier_inn

N..12

No

Cashier's INN

1.2 and later versions.

client.address

ANS..256

No

Customer address.

1.2 and later versions.

client.birth_date

NS10

No

Customer birth date as dd.mm.yyyy

1.2 and later versions.

client.citizenship

N3

No

Country numeric code of the county of Customer's citizenship. The country code is specified according to All-Russian World Countries Classifier (OKSM)

1.2 and later versions.

client.document_code

N2

No

Identification document type numeric code (for example, 21 stands for Russian Passport).

1.2 and later versions.

client.passport_number

NS11

No

Series and number of the payer's passport: 1111 222222

1.2 and later versions.

client.email

ANS..64

No

Customer's email address. Exactly one of the two fields must be passed: email or phone.

1.2 and later versions.

client.phone

NS..19

No

Customer's phone number. Must be passed with the country code without spaces and additional characters (except for + character). For example, the number «+371 2 1234567» should be passed as «+37121234567»). Exactly one of the two fields must be passed: email or phone.

1.2 and later versions.

client.inn

N12

No

INN of the buyer.

1.2 and later versions.

client.name

ANS..256

No

Customer name.

1.2 and later versions.

operatingCheckProps.name

ANS

No

Operation ID The value is «0» until the value of Russia's Federal Tax Service attribute is determined.

1.2 and later versions.

operatingCheckProps.name

ANS

No

Operation ID The value is «0» until the value of Russia's Federal Tax Service attribute is determined.

1.2 and later versions.

operatingCheckProps.timestamp

NS19

No

Date and time of the operation in dd.mm.yyyy HH:MM:SS format

1.2 and later versions.

operatingCheckProps.value

ANS..64

No

Operation data.

1.2 and later versions.

sectoralCheckProps.date

NS10

No

Date of the legislative act of the federal body of executive power that sets forth the requirements for assigning the value of «sectoral attribute». Format: dd.mm.yyyy.

1.2 and later versions.

sectoralCheckProps.federalId

ANS

No

Identifier of federal body of executive power. Must be one of the values from directory of federal bodies of executive power

1.2 and later versions.

sectoralCheckProps.number

N..32

No

Number of the legislative act of the federal body of executive power that sets forth the requirements for assigning the value of «sectoral attribute».

1.2 and later versions.

sectoralCheckProps.value

ANS..256

No

A set of values defined by the legislative act of the federal body of executive power.

1.2 and later versions.

===== Response parameters ===== The response parameters are given in table below.

Name Type Mandatory Description FFD version

orderId

ANS36

No

Identifier of the order in the payment system. It is unique within the system. The identifier is missing if the order registration failed due to an error detailed in errorCode.

All versions.

formUrl

AN..512

No

Payment form URL to redirect the client's browser to. This parameter is not returned if the registration of the order was not successful due to the error described in errorCode.

To be able to accept payment in this way, you must have the respective rights in the system. If in doubt, contact technical support.

All versions.

errorCode

N3

No

Error code.

All versions.

errorMessage

AN..512

No

Error description in the language passed in the language parameter in the request.

All versions.

===== Error codes =====

Error code Error text
0

The request has been processed without system errors.

1

Wrong order number.

1

An order with this number has already been processed.

3

Unknown currency.

4

The amount is missing.

4

Order number is empty

4

Empty return URL

5

Access denied.

5

The user must change the password.

7

System error.

8

[refundItems.totalAmount] the sum of items in the cart does not match the total.

8

[refundItems.item.quantity.value] Too high or too low value.

===== Examples ==== ==== Request example ==== <sxh xml> <soapenv:Envelope xmlns:mer=«http://engine.paymentgate.ru/webservices/merchant» xmlns:soapenv=«http://schemas.xmlsoap.org/soap/envelope/»> <soapenv:Header> <soapenv:Body> <mer:registerOrderPreAuth> <order merchantOrderNumber=«${=System.currentTimeMillis()}» amount=«23500» description=«2.1.1. Payment. 2.1.2. (P)Refund. 2.1.3. (F)Refund. TwoPhase. ATOL»> <returnUrl>http://kzntest.ru/index.html</returnUrl> <failUrl>kzntest.ru/fail.html</failUrl> <clientId>117</clientId> <orderBundle> <customerDetails> <phone>+79123456789</phone> <inn>516974792202</inn> <passport>4507 443564</passport> </customerDetails> <!– Contents of the cart –> <cartItems> <!– Zero or more repetitions: –> <items positionId=«1»> <name>«SMALL»</name> <quantity measure=«0»>1</quantity> <itemCode>270_235.00</itemCode> <itemPrice>23500</itemPrice> <tax> <taxType>0</taxType> <taxSum>0</taxSum> </tax> <itemAttributes> <attributes name=«nomenclature»>010463003407001221CMK45BrhN0WLf</attributes> <attributes name=«paymentMethod»>1</attributes> <attributes name=«paymentObject»>30</attributes> <attributes name=«agent_info.type»>7</attributes> <attributes name=«agent_info.paying.operation»>testoperation</attributes> <attributes name=«agent_info.paying.phones»>+79123456789</attributes> <attributes name=«agent_info.paymentsOperator.phones»>+79123456789</attributes> <attributes name=«agent_info.MTOperator.phones»>+79123456789</attributes> <attributes name=«agent_info.MTOperator.name»>MT operator</attributes> <attributes name=«agent_info.MTOperator.address»>Moscow</attributes> <attributes name=«agent_info.MTOperator.inn»>8634330204</attributes> <attributes name=«supplier_info.phones»>+79123456789</attributes> <attributes name=«supplier_info.name»>Supplier</attributes> <attributes name=«supplier_info.inn»>287381373424</attributes> <attributes name=«excise»>10.0</attributes> <attributes name=«country_code»>810</attributes> <attributes name=«declaration_number»>12332234533</attributes> <attributes name=«userData»>user data</attributes> <attributes name=«markQuantity.numerator»>1</attributes> <attributes name=«markQuantity.denominator»>2</attributes> <attributes name=«sectoralItemProps[0].federalId»>001</attributes> <attributes name=«sectoralItemProps[0].date»>10.10.2021</attributes> <attributes name=«sectoralItemProps[0].number»>123/4567</attributes> <attributes name=«sectoralItemProps[0].value»>value1</attributes> <attributes name=«sectoralItemProps[1].federalId»>003</attributes> <attributes name=«sectoralItemProps[1].date»>10.10.2021</attributes> <attributes name=«sectoralItemProps[1].number»>321/4567</attributes> <attributes name=«sectoralItemProps[1].value»>value2</attributes> </itemAttributes> </items> </cartItems> </orderBundle> </order> </mer:registerOrderPreAuth> </soapenv:Body> </soapenv:Envelope> </sxh> ==== Пример ответа ==== <sxh xml> <soap:Envelope xmlns:soap=«http://schemas.xmlsoap.org/soap/envelope/»> <soap:Body> <ns1:registerOrderPreAuthResponse xmlns:ns1=«http://engine.paymentgate.ru/webservices/merchant»> <return orderId=«2438c149-5cdb-719f-b41a-1ff60128092a» errorCode=«0» errorMessage=«Success»> <formUrl>https://3dsec.sberbank.ru/testpayment/payment_ru.html?mdOrder=2438c149-5cdb-719f-b41a-1ff60128092a</formUrl> </return> </ns1:registerOrderPreAuthResponse> </soap:Body> </soap:Envelope> </sxh>