Метод confirmInvoice

Attention. Это старая версия API. Переходите на API Яндекс.Кассы.

Описание

Запрос позволяет подтвердить списание денег со счета пользователя во внешних платежных системах (ВПС) при выставлении счета в смс.

  1. Внешняя платежная система отправляет пользователю смс с кодом.
  2. Пользователь вводит код из смс на сайте магазина.
  3. Магазин отправляет запрос подтверждения оплаты (confirmInvoice) с кодом, который ввел пользователь (код передается в параметре clientNumberCode). Отправлять этот запрос нужно только в тех случаях, когда пользователь подтверждает платеж на сайте, а не ответным сообщением.
Restriction.

Для выполнения запросов на оплату по смс необходимо подключение по HTTP-протоколу.

Адрес для вызова операции confirmInvoice

https://server:port/webservice/mws/api/confirmInvoice

Входные параметры

Параметр

Тип

Описание

clientOrderId

ClientTransactionNumber

Уникальный идентификатор операции. Обеспечивает защиту от ошибочных повторов операций. Рекомендуемые значения: целое, положительное, линейно нарастающее десятичное число.

shopId

xs:string

Идентификатор магазина, выдается Яндекс.Кассой.

invoiceId

xs:string

Идентификатор заказа на стороне Яндекс.Кассы. Должен быть равен значению атрибута orderId, который был получен в ответе на запрос на создание платежа createInvoice.

clientNumberCode

xs:string

Код подтверждения платежа, введенный пользователем.

Параметр

Тип

Описание

clientOrderId

ClientTransactionNumber

Уникальный идентификатор операции. Обеспечивает защиту от ошибочных повторов операций. Рекомендуемые значения: целое, положительное, линейно нарастающее десятичное число.

shopId

xs:string

Идентификатор магазина, выдается Яндекс.Кассой.

invoiceId

xs:string

Идентификатор заказа на стороне Яндекс.Кассы. Должен быть равен значению атрибута orderId, который был получен в ответе на запрос на создание платежа createInvoice.

clientNumberCode

xs:string

Код подтверждения платежа, введенный пользователем.

Выходные параметры общие для всех типов запросов на исполнение финансовых операций.

Note.

Магазину необходимо на своей стороне организовать ввод кода из смс и передачу этого кода в Яндекс.Кассу.

Если пользователь ввел неверный код из смс, в ответ на запрос контрагенту придет соответствующая ошибка.

Допускается отправка трех запросов повторного подтверждения оплаты с разными кодами. После чего следует снова инициировать платеж вызовом createInvoice с новым значением clientOrderId.

Примеры

Пример параметров запроса
clientOrderId=123456789&invoiceId=2000000123&amount=10.00&cvv=643
Пример ответа
<confirmInvoiceResponse 
         clientOrderId="123456789"
         status="0" error="0"
         processedDT="2011-07-02T20:38:01.000Z"
         techMessage=""
         />

Смотрите также

Оплата по счету в смс

Метод createInvoice

Правила обработки запросов

Коды ошибок

Типы данных