Maya (PayMaya) | Документация ECOMMPAY

Обзор

Введение

Maya (PayMaya) — метод, позволяющий проводить платежи в филиппинских песо с использованием электронного кошелька в Филиппинах. Для этого метода в платёжной платформе ecommpay поддерживаются оплаты и выплаты.

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

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

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

Схема работы

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

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

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

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

	Суммы, PHP ¹
	минимум	максимум
Оплаты	*	*
Выплаты	*	*

Прим.:

Информацию следует уточнять у курирующего менеджера ecommpay.

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

Проведение оплат с использованием метода Maya осуществляется с перенаправлением пользователей к сервису Maya, проведение выплат — с уведомлением пользователей через веб-сервис мерчанта.

Пользовательский сценарий оплаты через Payment Page выглядит следующим образом.

Рис.: Переход к оплате

Рис.: Выбор метода

Рис.: Аутентификация

Рис.: Подтверждение платежа

Рис.: Возвращение к форме

Рис.: Возвращение к веб-сервису

Общие сценарии проведения оплат и выплат можно представить следующим образом.

Рис.: Оплата через Payment Page

Рис.: Оплата через Gate

Рис.: Выплата через Gate

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

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

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

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

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

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

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

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

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

Должен использоваться базовый минимум параметров, обязательный для любого платежа:
- project_id — идентификатор проекта, полученный от ecommpay при интеграции;
- payment_id — идентификатор платежа, уникальный в рамках проекта;
- payment_currency — код валюты платежа в формате ISO-4217 alpha-3;
- payment_amount — сумма платежа в дробных единицах валюты;
- customer_id — идентификатор пользователя в рамках проекта.
Должен использоваться базовый минимум параметров: project_id, payment_id, payment_currency, payment_amount, customer_id.
Дополнительно, в зависимости от провайдера, участвующего в проведении платежа, может потребоваться указывать адрес электронной почты пользователя в параметре customer_email. Информацию следует уточнять у курирующего менеджера ecommpay.
Для предварительного выбора метода Maya необходимо указывать код этого метода в параметре force_payment_method — paymaya-wallet.
Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page (подробнее).
После указания всех целевых параметров необходимо составлять подпись (подробнее).

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

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 1000,
   "payment_currency": "PHP",
   "customer_id": "customer1", 
   "customer_email": "customer@example.com",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

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

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 1000,
   "payment_currency": "PHP",
   "customer_id": "customer1", 
   "customer_email": "customer@example.com",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

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

Для оповещений о результатах оплат с применением метода Maya используется типовой формат, описание которого представлено в статье Оповещения.

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

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

{
        "project_id": 445,
        "payment": {
            "id": "EP3bc1-5a65",
            "type": "purchase",
            "status": "success",
            "date": "2021-06-15T08:05:11+0000",
            "method": "PayMaya wallet",
            "sum": {
                "amount": 1000,
                "currency": "PHP"
            },
            "description": ""
        },
        "account": {
            "number": "1234"
        },
        "operation": {
            "id": 590,
            "type": "sale",
            "status": "success",
            "date": "2021-06-15T08:05:11+0000",
            "created_date": "2021-06-15T08:04:48+0000",
            "request_id": "c26a7ec94caf8fe7af3f280fd5e5c4-00000001",
            "sum_initial": {
                "amount": 1000,
                "currency": "PHP"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "PHP"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 1797,
                "payment_id": "RF6XIZSW",
                "auth_code": "",
                "endpoint_id": "PYMY",
                "date": "2020-02-13T08:31:32+0000"
            }
        },
        "signature": "wY/4RYA6R52eKohgMjdxRF9Z43Xixw27u38SGgXmq80Q=="
    }

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

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

 {
        "project_id": 239,
        "payment": {
            "id": "EPfa87-bcfc",
            "type": "purchase",
            "status": "decline",
            "date": "2020-03-07T14:11:00+0000",
            "method": "PayMaya wallet",
            "sum": {
                "amount": 200000000,
                "currency": "PHP"
            },
            "description": ""
        },
        "operation": {
            "id": 465,
            "type": "sale",
            "status": "decline",
            "date": "2020-03-07T14:11:00+0000",
            "created_date": "2020-03-06T14:10:34+0000",
            "request_id": "f6ab99eb0940e43a774b8ef08eec6c8951-00000002",
            "sum_initial": {
                "amount": 200000000,
                "currency": "PHP"
            },
            "sum_converted": {
                "amount": 200000000,
                "currency": "PHP"
            },
            "code": "20101",
            "message": "Decline due to amount or frequency limit",
            "provider": {
                "id": 1369,
                "payment_id": "7QKID3P3",
                "auth_code": "",
                "date": "2020-03-06T14:10:54+0000"
            }
        },
        "signature": "YZKXHr2ZdK3tPqiMzPpSJZ...+WGku5dANQAVWPteHKmwzMQ+mvGob=="
    }
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Таким образом, корректный запрос на оплату с применением метода Mayaдолжен содержать идентификатор проекта, базовые сведения о платеже (идентификатор, сумму и код валюты), идентификатор и арес электронной почты пользователя (если необходимо), URL для перенаправления, а также подпись.

