Запрос на проведение рекуррентных платежей (recurrentPayment)

Для регистрации заказа используется запрос recurrentPayment.do

В настоящем документе при описании параметров запросов и ответов используются следующие обозначения типов данных:

A<n> – последовательность латинских букв длины <n>;
A..<n> – последовательность латинских букв длиной, не превышающей <n>;
N<n> – последовательность цифр длины <n>;
N..<n> – последовательность цифр длиной, не превышающей <n>;
AN<n> – последовательность латинских букв и цифр фиксированной длины <n>;
AN..<n> – последовательность латинских букв и цифр длиной, не превышающей <n>;
ANS<n> – последовательность латинских букв, цифр и символов фиксированной длины <n>
ANS..<n> – последовательность латинских букв, цифр и символов длиной, не превышающей <n>;
UTC – дата и время, при этом: дата должна быть передана без указания часового пояса, время московское, для протокола SOAP используется стандартная кодировка xs:dateTime.

Пользуясь протоколом REST, тело сообщения запроса следует отправлять с типом: 'Content-Type: application/json'.

Параметры запроса

Параметры запроса представлены в таблице ниже.

Название	Тип	Обязательно	Описание
`userName`	AN..30	Да	Логин служебной учётной записи продавца.
`password`	AN..200	Да	Пароль служебной учётной записи продавца.
`orderNumber`	ANS..32	Да	Номер заказа в системе магазина.
`language`	A2	Нет	Язык в кодировке ISO 639-1. Если не указан, будет использован язык, указанный в настройках магазина как язык по умолчанию.
`bindingId`	AN..255	Да	Идентификатор связки, созданной ранее.
`amount`	N..12	Да	Сумма платежа в минимальных единицах валюты.
`currency`	N3	Нет	Код валюты платежа ISO 4217. Если не указано, то используется значение по умолчанию.
`description`	ANS..512	Нет	Описание заказа в свободной форме. В процессинг банка для включения в финансовую отчётность продавца передаются только первые 24 символа этого поля. Чтобы получить возможность отправлять это поле в процессинг, обратитесь в техническую поддержку.
`additionalParameters`	Не актуально	Нет	Дополнительные параметры заказа, которые сохраняются для просмотра из личного кабинета продавца. Каждую новую пару имени и значения параметра следует отделять запятой. Ниже представлен пример использования. { "firstParamName": "firstParamValue", "secondParamName": "secondParamValue" } Если у продавца настроена фискализация, при указании в качестве дополнительных параметров email (адрес электронной почты покупателя) и/или phone (номер сотового телефона покупателя) эти параметры в первую очередь используются для отправки фискального чека. В параметре запрещено передавать зарезервированные имена (в случае их передачи заказ может быть отклонен): sbrf_spasibo:amount_bonus sbrf_sbermiles:amount_bonus loyaltyId overridenClientId
`billingPayerData`	См. описание	Нет	Блок c регистрационными данными клиента (адрес, почтовый индекс), необходимыми для прохождения проверки адреса в рамках сервисов AVS/AVV. Обязателен, если активна соответствующая пермиссия для мерчанта («Разрешено использование AVS/AVV»).

billingPayerData

Параметры блока billingPayerData

Название	Тип	Обязательно	Описание
`billingCity`	AN..50	Нет	Город, зарегистрированный по конкретной карте у Банка Эмитента
`billingCountry`	AN..50	Нет
`billingAddressLine1`	AN..50	Нет	Адрес, зарегистрированный по конкретной карте у Банка Эмитента Строка 1. Обязательно, если у Мерчанта активирована пермиссия «Разрешено использование AVS/AVV».
`billingAddressLine2`	AN..50	Нет	Адрес, зарегистрированный по конкретной карте у Банка Эмитента Строка 2.
`billingAddressLine3`	AN..50	Нет	Адрес, зарегистрированный по конкретной карте у Банка Эмитента Строка 3.
`billingPostalCode`	AN..50	Нет	Почтовый индекс, зарегистрированный по конкретной карте у Банка Эмитента. Обязательно, если у Мерчанта активирована пермиссия «Разрешено использование AVS/AVV».
`billingState`	AN..50	Нет	Штат, зарегистрированный по конкретной карте у Банка Эмитента (ISO 3166-2)

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

