Papara

Обзор

Papara — платёжный метод поддерживающий проведение оплат и выплат через электронные кошельки. Оплаты реализованы через Payment Page и Gate, выплаты — через Gate.

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

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

Схема работы

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  1. Должен использоваться базовый минимум параметров — параметры, обязательные для любого платёжного метода:
    • project_id — идентификатор проекта, полученный от ECommPay при интеграции;
    • payment_id — идентификатор платежа, уникальный в рамках проекта;
    • payment_currency — валюта платежа в формате ISO-4217 alpha-3;
    • payment_amount — сумма платежа в минорных единицах.
  2. Дополнительно должны передаваться следующие данные пользователя, которые необходимо указать на Payment Page:
    • customer_id — идентификатор уникальный в рамках проекта;
    • customer_first_name — имя;
    • customer_last_name — фамилия;
    • customer_email — адрес электронной почты;
    • customer_country — в формате ISO 3166-1 alpha-2;
    • customer_day_of_birth — дата рождения в формате ДД-ММ-ГГГГ.
  3. Валютой платежа может быть только TRY.
  4. Для предварительного выбора метода Papara необходимо указывать код платёжного метода в параметре force_payment_methodpapara-wallet.
  5. Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page. Детальная информация обо всех параметрах приведена в разделе Параметры открытия платежной формы Payment Page.
  6. После определения всех параметров необходимо составить подпись. Подробная информация представлена в разделе Работа с подписью к данным.

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

project_id: '398',
      payment_id: '115',
      payment_currency: 'TRY',
      payment_amount: 10000,  
      customer_id: 'customer1',
      customer_first_name": "Mary",
      customer_last_name": "Smith",
      customer_email": "smith@example.com",
      customer_country": "TR",
      customer_day_of_birth": "12-12-1990",
      signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y1Y4HASCQ9vySO\
                         /RLCvhtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg=="

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

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

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

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

