«ЮMoney»

Обзор

Введение

«ЮMoney» — метод, позволяющий проводить платежи в российских рублях с использованием электронного кошелька в России. Для этого метода в платёжной платформе EtoPlatezhi поддерживаются оплаты и возвраты. И, в дополнение к ним, готовится поддержка повторяемых оплат.

В этой статье представлена информация о работе с методом «ЮMoney»: обзорный раздел с общими сведениями и последующие разделы с информацией о действиях, необходимых со стороны мерчанта для решения разных задач.

Характеристика


Тип платёжного метода	платежи с использованием электронных кошельков
Платёжные инструменты	электронные кошельки
Регионы использования	RU
Валюты платежей	RUB
Конвертация валют	–
Разовые оплаты	+
Повторяемые оплаты	+
Полные возвраты	+
Частичные возвраты	–
Выплаты	–
Опротестования	–
Особенности	–
Организация и стоимость подключения	по согласованию с курирующим менеджером EtoPlatezhi

Схема работы

В проведении отдельного платежа с использованием метода «ЮMoney» задействуются веб-сервис мерчанта, один из интерфейсов и платёжная платформа EtoPlatezhi, а также технические средства сервиса провайдера.

Основные операции

Для проведения платежей и выполнения операций с использованием метода «ЮMoney» могут применяться различные интерфейсы платёжной платформы. Так, оплаты могут проводиться через Payment Page, Gate и Dashboard (с применением платёжных ссылок). При этом, независимо от используемых интерфейсов, для каждой оплаты применимы ограничения по сумме и времени. Более подробная информация доступна при обращении к курирующему менеджеру EtoPlatezhi.

Сценарии использования

Проведение оплат с использованием метода «ЮMoney» осуществляется с перенаправлением пользователей к сервису «ЮMoney».

Сценарии выполнения операций через основные интерфейсы платёжной платформы соответствуют представленным на схемах. При использовании дополнительных возможностей (таких как платёжные ссылки) сценарии выполнения операций методом «ЮMoney» соответствуют специфике этих возможностей.

Оплаты через Payment Page

Общая информация

Для проведения оплаты через Payment Page с использованием метода «ЮMoney» со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL EtoPlatezhi и принять оповещение о результате. Полная схема проведения оплаты выглядит следующим образом.

Рис. 3. Проведение оплаты через Payment Page. Описание шагов

Пользователь на стороне веб-сервиса инициирует оплату.
От веб-сервиса на заданный URL EtoPlatezhi передаётся запрос на проведение оплаты через Payment Page.
Запрос на проведение оплаты поступает в платёжную платформу.
В платёжной платформе выполняется приём запроса, с проверкой наличия обязательных параметров и корректной подписи.
Осуществляется подготовка к открытию платёжной формы согласно параметрам проекта и вызова.
Пользователю отображается платёжная форма.
Пользователь выбирает для оплаты метод «ЮMoney».
В платёжную платформу передаётся запрос на проведение оплаты с использованием метода «ЮMoney».
В платёжной платформе выполняются обработка полученного запроса и его отправка в сервис провайдера.
В сервисе провайдера выполняется обработка запроса на оплату.
От сервиса провайдера к платёжной платформе передаются данные для перенаправления пользователя к сервису провайдера.
Данные для перенаправления пользователя передаются к Payment Page.
Пользователь перенаправляется к сервису провайдера.
Пользователь выполняет необходимые действия для оплаты.
В сервисе провайдера выполняется обработка платежа.
Информация о результате оплаты отображается пользователю в сервисе провайдера.
Пользователь перенаправляется к Payment Page.
От сервиса провайдера к платёжной платформе направляется информация о результате оплаты.
От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
От платёжной платформы к Payment Page направляется информация о результате оплаты.
Информация о результате оплаты отображается пользователю на Payment Page.

