Paytm

Обзор

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

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

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

Схема работы

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

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

Интерфейсы Суммы, INR Время*
Payment Page CMS Plug-ins Gate Old Dashboard минимум максимум базовое предельное
Оплаты + + 1,00 9 999 999,99
Полные возвраты +
Частичные возвраты +

* Базовое и предельное время определяются следующим образом:

  • Базовое время — среднее расчётное время проведения платежа от момента его инициирования на стороне платёжной платформы до момента отправки инициатору оповещения о результате. Это время, определяемое для условий штатной работы всех технических средств и каналов связи, а также типичных действий со стороны пользователя (там, где они необходимы). Базовое время рекомендуется использовать для реагирования на отсутствие оповещений о результате платежа и выполнения опроса состояния платежа.
  • Предельное время — максимально допустимое время проведения платежа от момента его инициирования на стороне платёжной платформы до момента отправки инициатору оповещения о результате. Если платёж не был проведён или отклонён за это время, он автоматически переводится в статус decline. Для индивидуальной настройки предельного времени следует обращаться к специалистам технической поддержки ECommPay.

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

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

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



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



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



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

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

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

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



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

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

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

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

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

  1. Должен использоваться базовый минимум параметров — параметры, обязательные для любого платёжного метода:
    • project_id — идентификатор проекта, полученный от ECommPay при интеграции;
    • payment_id — идентификатор платежа, уникальный в рамках проекта;
    • payment_currency — валюта платежа в формате ISO-4217 alpha-3;
    • payment_amount — сумма платежа в минорных единицах.
    • customer_id — идентификатор пользователя в рамках проекта.
  2. Валютой платежа может быть только INR.
  3. Для предварительного выбора метода Paytm необходимо указывать код платёжного метода в параметре force_payment_methodpaytm-wallet.
  4. Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page. Детальная информация обо всех параметрах приведена в разделе Параметры открытия платежной формы Payment Page.
  5. После определения всех параметров необходимо составить подпись. Подробную информацию см. в разделе Работа с подписью к данным.

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

