M-Pesa
Обзор
M-Pesa — платёжный метод, который позволяет проводить платежи по номеру мобильного телефона. Оплаты осуществляются через Payment Page и Gate, выплаты и возвраты — через Gate.
Характеристика
Тип платёжного метода | Электронный кошелёк |
---|---|
Регионы использования | Кения |
Валюты платежей | KES |
Конвертация валют | – |
Оплаты | + |
Выплаты | + |
Оплаты по сохранённым данным | – |
Полные возвраты | + |
Частичные возвраты | + |
Опротестования | – |
Особенности | нет возможности предварительного выбора платёжного метода на Payment Page |
Организация и стоимость подключения | По согласованию с курирующим менеджером ECommPay |
Схема работы
В проведении отдельного платежа с использованием M-Pesa задействуются веб-сервис мерчанта, один из интерфейсов и платёжная платформа ECommPay, а также технические средства провайдера. Оплаты осуществляются через Payment Page и Gate, выплаты и возвраты — через Gate.
Основные операции
Интерфейсы | Суммы, KES | Время | ||||||
---|---|---|---|---|---|---|---|---|
Payment Page | CMS Plug-ins | Gate | Dashboard (Old Dashboard) | минимум | максимум | базовое | предельное | |
Оплаты | + | – | + | – | 1,00 | 500 000,00 | до 10 минут | * |
Выплаты | – | – | + | – | 10,00 | 200 000,00 | до 10 минут | * |
Полные возвраты | – | – | + | – | – | – | до 10 минут | * |
Частичные возвраты | – | – | + | – | – | – | до 10 минут | * |
* Подробную информацию уточняйте у вашего курирующего менеджера.
Базовое время — среднее расчётное время проведения платежа от момента его инициализации на стороне платёжной платформы до момента отправки инициатору оповещения о результате. Это время, определяемое для условий штатной работы всех технических средств и каналов связи, а также типичных действий со стороны пользователя (там, где они необходимы). Базовое время рекомендуется использовать для реагирования на отсутствие оповещений о результате платежа и выполнения опроса состояния платежа.
Предельное время — максимально допустимое время проведения платежа от момента его инициализации на стороне платёжной платформы до момента отправки инициатору оповещения о результате. Если платёж не был проведён или отклонён за это время, он автоматически переводится в статус decline
. Для индивидуальной настройки предельного времени следует обращаться к специалистам технической поддержки ECommPay.
Сценарии использования
Проведение оплат с использованием метода M-Pesa выполняется с перенаправлением пользователей к сервису M-Pesa, проведение выплат и возвратов — с уведомлением пользователей через веб-сервис мерчанта.
Рис.: Оплата через Payment Page
Рис.: Оплата через Gate
Рис.: Возврат через Gate
Рис.: Выплата через Gate
Детальные сведения о том, что необходимо делать со стороны мерчанта для проведения платежей, а также о том, что можно использовать для анализа информации о проведённых платежах, представлены далее.
Оплаты через Payment Page
Общая информация
Оплата через Payment Page с использованием метода M-Pesa со стороны веб-сервиса выполняется стандартным образом: через отправку запроса, содержащего требуемые параметры и подпись, на рабочий URL ECommPay и приём оповещения о результате оплаты. Полная схема проведения оплаты представлена далее.
Рис.: Проведение оплаты через Payment Page
- Пользователь на стороне веб-сервиса инициирует оплату.
- От веб-сервиса на заданный URL ECommPay передаётся запрос на проведение оплаты в Payment Page.
- Запрос на проведение оплаты поступает в платёжную платформу.
- Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
- Осуществляется генерация Payment Page согласно настройкам проекта и параметрам вызова.
- Пользователю отображается сгенерированная платёжная форма.
- Пользователь выбирает платёжный метод M-Pesa.
- Запрос на проведение оплаты в сервисе M-Pesa поступает в платёжную платформу.
- Выполняются дальнейшая обработка запроса и его отправка в сервис M-Pesa.
- На стороне M-Pesa выполняется обработка запроса на оплату.
- От сервиса M-Pesa к платёжной платформе передаются данные для перенаправления пользователя на платёжную форму M-Pesa.
- Данные для перенаправления пользователя на платёжную форму M-Pesa передаются к Payment Page.
- Пользователь перенаправляется на платёжную форму M-Pesa.
- Пользователь выполняет необходимые действия для совершения оплаты.
- На стороне M-Pesa выполняется обработка платежа.
- От сервиса M-Pesa к платёжной платформе направляется уведомление о результате оплаты.
- От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
- От платёжной платформы к Payment Page направляется результат проведения оплаты.
- Результат оплаты отображается пользователю на Payment Page.
Информация о формате запросов и параметрах вызова Payment Page при работе с M-Pesa, а также о формате оповещений о результатах оплат приведена далее; общая информация о работе с API — в отдельном разделе.
Формат запросов
При формировании запросов на открытие платёжной формы с применением метода M-Pesa необходимо учитывать следующее:
- Должен использоваться базовый минимум параметров — параметры, обязательные для любого платёжного метода:
- project_id — идентификатор проекта, полученный от ECommPay при интеграции;
- payment_id — идентификатор платежа, уникальный в рамках проекта;
- payment_currency — валюта платежа в формате ISO-4217 alpha-3;
- payment_amount — сумма платежа в минорных единицах;
- customer_id — идентификатор пользователя уникальный в рамках проекта.
- Валютой платежа может быть только KES.
- Дополнительно должен использоваться параметр payment_description — описание платежа.
- Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page.
- После определения всех параметров необходимо составить подпись. Подробную информацию см. в Работа с подписью к данным.
Таким образом, корректный запрос на открытие платёжной формы с применением метода M-Pesa должен содержать идентификаторы проекта и платежа, а также описание, валюту и сумму платежа с использованием кенийского шиллинга:
EPayWidget.run( { payment_id: 'X03936', payment_amount: 5000, payment_currency: 'KES', project_id: 102, customer_id: 'customer1', payment_description: 'test PP sale', signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y1Y4HASCQ9vyS...==" } )
Детальная информация обо всех указанных параметрах приведена в разделе Параметры открытия платежной формы Payment Page.
Формат оповещений
Для оповещений о результатах оплат с применением метода M-Pesa используется стандартный формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 255
пользователь с номером телефона 254798365268
успешно совершил оплату на сумму 10,00 KES
.
Рис.: Пример оповещения о проведенной оплате
{ "project_id": 255, "payment": { "id": "TEST_155", "type": "purchase", "status": "success", "date": "2019-02-18T16:23:33+0000", "method": "mpesa", "sum": { "amount": 1000, "currency": "KES" }, "description": "TEST_155" }, "account": { "number": "254798365268" }, "customer": { "phone": "254798365268" }, "operation": { "id": 828000003219, "type": "sale", "status": "success", "date": "2019-02-18T16:23:33+0000", "created_date": "2019-02-18T16:21:32+0000", "request_id": "8725679f13368befbe20ee05151ebdb0563edf88a5c71166a0a2fab", "sum_initial": { "amount": 1000, "currency": "KES" }, "sum_converted": { "amount": 1000, "currency": "KES" }, "provider": { "id": 1150, "payment_id": "6826979082", "date": "2019-02-18T16:22:58+0000", "auth_code": "" }, "code": "0", "message": "Success" }, "signature": "10hBlstO4unTNCKpp6zVgUoiGprO2OhkZvJ7RbnmLnB1Ru6da 5K5+aagnXYiBtjd03e3+T7TTiHoF54/ScJwyQ==" }
В следующем примере оплата была отклонена из-за недостатка средств на счёте аккаунта пользователя.
Рис.: Пример оповещения об отказе в проведении оплаты
{ "project_id": 255, "payment": { "id": "TEST_155", "type": "purchase", "status": "decline", "date": "2019-02-13T14:25:07+0000", "method": "mpesa", "sum": { "amount": 200, "currency": "KES" }, "description": "ECT_TEST_15500669030661" }, "account": { "number": "0798365267" }, "customer": { "phone": "0798365267" }, "operation": { "id": 17513000003139, "type": "sale", "status": "decline", "date": "2019-02-13T14:25:07+0000", "created_date": "2019-02-13T14:21:25+0000", "request_id": "932570d281daa6b2f3d29cbe6f6fb258c5e328d2979530ee0af", "sum_initial": { "amount": 200, "currency": "KES" }, "sum_converted": { "amount": 200, "currency": "KES" }, "provider": { "id": 1150, "payment_id": "7737999295", "date": "2019-02-13T14:24:43+0000", "auth_code": "" }, "code": "20105", "message": "Insufficient funds on customer account" }, "signature": "ME5ZrgXgK1ewc4oVFFhptPn7SC4Dpds/SObifUU5B9BjioarBBLO4f G2MGG5TxVWnKcaWFzV5vN15LEu59Zjpg==" }
Дополнительные материалы
Для организации работы с оплатами через Payment Page также могут быть полезны следующие материалы:
Оплаты через Gate
Общая информация
Для оплаты через Gate с использованием платёжного метода M-Pesa со стороны веб-сервиса необходимо:
- Отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ECommPay.
- Осуществить перенаправление пользователя к сервису M-Pesa для совершения оплаты.
- Принять оповещение о результате оплаты.
Рис.: Проведение оплаты через Gate
- Пользователь на стороне веб-сервиса инициирует оплату с использованием метода M-Pesa.
- От веб-сервиса на заданный URL ECommPay передаётся запрос на проведение оплаты через Gate.
- Запрос на проведение оплаты поступает в платёжную платформу.
- Выполняется начальная обработка запроса: осуществляется проверка наличия обязательных параметров и корректности подписи.
- От платёжной платформы к веб-сервису направляется ответ с информацией о получении запроса и его корректности.
- В платёжной платформе выполняются дальнейшая обработка запроса и его отправка в сервис M-Pesa.
- На стороне сервиса M-Pesa выполняется обработка запроса на оплату.
- От сервиса M-Pesa к платёжной платформе передаются данные для перенаправления пользователя к сервису M-Pesa.
- Данные для перенаправления пользователя к сервису M-Pesa передаются к веб-сервису.
- Пользователь перенаправляется к сервису M-Pesa.
- Пользователь выполняет необходимые действия для совершения оплаты.
- На стороне M-Pesa выполняется обработка платежа.
- От сервиса M-Pesa к платёжной платформе направляется уведомление о результате оплаты.
- От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
- От веб-сервиса пользователю направляется уведомление о совершении оплаты.
Информация о формате запросов и параметрах инициализации оплат методом M-Pesa через Gate, а также о формате оповещений о результатах оплат приведена далее; общая информация о работе с API — в разделе Работа с API.
Формат запросов
При работе с запросами на оплаты с применением метода M-Pesa необходимо учитывать следующее:
- Должен использоваться запрос /v2/payment/mpesa/sale, отправляемый методом POST.
- В запросе должны использоваться следующие объекты и параметры:
- general — объект, содержащий основные идентификационные сведения о запросе:
- project_id — идентификатор проекта, полученный от ECommPay при интеграции;
- payment_id — идентификатор платежа, уникальный в рамках проекта;
- signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
- payment — объект, содержащий сведения о платеже:
- amount — сумма платежа в минорных единицах,
- currency — валюта платежа в формате ISO-4217 alpha-3;
- customer — объект, содержащий сведения о пользователе:
- id — идентификатор, уникальный в рамках проекта,
- ip_address — используемый IP-адрес;
- account — объект, содержащий сведения о счёте пользователя:
- number — мобильный телефон пользователя.
- general — объект, содержащий основные идентификационные сведения о запросе:
- Валютой платежа может быть только KES.
- Дополнительно могут использоваться все параметры, указанные в спецификации.
Таким образом, корректный запрос на оплату с применением метода M-Pesa должен содержать идентификаторы проекта и платежа, валюту и сумму платежа с использованием кенийского шиллинга, а также IP-адрес и номер мобильного телефона пользователя:
Рис.: Пример запроса на оплату
{ "general": { "project_id": 255, "payment_id": "TEST_155", "signature": "8oDYXcwOawdFy41j1fl3ORHioZP2/fpSEpoFohjcvfjlOS8 Ya/vYj2f4cI42K4bd/Pwue2dhgQkPYTuNMh7h3Q==" }, "customer": { "ip_address": "45.76.37.192", "id": "customer123" }, "payment": { "amount": 1000, "currency": "KES" }, "account": { "number": "254798465267" } }
Форматы данных для перенаправления пользователей
Для перенаправления пользователя от веб-сервиса на сайт сервиса M-Pesa необходимо принять оповещение от платёжной платформы, содержащее ссылку для перенаправления в параметре redirect_data.url и данные для отправки в теле запроса redirect_data.body, и использовать эти параметры при открытии HTML-страницы сайта методом, указанным в redirect_data.method.
Далее приведён фрагмент оповещения, содержащего токен на оплату.
"redirect_data": { "method": "GET", "body": [], "encrypted": [], "url": "http://test.com" }
Формат оповещений
Для оповещений о результатах оплат с применением метода M-Pesa используется стандартный формат, описание которого представлено в разделе Оповещения.
Рис.: Пример оповещения о проведенной оплате
{ "project_id": 255, "payment": { "id": "TEST_155", "type": "purchase", "status": "success", "date": "2019-02-18T16:23:33+0000", "method": "mpesa", "sum": { "amount": 1000, "currency": "KES" }, "description": "TEST_155" }, "account": { "number": "254798365268" }, "customer": { "phone": "254798365268" }, "operation": { "id": 828000003219, "type": "sale", "status": "success", "date": "2019-02-18T16:23:33+0000", "created_date": "2019-02-18T16:21:32+0000", "request_id": "8725679f13368befbe20ee05151ebdb0563edf88a5c71166a0a2fab", "sum_initial": { "amount": 1000, "currency": "KES" }, "sum_converted": { "amount": 1000, "currency": "KES" }, "provider": { "id": 1150, "payment_id": "6826979082", "date": "2019-02-18T16:22:58+0000", "auth_code": "" }, "code": "0", "message": "Success" }, "signature": "10hBlstO4unTNCKpp6zVgUoiGprO2OhkZvJ7RbnmLnB1Ru6da 5K5+aagnXYiBtjd03e3+T7TTiHoF54/ScJwyQ==" }
В данном примере оповещение свидетельствует о том, что в рамках проекта 255
пользователь с номером телефона 254798365268
успешно совершил оплату на сумму 10,00 KES
.
Рис.: Пример оповещения об отказе в проведении оплаты
{ "project_id": 255, "payment": { "id": "TEST_155", "type": "purchase", "status": "decline", "date": "2019-02-13T14:25:07+0000", "method": "mpesa", "sum": { "amount": 200, "currency": "KES" }, "description": "ECT_TEST_15500669030661" }, "account": { "number": "0798365267" }, "customer": { "phone": "0798365267" }, "operation": { "id": 17513000003139, "type": "sale", "status": "decline", "date": "2019-02-13T14:25:07+0000", "created_date": "2019-02-13T14:21:25+0000", "request_id": "932570d281daa6b2f3d29cbe6f6fb258c5e328d2979530ee0af", "sum_initial": { "amount": 200, "currency": "KES" }, "sum_converted": { "amount": 200, "currency": "KES" }, "provider": { "id": 1150, "payment_id": "7737999295", "date": "2019-02-13T14:24:43+0000", "auth_code": "" }, "code": "20105", "message": "Insufficient funds on customer account" }, "signature": "ME5ZrgXgK1ewc4oVFFhptPn7SC4Dpds/SObifUU5B9BjioarBBLO4f G2MGG5TxVWnKcaWFzV5vN15LEu59Zjpg==" }
В этом примере оплата была отклонена из-за недостатка средств на счёте аккаунта пользователя.
Дополнительные материалы
Для организации работы с оплатами через Gate также могут быть полезны следующие материалы:
Возвраты через Gate
Общая информация
M-Pesa поддерживает проведение полных и частичных возвратов. Проведение возврата с использованием метода M-Pesa выполняется стандартным для Gate способом: с отправкой запроса, содержащего требуемые параметры и подпись, на рабочий URL ECommPay и с последующей обработкой этого запроса платёжной платформой. Полная схема проведения возврата представлена далее.
Рис.: Проведение возврата через Gate
- Пользователь на стороне веб-сервиса запрашивает возврат средств на счёт в банке.
- От веб-сервиса на заданный URL ECommPay передаётся запрос на проведение возврата через Gate.
- Запрос на проведение возврата поступает в платёжную платформу.
- Выполняется начальная обработка запроса: осуществляется проверка наличия обязательных параметров и корректности подписи.
- От платёжной платформы к веб-сервису передается ответ с результатом первичной обработки запроса.
- Обработанный запрос передаётся в сервис M-Pesa.
- На стороне M-Pesa выполняется обработка платежа.
- От сервиса M-Pesa к платёжной платформе направляется уведомление о результате возврата.
- От платёжной платформы к веб-сервису направляется оповещение о результате возврата.
- От веб-сервиса пользователю направляется уведомление о совершении возврата.
Информация о формате запросов и параметрах инициализации возвратов методом M-Pesa через Gate, а также о формате оповещений о результатах возвратов приведена далее, общая информация о работе с API — Работа с API.
Формат запросов
При работе с запросами на возврат с применением метода M-Pesa необходимо учитывать следующее:
- Должен использоваться запрос /v2/payment/mpesa/refund, отправляемый методом POST.
- В запросе должны использоваться следующие объекты и параметры:
- general — объект, содержащий основные идентификационные сведения о запросе:
- project_id — идентификатор проекта, полученный от ECommPay при интеграции;
- payment_id — идентификатор платежа, уникальный в рамках проекта;
- signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным).
- payment — объект, содержащий сведения о платеже:
- amount — сумма платежа в минорных единицах,
- currency — валюта платежа в формате ISO-4217 alpha-3;
- description — комментарий или описание возврата.
- general — объект, содержащий основные идентификационные сведения о запросе:
- Валютой платежа может быть только KES.
- Дополнительно могут использоваться все параметры, указанные в спецификации.
Таким образом, корректный запрос на возврат с применением метода M-Pesa должен содержать идентификаторы проекта и платежа, а также валюту и сумму платежа:
Рис.: Пример запроса на возврат
{ "general": { "project_id": 32290, "payment_id":"mpesa-refund", "signature": "ME5ZrgXgK1ewc4oVFFhptPn7SC4Dpds/SObifUU5B9BjioarBBLO4f...==" }, "payment": { "amount": 105, "currency": "KES", "description": "refund" } }
Формат оповещений
Для оповещений о результатах возвратов с применением метода M-Pesa используется стандартный формат, описание которого представлено в разделе Оповещения.
В данном случае оповещение свидетельствует о том, что в рамках проекта 257
был успешно проведён частичный возврат.
Рис.: Пример оповещения о проведенном возврате
{ "project_id": 257, "payment": { "id": "TEST_155", "type": "purchase", "status": "partially refunded", "date": "2019-02-18T06:18:01+0000", "method": "mpesa", "sum": { "amount": 40000, "currency": "KES" }, "description": "TEST_155" }, "operation": { "id": 258000003219, "type": "refund", "status": "success", "date": "2019-02-18T06:18:01+0000", "created_date": "2019-02-18T06:17:52+0000", "request_id": "dda6eb029059832eb1", "sum_initial": { "amount": 10000, "currency": "KES" }, "sum_converted": { "amount": 10000, "currency": "KES" }, "provider": { "id": 1149, "payment_id": "25960166", "date": "2019-02-18T06:18:00+0000", "auth_code": "" }, "code": "0", "message": "Success" }, "signature": "L3DDG4SK3dukjBjT8ZZfOL4X/jE1/BgKp5LI2+putJA/U4Dxog WEKCqbOWewI6dt4C7EX1BEkKL4QGH1nNNWRw==" }
В этом примере возврат был отклонён по причине того, что значение суммы в запросе на возврат больше суммы в инитной оплате.
Рис.: Пример оповещения об отказе в проведении возврата
{ "project_id": 257, "payment": { "id": "TEST_155", "type": "purchase", "status": "success", "date": "2019-02-13T12:35:49+0000", "method": "mpesa", "sum": { "amount": 50000, "currency": "KES" }, "description": "TEST_155" }, "operation": { "id": 258000003164, "type": "refund", "status": "decline", "date": "2019-02-15T13:36:28+0000", "created_date": "2019-02-15T13:36:27+0000", "request_id": "354c11cdc403a2", "sum_initial": { "amount": 10000, "currency": "KES" }, "sum_converted": { "amount": 10000, "currency": "KES" }, "provider": { "id": 1149, "payment_id": "", "auth_code": "" }, "code": "3283", "message": "Refund amount more than init amount" }, "signature": "1aw64dc0nH3bKt4XJr8F6UXhC352gaSGEvSrHz8zsg4mOR3kcH GRYAxYPI9sqQ57/2KWDwhjfNf2XY2ZuDMovg==" }
Дополнительные материалы
Для организации работы с возвратами через Gate также могут быть полезны следующие материалы:
Выплаты через Gate
Общая информация
Проведение выплаты с использованием метода M-Pesa выполняется стандартным для Gate способом: с отправкой запроса, содержащего требуемые параметры и подпись, на рабочий URL ECommPay и с последующей обработкой этого запроса платёжной платформой. Полная схема проведения выплаты представлена далее.
Рис.: Проведение выплаты через Gate
- Пользователь на стороне веб-сервиса запрашивает выплату на свой счёт в банке.
- От веб-сервиса на заданный URL ECommPay передаётся запрос на проведение выплаты через Gate.
- Запрос на проведение выплаты поступает в платёжную платформу.
- Выполняется начальная обработка запроса: осуществляется проверка наличия обязательных параметров и корректности подписи.
- От платёжной платформы к веб-сервису передается ответ с результатом первичной обработки запроса.
- Обработанный запрос передаётся в сервис M-Pesa.
- На стороне M-Pesa выполняется обработка платежа.
- От сервиса M-Pesa к платёжной платформе направляется уведомление о результате выплаты.
- От платёжной платформы к веб-сервису направляется оповещение о результате выплаты.
- От веб-сервиса пользователю направляется уведомление о совершении выплаты.
Информация о формате запросов и параметрах инициализации выплат методом M-Pesa через Gate, а также о формате оповещений о результатах выплат приведена далее, общая информация о работе с API — Работа с API.
Формат запросов
При работе с запросами на выплаты с применением метода M-Pesa необходимо учитывать следующее:
- Должен использоваться запрос /v2/payment/mpesa/payout, отправляемый методом POST.
- В запросе должны использоваться следующие объекты и параметры:
- general — объект, содержащий основные идентификационные сведения о запросе:
- project_id — идентификатор проекта, полученный от ECommPay при интеграции;
- payment_id — идентификатор платежа, уникальный в рамках проекта;
- signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
- payment — объект, содержащий сведения о платеже:
- amount — сумма платежа в минорных единицах,
- currency — валюта платежа в формате ISO-4217 alpha-3;
- customer — объект, содержащий сведения о пользователе:
- ip_address — используемый IP-адрес;
- account — объект, содержащий сведения о счёте пользователя:
- number — мобильный телефон пользователя.
- general — объект, содержащий основные идентификационные сведения о запросе:
- Валютой платежа может быть только KES.
- Дополнительно могут использоваться все параметры, указанные в спецификации.
Таким образом, корректный запрос на выплату с применением метода M-Pesa должен содержать идентификаторы проекта и платежа, валюту и сумму платежа с использованием кенийского шиллинга, а также IP-адрес и номер мобильного телефона пользователя:
Рис.: Пример запроса на выплату
{ "general": { "project_id": 579, "payment_id": "Mpesa-Payout-001", "signature": "l6BHX+YbCbbYmVUNfBoUS1HyIb7zhEnbf1288ppHe77 HLvPJ/NDZUskXxQhuFnlnY4nLyYmikvBrZNsb99D20Q==" }, "account": { "number": "798365267" }, "customer": { "ip_address": "127.0.0.1" }, "payment": { "amount": 1000, "currency": "KES" } }
Формат оповещений
Для оповещений о результатах оплат с применением метода M-Pesa используется стандартный формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 255
для пользователя 22
была успешно проведена выплата в размере 10,00 KES
.
Рис.: Пример оповещения о проведенной выплате
{ "project_id": 255, "payment": { "id": "mpesa_payout_1112243", "type": "payout", "status": "success", "date": "2019-04-30T11:20:04+0000", "method": "mpesa", "sum": { "amount": 1000, "currency": "KES" }, "description": "test_payout" }, "account": { "number": "798365267" }, "customer": { "id": "22" }, "operation": { "id": 32826000001677, "type": "payout", "status": "success", "date": "2019-04-30T11:20:04+0000", "created_date": "2019-04-30T11:20:04+0000", "request_id": "db00b094f1969ed50285fce550fe2c269c2b2fb21972f9e54c1214", "sum_initial": { "amount": 1000, "currency": "KES" }, "sum_converted": { "amount": 1000, "currency": "KES" }, "provider": { "id": 1150, "payment_id": "" }, "code": "0", "message": "Success" }, "signature": "4d9g0vNsgfGg1/b7ZwT9J3wwTomFDJ77klw3/Nd8itexbeK ehfXGk7xEKpMOTA0k598LijU5Rfs8bwtN771M/A==" } }
В следующем примере выплата была отклонена по причине недостатка средств на счёте.
Рис.: Пример оповещения об отказе в проведении выплаты
{ "project_id": 255, "payment": { "id": "mpesa_payout_1112243", "type": "payout", "status": "decline", "date": "2019-04-30T11:20:04+0000", "method": "mpesa", "sum": { "amount": 1000, "currency": "KES" }, "description": "test_payout" }, "account": { "number": "798365267" }, "customer": { "id": "22" }, "errors": [ { "code": "3028", "message": "Insufficient funds on merchant balance", "description": "public: BALANCE_INSUFFICIENT_FUNDS" } ], "operation": { "id": 32826000001677, "type": "payout", "status": "decline", "date": "2019-04-30T11:20:04+0000", "created_date": "2019-04-30T11:20:04+0000", "request_id": "db00b094f1969ed50285fce550fe2c269c2b2fb21972f9e54c1214", "sum_initial": { "amount": 1000, "currency": "KES" }, "sum_converted": { "amount": 1000, "currency": "KES" }, "provider": { "id": 1150, "payment_id": "" }, "code": "3028", "message": "Insufficient funds on merchant balance" }, "signature": "4d9g0vNsgfGg1/b7ZwT9J3wwTomFDJ77klw3/Nd8itexbeK ehfXGk7xEKpMOTA0k598LijU5Rfs8bwtN771M/A==" } }
Дополнительные материалы
Для организации работы с выплатами через Gate также могут быть полезны следующие материалы:
Анализ результатов проведения платежей
Как и при работе с другими платёжными методами, которые предоставляет ECommPay, при использовании метода M-Pesa доступны разные способы анализа информации о платежах и операциях с применением этого метода — как в отдельности, так и в совокупности с другими методами.
Всю необходимую информацию можно получать и анализировать средствами Dashboard (Old Dashboard), в том числе с помощью аналитических панелей на вкладке Analytics.
Также можно выгружать нужную информацию для последующего анализа с помощью специализированных аналитических средств сторонних разработчиков:
- Dashboard (Old Dashboard) позволяет выгружать данные в форматах CSV и XLS с помощью инструментов на вкладке Платежи. При этом можно выполнять разовые выгрузки информации на локальный компьютер и задействовать периодическую выгрузку и отправку информации на заданные адреса электронной почты.
- Data API позволяет получать информацию в формате JSON и отправлять ее на заданный URL — для этого применяются запросы /operations/get.
С любыми вопросами о возможностях анализа можно обращаться в службу технической поддержки ECommPay.