Информация о форматах запросов и оповещений, используемых для проведения оплат методом «ЮMoney» через Payment Page, приведена далее в этом разделе; общая информация о работе с Payment Page API — в отдельной статье Организация взаимодействия.

Формат запросов

При формировании запросов на открытие платёжной формы с применением метода «ЮMoney» необходимо учитывать следующее:

Должен использоваться базовый минимум параметров, обязательный для любого платежа:
- project_id — идентификатор проекта, полученный от EtoPlatezhi при интеграции;
- payment_id — идентификатор платежа, уникальный в рамках проекта;
- payment_currency — буквенный код валюты платежа в формате ISO-4217 alpha-3;
- payment_amount — сумма платежа в дробных единицах валюты;
- customer_id — идентификатор пользователя в рамках проекта.
Должен использоваться базовый минимум параметров: project_id, payment_id, payment_currency, payment_amount, customer_id.
Валютой платежа может быть только RUB.
Для предварительного выбора метода «ЮMoney» необходимо указывать код этого метода в параметре force_payment_method — yoomoney-wallet.
Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page (подробнее).
После указания всех целевых параметров необходимо составлять подпись (подробнее).

Таким образом, корректный запрос на открытие платёжной формы с применением метода «ЮMoney» должен содержать идентификатор проекта, базовые сведения о платеже (идентификатор, сумму и код валюты), идентификатор пользователя и подпись, а также может содержать различные дополнительные параметры.

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 1000,
   "payment_currency": "RUB",
   "customer_id": "customer1",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

Рис. 4. Пример достаточного набора данных для запроса на оплату

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 1000,
   "payment_currency": "RUB",
   "customer_id": "customer1",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

Формат оповещений

Для оповещений о результатах оплат с применением метода «ЮMoney» используется типовой формат, описание которого представлено в статье Работа с оповещениями (подробнее).

В следующем примере оповещение свидетельствует о том, что в рамках проекта 129103 была проведена оплата в размере 1 000,00 RUB.

Рис. 5. Пример данных из оповещения о проведении оплаты

 {
        "customer": {
            "id": "f4d68g5f"
        },
        "project_id": 129103,
        "payment": {
            "id": "testtoo0003",
            "type": "purchase",
            "status": "success",
            "date": "2025-06-19T10:39:26+0000",
            "method": "Yoomoney",
            "sum": {
                "amount": 100000,
                "currency": "RUB"
            },
            "description": ""
        },
        "operation": {
            "sum_initial": {
                "amount": 100000,
                "currency": "RUB"
            },
            "sum_converted": {
                "amount": 100000,
                "currency": "RUB"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 18301,
                "payment_id": "71b83839-44514220488",
                "auth_code": ""
            },
            "id": 5023372010140727,
            "type": "sale",
            "status": "success",
            "date": "2025-06-19T10:39:26+0000",
            "created_date": "2025-06-19T10:37:20+0000",
            "request_id": "9d8138a67b35b045a8bb490502779e9f40beffd7f3-05023373"
        },
        "signature": "KmV6HLSQFhPEHTR3lZKfbbraumHyfOunD9MiP+PA=="
    }
}

Дополнительные материалы

Для организации работы с оплатами через Payment Page также могут быть полезны следующие материалы:

Организация взаимодействия — о том, как организовать взаимодействие веб-сервиса с платёжной платформой через Payment Page.
Работа с подписью к данным — о порядке создания и проверки подписи в программных запросах и оповещениях при взаимодействии с платёжной платформой.
Проведение платежей — о типах, схемах проведения и возможных статусах поддерживаемых платежей и операций.
Разовая оплата в две стадии — о том, как проводить разовые оплаты с незамедлительным списанием средств через Payment Page.
Работа с информацией об операциях — о служебных кодах, которые используются в платёжной платформе, чтобы фиксировать информацию о выполнении операций.

Повторяемые оплаты через Payment Page

Общая информация