{
        "project_id": 398,
        "payment": {
            "id": "TEST_1560760354708",
            "type": "purchase",
            "status": "success",
            "date": "2019-06-17T08:56:47+0000",
            "method": "papara",
            "sum": {
                "amount": 10000,
                "currency": "TRY"
            },
            "description": ""
        },
        "operation": {
            "id": 29891000002814,
            "type": "sale",
            "status": "success",
            "date": "2019-06-17T08:56:47+0000",
            "created_date": "2019-06-17T08:50:34+0000",
            "request_id": "0d6aabd20c7925f1719b7cb63f728b32a3450cf0",
            "sum_initial": {
                "amount": 10000,
                "currency": "TRY"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "TRY"
            },
            "provider": {
                "id": 1288,
                "payment_id": "148947",
                "date": "2019-06-17T08:56:46+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "V0zYWk7OzwfcMBAJJxArOuQoQfNv92z0wBJeQIHwj75hpkuXFNqHjYGMdfhycMw=="
}

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

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

{
        "project_id": 398,
        "payment": {
            "id": "TEST_1560760354708",
            "type": "purchase",
            "status": "decline",
            "date": "2019-06-17T08:56:47+0000",
            "method": "papara",
            "sum": {
                "amount": 600000,
                "currency": "TRY"
            },
            "description": ""
        },
        "operation": {
            "id": 29891000002815,
            "type": "sale",
            "status": "decline",
            "date": "2019-06-17T08:56:47+0000",
            "created_date": "2019-06-17T08:50:34+0000",
            "request_id": "0d6aabd20c7925f1719b7cb63f728b32a3450cf0",
            "sum_initial": {
                "amount": 600000,
                "currency": "TRY"
            },
            "sum_converted": {
                "amount": 600000,
                "currency": "TRY"
            },
            "provider": {
                "id": 1288,
                "payment_id": "148948",
                "date": "2019-06-17T08:56:46+0000",
                "auth_code": ""
            },
            "code": "20705",
            "message": "Merchant account is blocked"
        },
        "signature": "V0zYWk7OzwfcMBAJJxArOuQoQfNv92z0wBJeQIHwj75hpkuXFNqHjYGMdfhycMw=="
}

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

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

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

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

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

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

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

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

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

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

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

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

  1. Должен использоваться запрос /v2/payment/wallet/papara/sale, отправляемый методом POST. Этот запрос относится к группе запросов на оплату с использованием электронных кошельков: /v2/payment/wallet/{payment_method}/sale.
  2. В запросе должны использоваться следующие объекты и параметры:
    • general — объект, содержащий основные идентификационные сведения запроса:
      • project_id — идентификатор проекта;
      • payment_id — идентификатор платежа;
      • signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
    • payment — объект, содержащий сведения о платеже:
      • amount — сумма платежа в минорных единицах;
      • currency — валюта платежа в формате ISO-4217 alpha-3;
    • customer — объект, содержащий сведения о пользователе:
      • id — идентификатор, уникальный в рамках проекта,
      • ip_address — используемый IP-адрес;
      • first_name — имя;
      • last_name — фамилия;
      • email — электронная почта;
      • country — страна в формате ISO 3166-1 alpha-2;
      • day_of_birth — дата рождения в формате ДД-ММ-ГГГГ;
    • return_url — объект, содержащий URL для перенаправления пользователя в веб-сервис:
      • success — после проведённого платежа;
      • decline — после отклонённого платежа.
  3. Валютой платежа может быть только TRY.
  4. Дополнительно могут использоваться любые другие параметры, указанные в спецификации.

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

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

{
  "general": {
    "project_id": 398,
    "payment_id": "115",
    "signature": "cMlzFj8zqZJbum1wysO3wE0qLdboEYQAteO62aewWX7xcG+Ttb0fhuenWNptFZg=="
  },
  "payment": {
    "amount": 10000,
    "currency": "TRY"
  },
  "customer": {
    "ip_address": "1.1.1.1",
    "first_name": "Mary",
    "last_name": "Smith",
    "email": "smith@example.com",
    "country": "TR",
    "day_of_birth": "12-12-1990",
    "id": "customer123"
  },
    "return_url": {
      "success": "http://example.com/success",
      "decline": "http://example.com/decline"
    }
}

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

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

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

"redirect_data" : {
			"body" : [],
			"method" : "GET",
			"url" : "https://checkout.bestpaycard.com/example"
		}

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

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

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

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

{
        "project_id": 398,
        "payment": {
            "id": "TEST_1560760354708",
            "type": "purchase",
            "status": "success",
            "date": "2019-06-17T08:56:47+0000",
            "method": "papara",
            "sum": {
                "amount": 10000,
                "currency": "TRY"
            },
            "description": ""
        },
        "operation": {
            "id": 29891000002814,
            "type": "sale",
            "status": "success",
            "date": "2019-06-17T08:56:47+0000",
            "created_date": "2019-06-17T08:50:34+0000",
            "request_id": "0d6aabd20c7925f1719b7cb63f728b32a3450cf0",
            "sum_initial": {
                "amount": 10000,
                "currency": "TRY"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "TRY"
            },
            "provider": {
                "id": 1288,
                "payment_id": "148947",
                "date": "2019-06-17T08:56:46+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "V0zYWk7OzwfcMBAJJxArOuQoQfNv92z0wBJeQIHwj75hpkuXFNqHjYGMdfhycMw=="
}

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

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

{
        "project_id": 398,
        "payment": {
            "id": "TEST_1560760354708",
            "type": "purchase",
            "status": "decline",
            "date": "2019-06-17T08:56:47+0000",
            "method": "papara",
            "sum": {
                "amount": 600000,
                "currency": "TRY"
            },
            "description": ""
        },
        "operation": {
            "id": 29891000002815,
            "type": "sale",
            "status": "decline",
            "date": "2019-06-17T08:56:47+0000",
            "created_date": "2019-06-17T08:50:34+0000",
            "request_id": "0d6aabd20c7925f1719b7cb63f728b32a3450cf0",
            "sum_initial": {
                "amount": 600000,
                "currency": "TRY"
            },
            "sum_converted": {
                "amount": 600000,
                "currency": "TRY"
            },
            "provider": {
                "id": 1288,
                "payment_id": "148948",
                "date": "2019-06-17T08:56:46+0000",
                "auth_code": ""
            },
            "code": "20705",
            "message": "Merchant account is blocked"
        },
        "signature": "V0zYWk7OzwfcMBAJJxArOuQoQfNv92z0wBJeQIHwj75hpkuXFNqHjYGMdfhycMw=="
}

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

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

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

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

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

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

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

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

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

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

  1. Должен использоваться запрос /v2/payment/wallet/papara/payout, отправляемый методом POST. Этот запрос относится к группе запросов на выплату с использованием электронных кошельков: /v2/payment/wallet/{payment_method}/payout.
  2. В запросе должны использоваться следующие объекты и параметры:
    • general — объект, содержащий основные идентификационные сведения запроса:
      • project_id — идентификатор проекта;
      • payment_id — идентификатор платежа;
      • signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
    • payment — объект, содержащий сведения о платеже:
      • amount — сумма платежа в минорных единицах;
      • currency — валюта платежа в формате ISO-4217 alpha-3;
    • customer — объект, содержащий сведения о пользователе:
      • ip_address — используемый IP-адрес;
      • first_name — имя;
      • last_name — фамилия;
      • email — электронная почта;
      • country — страна в формате ISO 3166-1 alpha-2;
    • account — объект, содержащий сведения о счёте пользователя;
      • number — номер счёта.
  3. Валютой платежа может быть только TRY.
  4. Дополнительно могут использоваться любые другие параметры, указанные в спецификации.

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

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

{
  "general": {
    "project_id": 398,
    "payment_id": "115",
    "signature": "cMlzFj8zqZJbum1wysO3wE0qLdboEYQAteO62aewWX7xcG+Ttb0fhuenWNptFZg=="
  },
  "payment": {
    "amount": 10000,
    "currency": "TRY"
  },
  "customer": {
    "ip_address": "1.1.1.1",
    "first_name": "Mary",
    "last_name": "Smith",
    "email": "smith@example.com",
    "country": "TR",
  },
    "account": {
      "number": "77755"
    }
}

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

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

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

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

{
        "project_id": 398,
        "payment": {
            "id": "TEST_1560760354708",
            "type": "payout",
            "status": "success",
            "date": "2019-06-17T08:56:47+0000",
            "method": "papara",
            "sum": {
                "amount": 10000,
                "currency": "TRY"
            },
            "description": ""
        },
        "operation": {
            "id": 29891000002814,
            "type": "payout",
            "status": "success",
            "date": "2019-06-17T08:56:47+0000",
            "created_date": "2019-06-17T08:50:34+0000",
            "request_id": "0d6aabd20c7925f1719b7cb63f728b32a3450cf0",
            "sum_initial": {
                "amount": 10000,
                "currency": "TRY"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "TRY"
            },
            "provider": {
                "id": 1288,
                "payment_id": "148947",
                "date": "2019-06-17T08:56:46+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "V0zYWk7OzwfcMBAJJxArOuQoQfNv92z0wBJeQIHwj75hpkuXFNqHjYGMdfhycMw=="
}

В следующем примере выплата была отклонена из-за нарушения ограничения на сумму.

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

{
        "project_id": 398,
        "payment": {
            "id": "TEST_1560760354708",
            "type": "payout",
            "status": "decline",
            "date": "2019-06-17T08:56:47+0000",
            "method": "papara",
            "sum": {
                "amount": 1400000,
                "currency": "TRY"
            },
            "description": ""
        },
        "operation": {
            "id": 29891000002815,
            "type": "payout",
            "status": "decline",
            "date": "2019-06-17T08:56:47+0000",
            "created_date": "2019-06-17T08:50:34+0000",
            "request_id": "0d6aabd20c7925f1719b7cb63f728b32a3450cf0",
            "sum_initial": {
                "amount": 1400000,
                "currency": "TRY"
            },
            "sum_converted": {
                "amount": 1400000,
                "currency": "TRY"
            },
            "provider": {
                "id": 1288,
                "payment_id": "148948",
                "date": "2019-06-17T08:56:46+0000",
                "auth_code": ""
            },
            "code": "20101",
            "message": "Decline due to amount or frequency limit"
        },
        "signature": "V0zYWk7OzwfcMBAJJxArOuQoQfNv92z0wBJeQIHwj75hpkuXFNqHjYGMdfhycMw=="
}

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

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

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

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

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

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

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

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