«Платежи с использованием карт через партнёра (в разных странах)»

Обзор

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

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

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

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

Схема работы

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



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

Интерфейсы Суммы, KES Суммы, USD
Payment Page CMS Plug-ins Gate Dashboard минимум максимум минимум максимум
Оплаты + – + – 10,00 200 000,00 1,00 3 000,00
Полные возвраты – – + – – – – –

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

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

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



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



Рис.: Возврат через Gate



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

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

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

Для оплаты через Payment Page с использованием метода партнёра со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ECommPay и принять оповещение о результате оплаты. При этом метод партнёра можно сделать предварительно выбранным (подробнее — в разделе Предварительный выбор платёжных методов). Полная схема проведения оплаты представлена далее.



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

  1. Пользователь на стороне веб-сервиса инициирует оплату.
  2. От веб-сервиса на заданный URL ECommPay передаётся запрос на проведение оплаты через Payment Page.
  3. Запрос на проведение оплаты поступает в платёжную платформу.
  4. Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
  5. Осуществляется генерация Payment Page согласно настройкам проекта и параметрам вызова.
  6. Пользователю отображается сгенерированная платёжная форма.
  7. Пользователь выбирает для оплаты платёжный метод.
  8. Запрос на проведение оплаты поступает в платёжную платформу.
  9. Выполняется дальнейшая обработка запроса.
  10. Данные для перенаправления пользователя передаются к Payment Page.
  11. Пользователь перенаправляется в сервис партнёра.
  12. Пользователь выполняет необходимые действия для оплаты.
  13. На стороне сервиса партнёра выполняется обработка платежа.
  14. Результат оплаты отображается пользователю в сервисе партнёра.
  15. Пользователь перенаправляется к Payment Page.
  16. От сервиса партнёра к платёжной платформе направляется результат оплаты.
  17. От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
  18. От платёжной платформы к Payment Page направляется результат проведения оплаты.
  19. Результат оплаты отображается пользователю на Payment Page.

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

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

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

  1. Должен использоваться базовый минимум параметров — параметры, обязательные для любого платёжного метода:
    • project_id — идентификатор проекта, полученный от ECommPay при интеграции;
    • payment_id — идентификатор платежа, уникальный в рамках проекта;
    • payment_currency — валюта платежа в формате ISO-4217 alpha-3;
    • payment_amount — сумма платежа в минорных единицах;
    • customer_id — идентификатор пользователя уникальный в рамках проекта.
  2. Дополнительно рекомендуется указывать номер телефона и адрес электронной почты пользователя в параметрах customer_phone и customer_email. Если параметры отсутствуют в запросе, на Payment Page пользователю отображаются поля для ввода недостающих значений. Подробнее об уточнении параметров — в разделе Дополнение информации о платежах.
  3. Валютой платежа может быть только KES или USD.
  4. Для предварительного выбора метода необходимо указывать код платёжного метода в параметре force_payment_method — card-partner.
  5. Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page. Детальная информация обо всех параметрах приведена в разделе Параметры открытия платежной формы Payment Page.
  6. После определения всех параметров необходимо составить подпись. Подробную информацию см. в Работа с подписью к данным.

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

    { payment_id: 'X03936', 
      payment_amount: 10000, 
      payment_currency: 'KES', 
      project_id: 250, 
      customer_id: 'customer1',
      customer_phone: '123456789',
      customer_email: 'customer@example.com',
      signature: "kUi2x9dKHAVNU0FYldJrxh4yoASCQ9vyS...wX6R\/ekpZhkIQg=="
    }

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

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

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

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

{
        "project_id": 2924,
        "payment": {
            "id": "EP79a6-d2db",
            "type": "purchase",
            "status": "success",
            "date": "2020-08-26T15:03:20+0000",
            "method": "Card partner",
            "sum": {
                "amount": 1000,
                "currency": "KES"
            },
            "description": ""
        },
        "customer": {
            "phone": "12345678900"
        },
        "operation": {
            "id": 389,
            "type": "sale",
            "status": "success",
            "date": "2020-08-26T15:03:19+0000",
            "created_date": "2020-08-26T15:03:05+0000",
            "request_id": "0be9d6d54056a9dd9d99fd1c...95768e7c5eb5d-00000001",
            "sum_initial": {
                "amount": 1000,
                "currency": "KES"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "KES"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 2377,
                "payment_id": "1598454195644A",
                "auth_code": ""
            }
        },
        "signature": "pwg+4nslNir5KFxiokPtOX6M...nDfcqf4nvNRWahe6L4qzT9Q=="
    }

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

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

