Метод confirmPayment

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

Описание

Завершение успешного перевода на счет магазина. Нужен для работы с отложенными переводами.

Restriction.

Для выполнения запросов подтверждения (confirmPayment) и аннулирования отложенного перевода (cancelPayment) необходимо зарегистрировать отдельный магазин.

Вы можете обратиться к менеджеру за подробной информацией о подключении.

Note.
  • Если для магазина предусмотрены отложенные переводы в Яндекс.Кассе, то все переводы в этот магазин будут отложенными, т.е. будут выполняться в два шага: заморозка средств на банковской карте плательщика и списание средств с карты.
  • Сумма, указанная в запросе подтверждения отложенного перевода может быть меньше суммы заморозки, в этом случае остаток средств будет автоматически возращен на банковскую карту плательщика.
  • Если время подтверждения для отложенного перевода истекло, то, несмотря на верные значения параметров запроса, в ответе будет ошибка. Время подтверждения определяется на стороне банка, через который проходит операция, для каждого банка индивидуально.

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

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

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

Параметр

Тип

Описание

requestDT

dateTime

Время формирования запроса на выполнение операции по часам системы магазина.

orderId

long

Номер транзакции отложенного перевода, выдается Яндекс.Кассой в параметре invoiceId.

amount

CurrencyAmount

Сумма перевода, который необходимо провести.

currency

string, 3 символа

Буквенный код валюты перевода. Указывается в соответствии с ISO 4217:2008.

ym_merchant_receiptstring

Данные для формирования чека в формате JSON (так же, как в платежной форме).

Параметр передается и является обязательным, если:

  • вы настроили взаимодействие со своей онлайн-кассой через Яндекс.Кассу и передаете в платежной форме данные для формирования чека;
  • сумма перевода (amount) отличается от исходной, переданной в платежной форме (проводится частичный клиринг).

Параметр

Тип

Описание

requestDT

dateTime

Время формирования запроса на выполнение операции по часам системы магазина.

orderId

long

Номер транзакции отложенного перевода, выдается Яндекс.Кассой в параметре invoiceId.

amount

CurrencyAmount

Сумма перевода, который необходимо провести.

currency

string, 3 символа

Буквенный код валюты перевода. Указывается в соответствии с ISO 4217:2008.

ym_merchant_receiptstring

Данные для формирования чека в формате JSON (так же, как в платежной форме).

Параметр передается и является обязательным, если:

  • вы настроили взаимодействие со своей онлайн-кассой через Яндекс.Кассу и передаете в платежной форме данные для формирования чека;
  • сумма перевода (amount) отличается от исходной, переданной в платежной форме (проводится частичный клиринг).

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

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

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

requestDT=2011-07-02T20:38:00.000Z&orderId=12345&amount=10.00&currency=RUB

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

<confirmPaymentResponse 
         orderId="12345"
         status="0" error="0"
         processedDT="2011-07-02T20:38:01.000Z"
         />

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

Сценарий отложенной оплаты

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

Коды ошибок

Типы данных