Метод incoming-transfer-accept

Описание

Прием входящих переводов, защищённых кодом протекции, и переводов до востребования.

Количество попыток приема входящего перевода с кодом протекции ограничено. При исчерпании количества попыток, перевод автоматически отвергается (перевод возвращается отправителю).

Требуемые права токена: incoming-transfers.

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

Параметр Тип Описание
operation_id string Идентификатор операции, значение параметра operation_id ответа метода operation-history.
protection_code string Код протекции. Строка из 4-х десятичных цифр. Указывается для входящего перевода, защищённого кодом протекции. Для переводов до востребования отсутствует.

Возвращает

Метод возвращает следующие параметры:

Параметр Тип Описание
status string Код результата выполнения операции (см. таблицу).
error string Код ошибки при проведении платежа (пояснение к полю status). Присутствует только при ошибках.
protection_code_attempts_available int Количество оставшихся попыток принять входящий перевод защищённый кодом протекции. Присутствует только при неверно введённом коде протекции.
ext_action_uri string Адрес, на который необходимо отправить пользователя для совершения необходимых действий в случае ошибки ext_action_required.

Код результата выполнения операции:

Код Описание
success Входящий перевод принят успешно.
refused Отказ в выполнении операции.

В случае ошибки выполнения операции возвращается ее код:

Код Описание
illegal_param_protection_code Отсутствует или имеет недопустимое значение параметр protection_code.
illegal_param_operation_id Отсутствует или имеет недопустимое значение параметр operation_id. Перевод с таким operation_id не существует или уже отвергнут.
ext_action_required В настоящее время приём переводов невозможен. Для получения возможности приема переводов пользователю необходимо перейти на страницу по адресу ext_action_uri и и следовать инструкции на данной странице. Это могут быть следующие действия:
  • ввести идентификационные данные
  • принять оферту
  • выполнить иные действия согласно инструкциям на странице
already_rejected Перевод уже отвергнут.

Примеры

Прием входящего перевода, защищённого кодом протекции:

POST /api/incoming-transfer-accept HTTP/1.1
Host: money.yandex.ru
Authorization: Bearer 410012345678901.0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ0123
Content-Type: application/x-www-form-urlencoded
Content-Length: 41

operation_id=1234567&protection_code=0123

Пример ответа при успехе:

{
  "status":"success"
}

Пример ответа при неверно введённом коде протекции:

{
  "status":"refused",
  "error":"illegal_param_protection_code",
  "protection_code_attempts_available":2
}