Повторяемые оплаты через «ЮMoney» — это метод проведения повторных платежей со списанием по запросам или рекуррентных операций с использованием сохраненных платёжных данных. Подробная информация представлена в разделе Повторяемая оплата со списаниями по запросам. Через Payment Page доступна регистрация повторяемой оплаты, для этого со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, а также данные для регистрации повторяемой оплаты в объекте recurring, на рабочий URL EtoPlatezhi и принять оповещение о результате. В оповещении о регистрации повторяемой оплаты вы получите её идентификатор, который нужно использовать для проведения или отмены регулярной оплаты через Gate. Подробная информация об этом представлена в разделе Повторяемые оплаты через Gate.

Информация о форматах запросов и оповещений, используемых для проведения оплат методом «ЮMoney» через Payment Page, приведена далее в этом разделе; общая информация о работе с Payment Page API — в отдельной статье Организация взаимодействия.

Формат запросов

При формировании запросов на открытие платёжной формы для регистрации повторяемой оплаты с применением метода «ЮMoney» необходимо учитывать следующее:

Должен использоваться базовый минимум параметров, обязательный для любого платежа.
Для регистрации повторяемой оплаты необходимо передавать признак такой регистрации в объекте recurring и пояснение к характеру оказываемых услуг в параметре payment_description.
При использовании JavaScript-библиотеки EtoPlatezhi объект recurring в таком запросе может представлять собой JSON-объект, включающий в себя параметр register со значением true. В других случаях объект recurring, как и тело запроса в целом, должен указываться в виде URL-строки, полученной из исходного JSON-объекта с помощью преобразования URL-encoding.
Для предварительного выбора метода «ЮMoney» необходимо указывать код этого метода в параметре force_payment_method — yoomoney-wallet.
Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page (подробнее).
После указания всех целевых параметров необходимо составлять подпись (подробнее).

Таким образом, корректный запрос на открытие платёжной формы с применением метода «ЮMoney» должен содержать идентификатор проекта, базовые сведения о платеже (идентификатор платежа, сумму и код валюты), идентификатор пользователя, признак регистрации повторяемой оплаты, а также подпись.

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 100000,
   "payment_currency": "RUB",
   "customer_id": "customer1",
   "recurring": {"register":true},
   "payment_description": "example reason",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

Рис. 6. Пример достаточного набора данных для запроса на регистрацию повторяемой оплаты

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 100000,
   "payment_currency": "RUB",
   "customer_id": "customer1",
   "recurring": {"register":true},
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

Дополнительные материалы

Для организации работы с оплатами через Payment Page также могут быть полезны следующие материалы:

Организация взаимодействия — о том, как организовать взаимодействие веб-сервиса с платёжной платформой через Payment Page.
Работа с подписью к данным — о порядке создания и проверки подписи в программных запросах и оповещениях при взаимодействии с платёжной платформой.
Проведение платежей — о типах, схемах проведения и возможных статусах поддерживаемых платежей и операций.
Работа с информацией об операциях — о служебных кодах, которые используются в платёжной платформе, чтобы фиксировать информацию о выполнении операций.

Оплаты через Gate

Общая информация

Для проведения оплаты через Gate с использованием метода «ЮMoney» со стороны веб-сервиса необходимо:

Отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL EtoPlatezhi.
Принять промежуточное оповещение от платёжной платформы и осуществить перенаправление пользователя к сервису провайдера.
Принять итоговое оповещение от платёжной платформы.

Полная схема проведения оплаты выглядит следующим образом.

Рис. 7. Проведение оплаты через Gate. Описание шагов

