Метод confirmInvoice
Это старая версия API. Переходите на API ЮKassa.
 
Описание
Запрос позволяет подтвердить списание денег со счета пользователя во внешних платежных системах (ВПС) при выставлении счета в смс.
  1. Внешняя платежная система отправляет пользователю смс с кодом.
  2. Пользователь вводит код из смс на сайте магазина.
  3. Магазин отправляет запрос подтверждения оплаты (
    confirmInvoice
    ) с кодом, который ввел пользователь (код передается в параметре
    clientNumberCode
    ). Отправлять этот запрос нужно только в тех случаях, когда пользователь подтверждает платеж на сайте, а не ответным сообщением.
Для выполнения запросов на оплату по смс необходимо подключение по HTTP-протоколу.
 
Формат запроса
Адрес для вызова операции
https://shop.yookassa.ru/webservice/mws/api/confirmInvoice
Параметры запроса
ПараметрТипОписание
clientOrderIdClientTransactionNumberУникальный идентификатор операции. Обеспечивает защиту от ошибочных повторов операций. Рекомендуемые значения: целое, положительное, линейно нарастающее десятичное число.
shopIdxs:stringИдентификатор магазина, выдается ЮKassa.
invoiceIdxs:stringИдентификатор заказа на стороне ЮKassa. Должен быть равен значению атрибута
orderId
, который был получен в ответе на запрос на создание платежа createInvoice.
clientNumberCodexs:stringКод подтверждения платежа, введенный пользователем.
Пример параметров запроса
clientOrderId=123456789&invoiceId=2000000123&amount=10.00&cvv=643
 
Формат ответа
В ответ приходят параметры, общие для всех типов запросов на исполнение финансовых операций.
Пример ответа
XML
<confirmInvoiceResponse
         clientOrderId="123456789"
         status="0" error="0"
         processedDT="2011-07-02T20:38:01.000Z"
         techMessage=""
         />
 
Особенности
  • Магазину необходимо на своей стороне организовать ввод кода из смс и передачу этого кода в ЮKassa.
  • Если пользователь ввел неверный код из смс, в ответ на запрос контрагенту придет соответствующая ошибка.
  • Допускается отправка трех запросов повторного подтверждения оплаты с разными кодами. После чего следует снова инициировать платеж вызовом createInvoice с новым значением
    clientOrderId
    .
 
Что почитать еще
Оплата по счету в смсМетод createInvoiceПравила обработки запросовКоды ошибокТипы данных