{
        "project_id": 2924,
        "payment": {
            "id": "EPee51-5d3f",
            "type": "purchase",
            "status": "decline",
            "date": "2020-08-26T15:15:39+0000",
            "method": "Card partner",
            "sum": {
                "amount": 11300,
                "currency": "KES"
            },
            "description": ""
        },
        "customer": {
            "phone": "12345678900"
        },
        "operation": {
            "id": 390,
            "type": "sale",
            "status": "decline",
            "date": "2020-08-26T15:15:39+0000",
            "created_date": "2020-08-26T15:15:24+0000",
            "request_id": "b49045c4fce49592b1ef5...4801c2566c9404ed5-00000001",
            "sum_initial": {
                "amount": 11300,
                "currency": "KES"
            },
            "sum_converted": {
                "amount": 11300,
                "currency": "KES"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 2377,
                "payment_id": "1598454934830A",
                "auth_code": ""
            }
        },
        "signature": "2vi4mi6gY/r+EI4z+6fBPd0d...EjR/tohNOjjhOm5ex5z/hA=="
    }

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

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

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

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

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

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

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



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

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

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

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

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

  1. Должен использоваться запрос v2/payment/card-partner/sale, отправляемый методом POST.
  2. В запросе должны использоваться следующие объекты и параметры:
    • general — объект, содержащий основные идентификационные сведения запроса:
      • project_id — идентификатор проекта, полученный от ECommPay при интеграции;
      • payment_id — идентификатор платежа, уникальный в рамках проекта;
      • signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
    • customer — объект, содержащий сведения о пользователе:
      • id — идентификатор, уникальный в рамках проекта,
      • ip_address — IP-адрес пользователя;
    • payment — объект, содержащий сведения о платеже:
      • amount — сумма платежа в минорных единицах валюты,
      • currency — валюта платежа в формате ISO-4217 alpha-3.
  3. Дополнительно рекомендуется указывать имя и адрес электронной почты пользователя. Если параметры отсутствуют в запросе, список недостающих параметров отправляется в оповещении на уточнение. Подробнее об уточнении параметров — в разделе Дополнение информации о платеже.

    Рекомендуется использовать следующие объекты и параметры:

    • customer — объект, содержащий сведения о пользователе:
      • phone — номер телефона,
      • email — адрес электронной почты.
  4. Валютой платежа может быть только KES или USD.
  5. Дополнительно могут использоваться все параметры, указанные в спецификации.

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

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

{
    "general": {
    "project_id": 125,
    "payment_id": "TEST_184",
    "signature": "PJkV8ej\/UG0Di8hTng6JvC7vQsaC6tajQVVL...8yJA=="
  },
  "customer": {
    "ip_address": "1.2.3.4",
    "phone": "123456789",
    "email": "customer@example.com",
    "id": "123"
    },
  "payment": {
    "amount": 1000,
    "currency": "KES"
  }
}

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

Для перенаправления пользователя от веб-сервиса на сайт сервиса партнёра необходимо принять оповещение от платёжной платформы, содержащее ссылку для перенаправления в параметре redirect_data.url и данные для отправки в теле запроса redirect_data.body, и использовать эти параметры при открытии HTML-страницы сайта методом, указанным в redirect_data.method.

Далее приведён фрагмент оповещения, содержащего данные для перенаправления.

    "redirect_data": {
        "body": {
            "live": "0",
            "mpesa": "0",
            "bonga": "0",
            "airtel": "0",
            "equity": "0",
            "mobilebanking": "0",
            "debitcard": "0",
            "mkoporahisi": "0",
            "saida": "0",
            "elipa": "0",
            "oid": "112",
            "inv": "112020102292999",
            "ttl": "900",
            "tel": "256712375678",
            "eml": "example@example.com",
            "vid": "demo",
            "curr": "KES",
            "cbk": "https://url_for Calback",
            "lbk": "https://url-if-Error",
            "cst": "1",
            "crl": "0",
            "hsh": "sdfsdfasfdart34tfc254ty345t3f45t435f43gt"
        },
        "method": "POST",
        "url": "https://payments.example.com/v3/ke"
    }

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

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

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

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