Пользователь на стороне веб-сервиса инициирует оплату с использованием метода «ЮMoney».
От веб-сервиса на заданный URL EtoPlatezhi передаётся запрос на проведение оплаты через Gate.
Запрос на проведение оплаты поступает в платёжную платформу EtoPlatezhi.
В платёжной платформе выполняется приём запроса с проверкой наличия обязательных параметров и корректной подписи.
От платёжной платформы к веб-сервису направляется ответ с информацией о получении запроса и его корректности (подробнее).
В платёжной платформе выполняются дальнейшая обработка запроса (с проверкой согласованности параметров) и его оправка в сервис провайдера.
В сервисе провайдера выполняется обработка запроса на оплату.
От сервиса провайдера к платёжной платформе передаются данные для перенаправления пользователя к сервису провайдера.
От платёжной платформы к веб-сервису направляется оповещение с данными для перенаправления пользователя к сервису провайдера.
Пользователь перенаправляется к сервису провайдера.
Пользователь выполняет необходимые действия для оплаты.
В сервисе провайдера выполняется обработка платежа.
Пользователю отображается информация о результате оплаты.
Пользователь перенаправляется к веб-сервису.
От сервиса провайдера к платёжной платформе направляется информация о результате оплаты.
От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
На стороне веб-сервиса обеспечивается информирование пользователя о результате оплаты.

Информация о форматах запросов и оповещений, используемых для проведения оплат методом «ЮMoney» через Gate, приведена далее в этом разделе; общая информация о работе с Gate API — в отдельной статье Организация взаимодействия.

Формат запросов

При работе с запросами на оплаты с применением метода «ЮMoney» необходимо учитывать следующее:

Для инициирования каждой оплаты должен использоваться отдельный POST-запрос к конечной точке /v2/payment/wallet/yoomoney/sale. Эта точка относится к группе /v2/payment/wallet/{payment_method}/sale.
В каждом запросе должны использоваться следующие объекты и параметры:
- general — объект, содержащий основные идентификационные сведения запроса:
  - project_id — идентификатор проекта, полученный от EtoPlatezhi при интеграции;,
  - payment_id — идентификатор платежа, уникальный в рамках проекта;,
  - signature — подпись запроса, составленная после указания всех целевых параметров (подробнее — в разделе Работа с подписью к данным); (подробнее),
- payment — объект, содержащий сведения о платеже:
  - amount — сумма платежа в дробных единицах валюты;,
  - currency — буквенный код валюты платежа в формате ISO-4217 alpha-3;,
- customer — объект, содержащий сведения о пользователе:
  - id — идентификатор пользователя, уникальный в рамках проекта;,
  - ip_address — IP-адрес пользователя, актуальный для инициируемого платежа.
Валютой платежа может быть только RUB.
Дополнительно могут использоваться любые другие параметры из числа указанных в спецификации.

Таким образом, корректный запрос на оплату с применением метода «ЮMoney» должен содержать идентификатор проекта, базовые сведения о платеже (идентификатор, сумму и код валюты), идентификатор и IP-адрес пользователя, подпись, а также может содержать различные дополнительные параметры.

{
  "general": {
    "project_id": 210,
    "payment_id": "test_payment",
    "signature": "PJkV8ej\/UG0Di8hTng6JvipTv+AWoXW\/9MTO8yJA=="
  },
  "payment": {
    "amount": 1000,
    "currency": "RUB"
  },
  "customer": {
    "id": "customer123",
    "ip_address": "192.0.2.0"
  }
}

Рис. 8. Пример достаточного набора данных для запроса на оплату

{
  "general": {
    "project_id": 210,
    "payment_id": "test_payment",
    "signature": "PJkV8ej\/UG0Di8hTng6JvipTv+AWoXW\/9MTO8yJA=="
  },
  "payment": {
    "amount": 1000,
    "currency": "RUB"
  },
  "customer": {
    "id": "customer123",
    "ip_address": "192.0.2.0"
  }
}

Формат промежуточных оповещений для перенаправления пользователей

Для перенаправления пользователей от веб-сервиса мерчанта к сервису провайдера при проведении каждого платежа с использованием метода «ЮMoney» необходимо принять промежуточное оповещение от платёжной платформы и использовать информацию из него, включённую в объект redirect_data. Формат таких оповещений является типовым (подробнее), при этом в состав объекта redirect_data включаются следующие объекты и параметры:

body — объект с данными для отправки в теле запроса;
method — параметр с указанием HTTP-метода отправки запроса (GET или POST);
url — параметр со ссылкой для перенаправления.

Рис. 9. Пример объекта redirect_data

  "redirect_data": {
    "body": {},
    "method": "GET",
    "url": "https://www.example.com/pay"
  }

Формат итоговых оповещений

Для итоговых оповещений об оплатах с применением метода «ЮMoney» используется типовой формат, описание которого представлено в статье Работа с оповещениями (подробнее).

В следующем примере оповещение свидетельствует о том, что в рамках проекта 129103 была проведена оплата в размере 1 000,00 RUB.

Рис. 10. Пример данных из оповещения о проведении оплаты

 {
        "customer": {
            "id": "f4d68g5f"
        },
        "project_id": 129103,
        "payment": {
            "id": "testtoo0003",
            "type": "purchase",
            "status": "success",
            "date": "2025-06-19T10:39:26+0000",
            "method": "Yoomoney",
            "sum": {
                "amount": 100000,
                "currency": "RUB"
            },
            "description": ""
        },
        "operation": {
            "sum_initial": {
                "amount": 100000,
                "currency": "RUB"
            },
            "sum_converted": {
                "amount": 100000,
                "currency": "RUB"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 18301,
                "payment_id": "71b83839-44514220488",
                "auth_code": ""
            },
            "id": 5023372010140727,
            "type": "sale",
            "status": "success",
            "date": "2025-06-19T10:39:26+0000",
            "created_date": "2025-06-19T10:37:20+0000",
            "request_id": "9d8138a67b35b045a8bb490502779e9f40beffd7f3-05023373"
        },
        "signature": "KmV6HLSQFhPEHTR3lZKfbbraumHyfOunD9MiP+PA=="
    }
}

Дополнительные материалы

Для организации работы с оплатами через Gate также могут быть полезны следующие материалы:

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

Повторяемые оплаты через Gate

Общая информация

Повторяемые оплаты через «ЮMoney» — это метод проведения повторных платежей со списанием по запросам или рекуррентных операций с использованием сохраненных платёжных данных. Подробная информация представлена в разделе Повторяемая оплата со списаниями по запросам.

Информация о форматах запросов, используемых для проведения оплат методом «ЮMoney» через Gate, приведена далее в этом разделе; общая информация о работе с Gate API — в отдельной статье Организация взаимодействия.

Регистрация повторяемой оплаты

Для регистрации повторяемых оплат со стороны веб-сервиса необходимо отправить запрос на оплату, содержащий требуемые параметры и подпись, а также признак регистрации повторяемой оплаты в параметре register объекта recurring со значением true, на заданный URL EtoPlatezhi и принять оповещение с информацией о результате. Если вы укажете в параметре register какое-либо другое значение, будет проведена разовая оплата, а повторяемая оплата зарегистрирована не будет.

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

Информация о проведении оплаты через Gate с помощью метода «ЮMoney» представлена в разделе Оплаты через Gate.

Таким образом, корректный запрос на регистрацию повторяемой оплаты с применением метода «ЮMoney» должен содержать идентификатор проекта, базовые сведения о платеже (идентификатор платежа, сумму и код валюты), идентификатор пользователя и IP-адрес пользователя, признак регистрации повторяемой оплаты, а также подпись.

 {
  "general": {
    "project_id": 208,
    "payment_id": "TEST_15427007172789",
    "signature": "DH0v2pZnkK9hwytOqrWdbltzO5GMSkzd0Iq6lM2...==",
  },
  "customer": {
    "ip_address": "192.0.2.0",
    "id": "123"
  },
  "payment": {
    "amount": 1000,
    "currency": "RUB",
    "description": "example reason"
  },
  "recurring": {
    "register": true
  }
}