{
    "general": {
        "project_id": 580,
        "payment_id": "test_paymaya_sale",
        "signature": "pgwRHcfv2OTsdILn33R5Nr/ymu08nMx/9FSeIqYHTTd6YhIiLWw=="
    },
    "payment": {
        "amount": 1000,
        "currency": "PHP"
    },
    "customer": {
        "email": "test_customer@example.com",
        "ip_address": "192.0.2.0",
        "id": "123"
    },
    "return_url": {
        "success": "http://example.com/success",
        "decline": "http://example.com/decline"
  }
}

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

{
    "general": {
        "project_id": 580,
        "payment_id": "test_paymaya_sale",
        "signature": "pgwRHcfv2OTsdILn33R5Nr/ymu08nMx/9FSeIqYHTTd6YhIiLWw=="
    },
    "payment": {
        "amount": 1000,
        "currency": "PHP"
    },
    "customer": {
        "email": "test_customer@example.com",
        "ip_address": "192.0.2.0",
        "id": "123"
    },
    "return_url": {
        "success": "http://example.com/success",
        "decline": "http://example.com/decline"
  }
}

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

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

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

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

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

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

Для оповещений о результатах оплат с применением метода Maya используется типовой формат, описание которого представлено в разделе Оповещения.

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

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

{
        "project_id": 445,
        "payment": {
            "id": "EP3bc1-5a65",
            "type": "purchase",
            "status": "success",
            "date": "2021-06-15T08:05:11+0000",
            "method": "PayMaya wallet",
            "sum": {
                "amount": 1000,
                "currency": "PHP"
            },
            "description": ""
        },
        "account": {
            "number": "1234"
        },
        "operation": {
            "id": 590,
            "type": "sale",
            "status": "success",
            "date": "2021-06-15T08:05:11+0000",
            "created_date": "2021-06-15T08:04:48+0000",
            "request_id": "c26a7ec94caf8fe7af3f280fd5e5c4-00000001",
            "sum_initial": {
                "amount": 1000,
                "currency": "PHP"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "PHP"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 1797,
                "payment_id": "RF6XIZSW",
                "auth_code": "",
                "endpoint_id": "PYMY",
                "date": "2020-02-13T08:31:32+0000"
            }
        },
        "signature": "wY/4RYA6R52eKohgMjdxRF9Z43Xixw27u38SGgXmq80Q=="
    }

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

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

 {
        "project_id": 239,
        "payment": {
            "id": "EPfa87-bcfc",
            "type": "purchase",
            "status": "decline",
            "date": "2020-03-07T14:11:00+0000",
            "method": "PayMaya wallet",
            "sum": {
                "amount": 200000000,
                "currency": "PHP"
            },
            "description": ""
        },
        "operation": {
            "id": 465,
            "type": "sale",
            "status": "decline",
            "date": "2020-03-07T14:11:00+0000",
            "created_date": "2020-03-06T14:10:34+0000",
            "request_id": "f6ab99eb0940e43a7a88ef08eec6c8951-00000002",
            "sum_initial": {
                "amount": 200000000,
                "currency": "PHP"
            },
            "sum_converted": {
                "amount": 200000000,
                "currency": "PHP"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 1369,
                "payment_id": "7QKID3P3",
                "auth_code": "",
                "date": "2020-03-06T14:10:54+0000"
            }
        },
        "signature": "YZKXHr2ZdK3tPqiMzPpSJZ...+WGku5dANQAVWPteHKmwzMQ+mvGob=="
    }
}

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

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

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

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

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

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

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

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

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

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

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

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

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

 {
 "general": {
   "project_id": 603,
   "payment_id": "1000003",
   "signature": "PJkV8ej/UG0Di8hTng6JvC7vQsaC6tajQVVLhNN5e7cV...=="
 },
 "customer": {
   "id": "111232323",
   "ip_address": "192.0.2.0"
 },
 "payment": {
   "amount": 1000,
   "currency": "PHP"
 },
 "account": {
   "number": "09123456789",
   "customer_name": "John Doe"
 }
}

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

 {
 "general": {
   "project_id": 603,
   "payment_id": "1000003",
   "signature": "PJkV8ej/UG0Di8hTng6JvC7vQsaC6tajQVVLhNN5e7cV...=="
 },
 "customer": {
   "id": "111232323",
   "ip_address": "192.0.2.0"
 },
 "payment": {
   "amount": 1000,
   "currency": "PHP"
 },
 "account": {
   "number": "09123456789",
   "customer_name": "John Doe"
 }
}

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