Параметры ответа представлены в таблице ниже.

Название	Тип	Обязательно	Описание
`success`	A..5	Да	Указывает на успешность запроса. Доступны следующие значения: `true` (истина) - запрос обработан успешно; `false` (ложь) - запрос не прошёл.
Блок `data` (возвращается, только если запрос прошёл успешно)
`orderId`	ANS36	Да	Номер заказа в платежной системе. Уникален в пределах системы. Отсутствует если регистрация заказа не удалась по причине ошибки, детализированной в ErrorCode.
Блок `error` (возвращается, только если запрос завершился с ошибкой)
`code`	N..2	Да	Код ошибки.
description	ANS..512	Да	Подробное техническое объяснение ошибки - содержимое этого параметра не предназначено для отображения пользователю.
`message`	AN..512	Да	Понятное описание ошибки - предназначено для отображения пользователю.

Коды ошибок

Код ошибки	Текст ошибки
0	Обработка запроса прошла без системных ошибок.
1	Недостаточно средств на карте.
1	Неверный номер заказа.
2	Связка не найдена.
4	Неверный идентификатор связки `[bindingId]`.
5	Возможность использования связок отключена.
5	Неверная сумма `[amount]`.
5	Неверное имя пользователя.
5	Неверный пароль
5	Ошибка аутентификации
7	Системная ошибка.
10	Заказ с таким номером уже зарегистрирован.
10	Некорректное значение параметра [currency]
10	Некорректное значение параметра [language]
10	Повторяющийся номер заказа
10	Некорректное значение параметра [orderNumber]
10	Некорректное значение параметра [orderDescription]. Ссылки в описании заказа не допускаются

Примеры

Пример запроса

{
  "userName": "userName",
  "password": "password",
  "orderNumber": "UAF-203974-DE-12",
  "language": "RU",
  "bindingId": "binding_id",
  "amount": 12300,
  "currency": "810",
  "description" : "Test description",
  "additionalParameters": {
    "firstParamName": "firstParamValue",
    "secondParamName": "secondParamValue"
  }
 }

Пример успешной оплаты

{
    "success": true,
    "data": {
        "orderId": "f7beebe4-7c9a-43cf-8e26-67ab741f9b9e"
    },
    "orderStatus": {
        "errorCode": "0",
        "orderNumber": "UAF-203974-DE-12",
        "orderStatus": 2,
        "actionCode": 0,
        "actionCodeDescription": "",
        "amount": 12300,
        "currency": "810",
        "date": 1491333938243,
        "orderDescription": "Test description",
        "merchantOrderParams": [
            {
                "name": "firstParamName",
                "value": "firstParamValue"
            },
            {
                "name": "secondParamName",
                "value": "secondParamValue"
            }
        ],
        "attributes": [],
        "cardAuthInfo": {
            "expiration": "201912",
            "cardholderName": "sdf sdf",
            "approvalCode": "123456",
            "paymentSystem": "VISA",
            "pan": "411111**1111"
        },
        "authDateTime": 1491333939454,
        "terminalId": "11111",
        "authRefNum": "111111111111",
        "paymentAmountInfo": {
            "paymentState": "DEPOSITED",
            "approvedAmount": 12300,
            "depositedAmount": 12300,
            "refundedAmount": 0
        },
        "bankInfo": {
            "bankCountryName": "<Неизвестно>"
        },
        "chargeback": false,
        "operations": [
            {
                "amount": 12300,
                "cardHolder": "sdf sdf",
                "authCode": "123456"
            }
        ]
    }
}

Пример неуспешной оплаты

{
  "error": {
    "code": "10",
    "description": "Заказ с таким номером уже зарегистрирован.",
    "message": "Заказ с таким номером уже зарегистрирован."
  },
  "success": false
}

Инструменты страницы