eCashout

Обзор

eCashout — канадский платежный метод, который поддерживает проведение выплат с помощью банковских переводов. Проведение выплат реализовано через Gate и Dashboard (Old Dashboard).

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

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

Схема работы

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



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

Интерфейсы Суммы, CAD
Payment Page CMS Plug-ins Gate Dashboard (Old Dashboard) минимум максимум
Выплаты + + 10 000,00

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

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

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



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

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

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

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



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

  1. От веб-сервиса на заданный URL ECommPay передаётся запрос на проведение выплаты через Gate.
  2. Запрос на проведение выплаты поступает в платёжную платформу.
  3. Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
  4. От платёжной платформы к веб-сервису направляется ответ с информацией о получении запроса и его корректности. Подробнее см. в разделе Формат ответа.
  5. В платёжной платформе выполняются дальнейшая обработка запроса и его отправка в сервис eCashout.
  6. На стороне eCashout выполняется обработка платежа.
  7. От сервиса eCashout к платёжной платформе направляется уведомление о результате выплаты.
  8. От платёжной платформы к веб-сервису направляется оповещение о результате выплаты.
  9. От веб-сервиса пользователю направляется результат выплаты.

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

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

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

  1. Должен использоваться запрос к конечной точке v2/payment/bank-transfer/interac/payout, отправляемый методом POST. Этот запрос относится к группе запросов для проведения платежей с помощью банковских переводов /v2/payment/bank-transfer/{payment_method}/payout.
  2. В запросе должны использоваться следующие объекты и параметры:
    • general — основные сведения:
      • project_id — идентификатор проекта,
      • payment_id — идентификатор платежа,
      • signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным;
    • customer — сведения о пользователе:
      • id — идентификатор в проекте,
      • ip_address — используемый IP-адрес,
      • first_name — имя пользователя,
      • last_name — фамилия пользователя,
      • email — электронный адрес пользователя,
      • phone — номер телефона;
    • payment — сведения о платеже:
      • amount — сумма,
      • currency — валюта;
    • account — сведения о счёте пользователя:
      • number — личный номер счёта (требуемое название поля для ввода значения на стороне провайдера — Account Number),
      • fin — номер финансового учреждения (требуемое название поля для ввода значения на стороне провайдера — Financial Institution Number),
      • iban — транзитный (филиальный) номер банковского счёта (требуемое название поля для ввода значения на стороне провайдера — Transit or Branch).
  3. Валютой платежа может быть только CAD.
  4. Дополнительно могут использоваться все параметры, указанные в спецификации.

Таким образом, корректный запрос на выплату с применением метода eCashout должен содержать идентификаторы проекта и платежа, данные пользователя и счёта, валюту и сумму платежа:

Рис.: Пример запроса на выплату

 {
  "general": {
    "project_id": 3027,
    "payment_id": "Payout 12",
    "signature": "M1vT4q9c8hA8xCjEwGFSANwbxHS+9XAaq7vt3/Jkn+aJmGA4...=="
  },
   "customer": {
     "id": "customer_u",
     "ip_address": "1.1.1.1",
     "first_name": "John",
     "last_name": "Johnson",      
     "email": "johnson@mail.com",  
     "phone": "16132354341"
  },
   "account": {    
     "number": "1234567",
     "fin": "111",
     "iban": "12345"
  },
  "payment": {
     "amount": 10000,
     "currency": "CAD"
  }
}

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

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

В данном случае оповещение свидетельствует о том, что в рамках проекта 763 для пользователя customer_u была успешно проведена выплата в размере 100,00 CAD.

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

{
{
        "project_id": 763,
        "payment": {
            "id": "577",
            "type": "payout",
            "status": "success",
            "date": "2019-04-23T11:21:33+0000",
            "method": "BankTransferViaInterac",
            "sum": {
                "amount": 10000,
                "currency": "CAD"
            },
            "description": ""
        },
        "account": {
            "number": "1234567"
        },
        "customer": {
            "id": "customer_u"
        },
        "operation": {
            "id": 1000000063,
            "type": "payout",
            "status": "success",
            "date": "2019-04-23T11:21:33+0000",
            "created_date": "2019-04-23T11:21:25+0000",
            "request_id": "96eb9ba72a2131a22a705c5b27e9",
            "sum_initial": {
                "amount": 10000,
                "currency": "CAD"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "CAD"
            },
            "provider": {
                "id": 1393,
                "payment_id": "",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"    
        },
        "signature": "eF5LBsZWb4tuAGXDih1H0l67WdzIB1gm88z7M0z4zWxNOg=="
        }
}

В этом примере выплата была отклонена.

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

{
{
        "project_id": 763,
        "payment": {
            "id": "577",
            "type": "payout",
            "status": "decline",
            "date": "2019-04-23T11:21:33+0000",
            "method": "BankTransferViaInterac",
            "sum": {
                "amount": 100000,
                "currency": "CAD"
            },
            "description": ""
        },
        "account": {
            "number": "1234567"
        },
        "customer": {
            "id": "customer_u"
        },
        "operation": {
            "id": 1000000063,
            "type": "payout",
            "status": "decline",
            "date": "2019-04-23T11:21:33+0000",
            "created_date": "2019-04-23T11:21:25+0000",
            "request_id": "96eb9ba72a2131a22a705c5b27e9",
            "sum_initial": {
                "amount": 100000,
                "currency": "CAD"
            },
            "sum_converted": {
                "amount": 100000,
                "currency": "CAD"
            },
            "provider": {
                "id": 1393,
                "payment_id": "",
                "auth_code": ""
            },
            "code": "100",
            "message": "General decline"
            },
        "signature": "eF5LBsZWb4tuAGXDih1H0akYdzIB1gm88z7M0z4zWxNOg=="
        }
}

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

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

Выплаты через Dashboard (Old Dashboard)

Для проведения выплат через Dashboard (Old Dashboard) со стороны мерчанта необходимо инициировать запросы на выплаты и принять уведомления об их успешной обработке. Инициировать такие выплаты можно двумя способами:
  • как единичную выплату — в этом случае для каждой выплаты необходимо указать доступные для данного метода валюту и сумму, выбрать метод и заполнить все поля, отображаемые в интерфейсе с учётом выбранного метода;
  • в рамках массового платежа — в этом случае все параметры выплат необходимо задать в файле формата CSV с учётом требований, представленных в разделе Выплаты через Gate (кроме пункта о подписи).

Информация о проведении выплат отображается в разделах Платежи и Мануальные платежи интерфейса Dashboard (Old Dashboard).

Более подробная информация о проведении выплат через Dashboard (Old Dashboard) представлена в разделе Проведение выплат.

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

Как и при работе с другими платёжными методами, которые предоставляет ECommPay, при использовании метода eCashout доступны разные способы анализа информации о платежах и операциях с применением этого метода — как в отдельности, так и в совокупности с другими методами.

Всю необходимую информацию можно получать и анализировать средствами Dashboard, в том числе с помощью аналитических панелей на вкладке Analytics.

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

  • Dashboard позволяет выгружать данные в форматах CSV и XLS с помощью инструментов на вкладке Платежи. При этом можно выполнять разовые выгрузки информации на локальный компьютер и задействовать периодическую выгрузку и отправку информации на заданные адреса электронной почты.
  • Data API позволяет получать информацию в формате JSON и отправлять ее на заданный URL — для этого применяются запросы /operations/get.

С любыми вопросами о возможностях анализа можно обращаться в службу технической поддержки ECommPay.