Для оповещений о результатах выплат с применением метода Maya используется типовой формат, описание которого представлено в разделе Оповещения.

В следующем примере оповещение свидетельствует о том, что в рамках проекта 445 была успешно проведена выплата в размере 10,00 PHP.

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

{
        "project_id": 445,
        "payment": {
            "id": "10615_110613_51729356",
            "type": "payout",
            "status": "success",
            "date": "2021-06-15T08:06:25+0000",
            "method": "PayMaya wallet",
            "sum": {
                "amount": 1000,
                "currency": "PHP"
            },
            "description": "payout"
        },
        "account": {
            "number": "123123"
        },
        "customer": {
            "id": "1234",
            "phone": "09123456789"
        },
        "operation": {
            "id": 592,
            "type": "payout",
            "status": "success",
            "date": "2021-06-15T08:06:25+0000",
            "created_date": "2021-06-15T08:06:14+0000",
            "request_id": "bdec3c53155f87d1f59c0e16043cf7c9a-00000001",
            "sum_initial": {
                "amount": 1000,
                "currency": "PHP"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "PHP"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 1994,
                "payment_id": "RS2PHYOBG5",
                "auth_code": "",
                "endpoint_id": "GRPY",
                "date": "2021-06-15T00:06:24+0000"
            }
        },
        "signature": "xndoWc28knuz24ZeVBdQadwSRXgPYIDqN/M3ZOEYI7A=="
    }

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

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

{
        "project_id": 445,
        "payment": {
            "id": "10615_110613_51729357",
            "type": "payout",
            "status": "decline",
            "date": "2021-06-15T08:07:25+0000",
            "method": "PayMaya wallet",
            "sum": {
                "amount": 1000,
                "currency": "PHP"
            },
            "description": "payout"
        },
        "account": {
            "number": "123123"
        },
        "customer": {
            "id": "1234",
            "phone": "09123456789"
        },
        "operation": {
            "id": 592,
            "type": "payout",
            "status": "decline",
            "date": "2021-06-15T08:06:25+0000",
            "created_date": "2021-06-15T08:06:14+0000",
            "request_id": "bdec3c53155f87d1f59c0e16043cf7c9a-00000002",
            "sum_initial": {
                "amount": 1000,
                "currency": "PHP"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "PHP"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 1994,
                "payment_id": "RS2PHYOBG6",
                "auth_code": "",
                "endpoint_id": "GRPY",
                "date": "2021-06-15T00:06:24+0000"
            }
        },
        "signature": "xndoWc28knuz24ZeVBdQadwSRXgPYIDqN/M3ZOEYI6A=="
    }

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

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

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

Выплаты через Dashboard

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

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

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

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

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

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

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

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