{
        "project_id": 2924,
        "payment": {
            "id": "EP79a6-d2db",
            "type": "purchase",
            "status": "success",
            "date": "2020-08-26T15:03:20+0000",
            "method": "Card partner",
            "sum": {
                "amount": 1000,
                "currency": "KES"
            },
            "description": ""
        },
        "customer": {
            "phone": "12345678900"
        },
        "operation": {
            "id": 389,
            "type": "sale",
            "status": "success",
            "date": "2020-08-26T15:03:19+0000",
            "created_date": "2020-08-26T15:03:05+0000",
            "request_id": "0be9d6d54056a9dd9d99fd1c...95768e7c5eb5d-00000001",
            "sum_initial": {
                "amount": 1000,
                "currency": "KES"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "KES"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 2377,
                "payment_id": "1598454195644A",
                "auth_code": ""
            }
        },
        "signature": "pwg+4nslNir5KFxiokPtOX6M...nDfcqf4nvNRWahe6L4qzT9Q=="
    }

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

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

{
        "project_id": 2924,
        "payment": {
            "id": "EPee51-5d3f",
            "type": "purchase",
            "status": "decline",
            "date": "2020-08-26T15:15:39+0000",
            "method": "Card partner",
            "sum": {
                "amount": 11300,
                "currency": "KES"
            },
            "description": ""
        },
        "customer": {
            "phone": "12345678900"
        },
        "operation": {
            "id": 390,
            "type": "sale",
            "status": "decline",
            "date": "2020-08-26T15:15:39+0000",
            "created_date": "2020-08-26T15:15:24+0000",
            "request_id": "b49045c4fce49592b1ef5...4801c2566c9404ed5-00000001",
            "sum_initial": {
                "amount": 11300,
                "currency": "KES"
            },
            "sum_converted": {
                "amount": 11300,
                "currency": "KES"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 2377,
                "payment_id": "1598454934830A",
                "auth_code": ""
            }
        },
        "signature": "2vi4mi6gY/r+EI4z+6fBPd0d...EjR/tohNOjjhOm5ex5z/hA=="
    }

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

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

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

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

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



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

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

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

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

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

  1. Должен использоваться запрос v2/payment/card-partner/refund, отправляемый методом POST.
  2. В запросе должны использоваться следующие объекты и параметры:
    • general — объект, содержащий основные идентификационные сведения о запросе:
      • project_id — идентификатор проекта;
      • payment_id — идентификатор платежа;
      • signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
  3. Дополнительно могут использоваться все параметры, указанные в спецификации.

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

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

{  
  "general": {    
    "project_id": 239,    
    "payment_id": "refund_02",   
    "signature": "of8k9xerKSK4XL1QFaDH3p9Mh...SwKJ7KLTZYO56lCv+f1M0Sf/7eg=="
 }
}

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

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

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

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

{
        "project_id": 2924,
        "payment": {
            "id": "EP79a6-d2db",
            "type": "purchase",
            "status": "refunded",
            "date": "2020-08-26T15:32:50+0000",
            "method": "Card partner",
            "sum": {
                "amount": 0,
                "currency": "KES"
            },
            "description": ""
        },
        "customer": {
            "phone": "64647626828"
        },
        "operation": {
            "id": 391,
            "type": "refund",
            "status": "success",
            "date": "2020-08-26T15:32:50+0000",
            "created_date": "2020-08-26T15:32:47+0000",
            "request_id": "f62983a57ccb816598c012...7c990f66c1db9905-00000001",
            "sum_initial": {
                "amount": 1000,
                "currency": "KES"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "KES"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 2377,
                "payment_id": "1598455969395",
                "auth_code": ""
            }
        },
        "signature": "T21fEFhc7a0NTi9IqTaTYssHrj8b...jIoWnPqamuEmxvxWiJ9g=="
    }
}

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

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

{
        "project_id": 2924,
        "payment": {
            "id": "EPacf3-b6d0",
            "type": "purchase",
            "status": "success",
            "date": "2020-08-27T08:24:54+0000",
            "method": "Card partner",
            "sum": {
                "amount": 61900,
                "currency": "KES"
            },
            "description": ""
        },
        "customer": {
            "phone": "4534343543"
        },
        "operation": {
            "id": 398,
            "type": "refund",
            "status": "decline",
            "date": "2020-08-27T08:24:54+0000",
            "created_date": "2020-08-27T08:24:51+0000",
            "request_id": "7cbdf5fad13c7f6a92...379b3ca7c2f78fb11de-00000001",
            "sum_initial": {
                "amount": 61900,
                "currency": "KES"
            },
            "sum_converted": {
                "amount": 61900,
                "currency": "KES"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 2377,
                "payment_id": "1598516693232RF",
                "auth_code": ""
            }
        },
        "signature": "hzDDj7hxql8FwbWUCCpiGxCh0LQsas...iw4cK4m+zZk4uGa9A=="
    }
}

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

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

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

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

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

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

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

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