Рис. 11. Пример достаточного набора данных для запроса на регистрацию повторяемой оплаты

 {
  "general": {
    "project_id": 208,
    "payment_id": "TEST_15427007172789",
    "signature": "DH0v2pZnkK9hwytOqrWdbltzO5GMSkzd0Iq6lM2...==",
  },
  "customer": {
    "ip_address": "192.0.2.0",
    "id": "123"
  },
  "payment": {
    "amount": 1000,
    "currency": "RUB",
    "description": "example reason"
  },
  "recurring": {
    "register": true
  }
}

Формат запросов на проведение повторяемой оплаты

После того, как повторяемая оплата зарегистрирована, для инициирования повторяемой оплаты, следует отправить в платёжную платформу запрос с полученным идентификатором повторяемой оплаты, который вы ранее получили в оповещении при регистрации этой повторяемой оплаты.

При работе с запросами на проведение повторяемой оплаты с применением метода «ЮMoney» необходимо учитывать следующее:

Для проведения каждой оплаты должен использоваться отдельный POST-запрос к конечной точке /v2/payment/wallet/yoomoney/recurring. Эта конечная точка относится к группе /v2/payment/wallet/{payment_method}/recurring.
В каждом запросе должны использоваться следующие объекты и параметры:
- general — объект, содержащий основные идентификационные сведения запроса:
  - project_id — идентификатор проекта, полученный от EtoPlatezhi при интеграции;,
  - payment_id — идентификатор платежа, уникальный в рамках проекта;,
  - signature — подпись запроса, составленная после указания всех целевых параметров (подробнее — в разделе Работа с подписью к данным); (подробнее),
- payment — объект, содержащий сведения о платеже:
  - amount — сумма платежа в дробных единицах валюты;,;
  - currency — код валюты платежа в формате ISO-4217 alpha-3;,
- customer — объект, содержащий сведения о пользователе:
  - ip_address — IP-адрес пользователя, актуальный для инициируемого платежа;
- recurring — объект, содержащий сведения о повторяемой оплате:
  - id — идентификатор зарегистрированной повторяемой оплаты.
Дополнительно могут использоваться любые другие параметры из числа указанных в спецификации.

Таким образом, корректный запрос на проведение повторяемой оплаты с применением метода «ЮMoney» должен содержать идентификатор проекта, базовые сведения о платеже (идентификатор платежа, сумму и код валюты), IP-адрес пользователя, идентификатор зарегистрированной регулярной оплаты, а также подпись.

 {
  "general": {
    "project_id": 208,
    "payment_id": "TEST_15427007172789",
    "signature": "DH0v2pZnkK9hwytQ6bltzO5GMSkzd0Iq6lM2...==",
  },
  "customer": {
    "ip_address": "192.0.2.0"
  },
  "payment": {
    "amount": 1000,
    "currency": "RUB"
  },
  "recurring": {
    "id": 1234567890
  }
}

Рис. 12. Пример достаточного набора данных для запроса на проведение повторяемой оплаты

 {
  "general": {
    "project_id": 208,
    "payment_id": "TEST_15427007172789",
    "signature": "DH0v2pZnkK9hwytQ6bltzO5GMSkzd0Iq6lM2...==",
  },
  "customer": {
    "ip_address": "192.0.2.0"
  },
  "payment": {
    "amount": 1000,
    "currency": "RUB"
  },
  "recurring": {
    "id": 1234567890
  }
}

Дополнительные материалы

Для организации работы с оплатами через Gate также могут быть полезны следующие материалы:

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

Возвраты через Gate

Общая информация

Для выполнения возврата через Gate с использованием метода «ЮMoney» со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL EtoPlatezhi и принять оповещение о результате. Полная схема выполнения возврата выглядит следующим образом.