EPayWidget.run(
    { project_id: 198, 
      payment_id: '3936',
      payment_amount: 2500, 
      payment_currency: 'INR',      
      customer_id: 'customer1'
      signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y1Y4HASCQ9vySODJr...=="
    }
)

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

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

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

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

   {
        "project_id": 200,
        "payment": {
            "id": "TEST_Ref1215267492448813313",
            "type": "purchase",
            "status": "success",
            "date": "2019-09-03T10:58:10+0000",
            "method": "Paytm Wallet",
            "sum": {
                "amount": 2500,
                "currency": "INR"
            },
            "description": "TEST_Ref1215267492448813313"
        },
        "customer": {
            "id": "12345",    
            "phone": "31647812345"
        },
        "operation": {
            "id": 49572000001893,
            "type": "sale",
            "status": "success",
            "date": "2019-09-03T10:58:10+0000",
            "created_date": "2019-09-03T09:43:12+0000",
            "request_id": "d2debda97843c0c",
            "sum_initial": {
                "amount": 2500,
                "currency": "INR"
            },
            "sum_converted": {
                "amount": 2500,
                "currency": "INR"
            },
            "provider": {
                "id": 2469,
                "payment_id": "fcccab5d465e",
                "date": "2019-09-03T09:43:50+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "KsbudtqaOTFGb+ZXwrbhzGeMTSuNsAX1+3YOdDt32jvfh9NDU/MiK94...=="
    }

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

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

 {
        "project_id": 200,
        "payment": {
            "id": "TEST_1567592437",
            "type": "purchase",
            "status": "decline",
            "date": "2019-09-06T07:41:03+0000",
            "method": "Paytm Wallet",
            "sum": {
                "amount": 2500,
                "currency": "INR"
            },
            "description": "TEST_156759437"
        },
        "customer": {
            "id": "12345",
            "phone": "31647812345"
        },
        "operation": {
            "id": 48853000002113,
            "type": "sale",
            "status": "decline",
            "date": "2019-09-06T07:41:03+0000",
            "created_date": "2019-09-06T07:25:26+0000",
            "request_id": "60a7b84844677185e",
            "sum_initial": {
                "amount": 2500,
                "currency": "INR"
            },
            "sum_converted": {
                "amount": 2500,
                "currency": "INR"
            },
            "provider": {
                "id": 2469,
                "payment_id": ""
            },
            "code": "603",
            "message": "Auto decline"
        },
        "signature": "fsSFeOQTuMoMwRDptS21wQuWHUoxDWr/0Y2veJcIJBHpg7lIjl7...=="
    }

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

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

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

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

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

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

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



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

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

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

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

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

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

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

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

{
    "general": {
        "project_id": 200,
        "payment_id": "payment_id",
        "signature": "PJkV8ej\/UG0Di8NN5e7cV+VHq3LwY3T\/pOMeSaRfBaNIip...=="
    },
    "customer": {
      "id": "12345",
      "ip_address": "1.1.1.1"
    },
    "payment": {
      "amount": 250,
      "currency": "INR"
    }
}

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

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

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

 "redirect_data": {
                    "body": [],
                    "method": "GET",
                    "url": "https://pay.com/collect/pay/M-ce2f-11e9-9f3e-9f869464802f?xtid=CATH-ST"
                }

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

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

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

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

   {
        "project_id": 200,
        "payment": {
            "id": "TEST_Ref1215267492448813313",
            "type": "purchase",
            "status": "success",
            "date": "2019-09-03T10:58:10+0000",
            "method": "Paytm Wallet",
            "sum": {
                "amount": 2500,
                "currency": "INR"
            },
            "description": "TEST_Ref1215267492448813313"
        },
        "customer": {
            "id": "12345",    
            "phone": "31647812345"
        },
        "operation": {
            "id": 49572000001893,
            "type": "sale",
            "status": "success",
            "date": "2019-09-03T10:58:10+0000",
            "created_date": "2019-09-03T09:43:12+0000",
            "request_id": "d2debda97843c0c",
            "sum_initial": {
                "amount": 2500,
                "currency": "INR"
            },
            "sum_converted": {
                "amount": 2500,
                "currency": "INR"
            },
            "provider": {
                "id": 2469,
                "payment_id": "fcccab5d465e",
                "date": "2019-09-03T09:43:50+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "KsbudtqaOTFGb+ZXwrbhzGeMTSuNsAX1+3YOdDt32jvfh9NDU/MiK94...=="
    }

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

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

 {
        "project_id": 200,
        "payment": {
            "id": "TEST_1567592437",
            "type": "purchase",
            "status": "decline",
            "date": "2019-09-06T07:41:03+0000",
            "method": "Paytm Wallet",
            "sum": {
                "amount": 2500,
                "currency": "INR"
            },
            "description": "TEST_156759437"
        },
        "customer": {
            "id": "12345",
            "phone": "31647812345"
        },
        "operation": {
            "id": 48853000002113,
            "type": "sale",
            "status": "decline",
            "date": "2019-09-06T07:41:03+0000",
            "created_date": "2019-09-06T07:25:26+0000",
            "request_id": "60a7b84844677185e",
            "sum_initial": {
                "amount": 2500,
                "currency": "INR"
            },
            "sum_converted": {
                "amount": 2500,
                "currency": "INR"
            },
            "provider": {
                "id": 2469,
                "payment_id": ""
            },
            "code": "603",
            "message": "Auto decline"
        },
        "signature": "fsSFeOQTuMoMwRDptS21wQuWHUoxDWr/0Y2veJcIJBHpg7lIjl7...=="
    }

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

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

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

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

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



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

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

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

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

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

  1. Должен использоваться запрос /v2/payment/wallet/paytm/refund, отправляемый методом POST. Этот запрос относится к группе запросов на проведение платежей с помощью электронных кошельков /v2/payment/wallet/{payment_method}/refund.
  2. В запросе должны использоваться следующие объекты и параметры:
    • general — объект, содержащий основные идентификационные сведения запроса:
      • project_id — идентификатор проекта, полученный от ECommPay при интеграции;
      • payment_id — идентификатор платежа, уникальный в рамках проекта;
      • signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Работа с подписью к данным);
    • payment — объект, содержащий сведения о возврате:
      • description — комментарий или описание возврата.
      • amount — сумма возврата в минорных единицах валюты (обязательный при частичном возврате),
      • currency — валюта возврата в формате ISO-4217 alpha-3 (обязательный при частичном возврате).
  3. Дополнительно могут использоваться все параметры, указанные в спецификации.

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

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

{
  "general": {
    "project_id": 200,
    "payment_id": "TEST_1572258898441234343232",
    "signature": "NUpXRpdrU/rRcwEa/jQYoYbXA/YIc/dgeuncPmD/BJZGZvt59GbTSAUKHI/WrQ=="
  },
  "payment": {
    "description":"test_refund"
  }

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

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

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

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

{
        "project_id": 200,
        "payment": {
            "id": "TEST_554862",
            "type": "purchase",
            "status": "refunded",
            "date": "2020-09-09T10:02:18+0000",
            "method": "Paytm Wallet",
            "sum": {
                "amount": 35000,
                "currency": "INR"
            },
            "merchant_refund_id": "TEST_554862",
            "description": "TEST_554862"
        },
        "customer": {
            "id": "123456",
            "phone": "1234567890"
        },
        "operation": {
            "id": 90266010010271,
            "type": "refund",
            "status": "success",
            "date": "2020-09-09T10:02:18+0000",
            "created_date": "2020-09-09T09:46:14+0000",
            "request_id": "6b77b588d77d5c27be31be7b72bf9adf...b1c85eda238b73cac-00090267",
            "sum_initial": {
                "amount": 35000,
                "currency": "INR"
            },
            "sum_converted": {
                "amount": 35000,
                "currency": "INR"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 2469,
                "payment_id": "4952688",
                "auth_code": ""
            }
        },
        "signature": "WUZUy26FHZglsro9PYFr89suJAciQ...5Fev4NtHl56VGTgX9m/g=="
    }

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

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

{
        "project_id": 200,
        "payment": {
            "id": "TEST_554863",
            "type": "purchase",
            "status": "success",
            "date": "2020-09-09T10:02:18+0000",
            "method": "Paytm Wallet",
            "sum": {
                "amount": 35000,
                "currency": "INR"
            },
            "merchant_refund_id": "TEST_554863",
            "description": "TEST_554863"
        },
        "customer": {
            "id": "12345",
            "phone": "1234567890"
        },
        "operation": {
            "id": 90266010010272,
            "type": "refund",
            "status": "decline",
            "date": "2020-09-09T10:02:18+0000",
            "created_date": "2020-09-09T09:46:14+0000",
            "request_id": "6b77b588d77d5c27be31be7b72bf9adf...b1c85eda238b73cac-00090268",
            "sum_initial": {
                "amount": 35000,
                "currency": "INR"
            },
            "sum_converted": {
                "amount": 35000,
                "currency": "INR"
            },
            "code": "3283",
            "message": "Refund amount more than init amount"
            }
        },
        "signature": "WUZUy26FHZglsro9PYFr89suJAciQ...5Fev4NtHl56VGTgX9m/g=="
    }

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

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

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

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

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

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

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

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