Рис. 13. Выполнение возврата через Gate. Описание шагов

Пользователь инициирует возврат.
От веб-сервиса на заданный URL EtoPlatezhi передаётся запрос на выполнение возврата.
Запрос на выполнение возврата поступает в платёжную платформу EtoPlatezhi.
В платёжной платформе выполняется приём запроса с проверкой наличия обязательных параметров и корректной подписи.
От платёжной платформы к веб-сервису направляется ответ с информацией о получении запроса и его корректности (подробнее).
В платёжной платформе обеспечиваются дальнейшая обработка запроса (с проверкой согласованности параметров) и его отправка в сервис провайдера.
В сервисе провайдера выполняется обработка возврата.
От сервиса провайдера к платёжной платформе направляется информация о результате возврата.
От платёжной платформы к веб-сервису направляется оповещение о результате возврата.
На стороне веб-сервиса обеспечивается информирование пользователя о результате возврата.

Информация о форматах запросов и оповещений, используемых для выполнения возвратов методом «ЮMoney» через Gate, приведена далее в этом разделе; общая информация о работе с Gate API — в отдельной статье Организация взаимодействия.

Формат запросов

При работе с запросами на возвраты с применением метода «ЮMoney» необходимо учитывать следующее:

Для инициирования каждого возврата должен использоваться отдельный POST-запрос к конечной точке /v2/payment/wallet/yoomoney/refund. Эта точка входа относится к группе запросов на проведение платежей с помощью электронного кошелька: /v2/payment/wallet/{payment_method}/refund.
В каждом запросе должны использоваться следующие объекты и параметры:
- general — объект, содержащий основные идентификационные сведения запроса:
  - project_id — идентификатор проекта, полученный от EtoPlatezhi при интеграции;,
  - payment_id — идентификатор платежа, для которого необходимо выполнить возврат;,
  - signature — подпись запроса, составленная после указания всех целевых параметров (подробнее — в разделе Работа с подписью к данным); (подробнее)),
- payment — объект, содержащий сведения о возврате:
  - description — комментарий к возврату или его описание;,
- customer — объект, содержащий сведения о пользователе:
  - ip_address — IP-адрес пользователя, актуальный для инициируемого возврата.
Дополнительно могут использоваться любые другие параметры из числа указанных в спецификации.

Таким образом, корректный запрос на возврат с применением метода «ЮMoney» должен содержать идентификаторы проекта и платежа, описание возврата, IP-адрес пользователя и подпись.

{
  "general": {
    "project_id": 210,
    "payment_id": "test_payment",
    "signature": "PJkV8ej\/UG0Di8hTng6JvipTv+AWoXW\/9MTO8yJA=="
  },
  "payment": {
    "description": "test refund"
  },
  "customer": {
    "ip_address": "192.0.2.0"
  }
}

Рис. 14. Пример достаточного набора данных для запроса на возврат

{
  "general": {
    "project_id": 210,
    "payment_id": "test_payment",
    "signature": "PJkV8ej\/UG0Di8hTng6JvipTv+AWoXW\/9MTO8yJA=="
  },
  "payment": {
    "description": "test refund"
  },
  "customer": {
    "ip_address": "192.0.2.0"
  }
}

Формат оповещений

Для оповещений о результатах возвратов с применением метода «ЮMoney» используется типовой формат, описание которого представлено в разделе Работа с оповещениями.

В следующем примере оповещение свидетельствует о том, что в рамках проекта 1037 был выполнен возврат в размере 100,00 RUB.

Рис. 15. Пример данных из оповещения о выполнении возврата

{
    "project_id": 1037,
    "payment": {
        "id": "62153051",
        "type": "purchase",
        "status": "refunded",
        "date": "2024-06-15T13:21:51+0000",
        "method": "Yoomoney",
        "sum": {
            "amount": 10000,
            "currency": "RUB"
        },
        "description": "Test sale"
    },
    "customer": {
        "id": "1234"
    },
    "operation": {
        "id": 63,
        "type": "refund",
        "status": "success",
        "date": "2024-06-15T14:23:56+0000",
        "created_date": "2024-06-15T14:22:51+0000",
        "request_id": "ea2e5888a65cf1b1f2b5-00000003",
        "sum_initial": {
            "amount": 10000,
            "currency": "RUB"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "RUB"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 1782,
            "payment_id": "7C035795EJ562523A",
            "date": "2024-06-15T14:23:51+0000"
        }
    },
    "signature": "uU6LOpEjEqxeqJ2GsDkDnaY+1p1m4aS5zTPkJA=="
}

В следующем примере оповещение свидетельствует об отклонённом возврате.

Рис. 16. Пример данных из оповещения об отклонении возврата

{
    "project_id": 1037,
    "payment": {
        "id": "59375393",
        "type": "purchase",
        "status": "success",
        "date": "2024-06-15T14:23:56+0000",
        "method": "Yoomoney",
        "sum": {
            "amount": 10000,
            "currency": "RUB"
        },
        "description": "Test sale"
    },
    "customer": {
        "id": "1234"
    },
    "operation": {
        "id": 84,
        "type": "refund",
        "status": "decline",
        "date": "2024-06-15T14:23:56+0000",
        "created_date": "2024-06-15T14:23:56+0000",
        "request_id": "776d5d3e602912e88858c922e34e5-00000001",
        "sum_initial": {
            "amount": 10000,
            "currency": "RUB"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "RUB"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 1782,
            "payment_id": "",
            "date": ""  
        }
    },
    "signature": "qjVnKRZX51lrxh5kqCzurbJbQQSAeFwqH7H9gk7gUYI3A=="
}

Дополнительные материалы

Для организации работы с возвратами через Gate также могут быть полезны следующие материалы:

Организация взаимодействия — о том, как взаимодействовать с платёжной платформой через Gate.
Работа с подписью к данным — о порядке создания и проверки подписи в программных запросах и оповещениях при взаимодействии с платёжной платформой.
Проведение платежей — о типах, схемах проведения и возможных статусах поддерживаемых платежей и операций.
Возвраты средств после оплат — о том, как выполнять возвраты через Gate.
Работа с информацией об операциях — о служебных кодах, используемых в платёжной платформе для фиксации информации о выполнении операций.

Возвраты через Dashboard

При использовании интерфейса Dashboard можно выполнять одиночные и массовые возвраты методом «ЮMoney» с единичной и пакетной отправкой запросов, называемые соответственно одиночными и массовыми.

Для выполнения одиночного возврата необходимо выбрать целевую оплату, открыть карточку этой оплаты, указать сумму возврата, отправить запрос и убедиться в выполнении возврата.
Для выполнения массового возврата необходимо подготовить и загрузить файл с информацией обо всех целевых возвратах, отправить пакет запросов и убедиться в выполнении возвратов.

При этом должен использоваться файл формата CSV, структура которого соответствует требованиям, представленным в разделе Сведения о массовых платежах, а параметры возвратов — требованиям, представленным в разделе Возвраты через Gate этой статьи (за исключением пункта о подписи).

Более подробная информацияИнформация о выполнении возвратов через Dashboard представлена в отдельном разделе.

Анализ результатов проведения платежей

Для анализа информации о платежах и операциях, как в отдельности по методу «ЮMoney», так и в совокупности с другими методами, можно использовать:

инструментарий интерфейса Dashboard, с различными реестрами и аналитическими панелями;,
отчёты в формате CSV, выгружаемые (как разово, так и периодически) через раздел Отчёты интерфейса Dashboard;,
данные в формате JSON, получаемые по программным запросам через интерфейс Data API.

С вопросами по анализу информации можно обращаться к разделам документации (Dashboard и Использование Data API) и специалистам EtoPlatezhi.