Airtel

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

Схема работы

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

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

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

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

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

Проведение оплат с использованием метода Airtel выполняется с перенаправлением пользователей к сервису провайдера.

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

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

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

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

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

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

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

1. Должен использоваться базовый минимум параметров — параметры, обязательные для любого платёжного метода:
   • project_id — идентификатор проекта, полученный от ECommPay при интеграции;
   • payment_id — идентификатор платежа, уникальный в рамках проекта;
   • payment_currency — валюта платежа в формате ISO-4217 alpha-3;
   • payment_amount — сумма платежа в минорных единицах.
   • customer_id — идентификатор пользователя в рамках проекта.
2. Дополнительно должны использоваться параметры с данными пользователя:
   • customer_email — адрес электронной почты,
   • customer_phone — город проживания,

   Если параметры не переданы в запросе на открытие, то данные запрашиваются у пользователя на Payment Page.

3. Валютой платежа может быть только INR.
4. Для предварительного выбора метода Airtel необходимо указывать код платёжного метода в параметре force_payment_method — airtel-wallet.
5. Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page. Детальная информация обо всех параметрах приведена в разделе Параметры открытия платежной формы Payment Page.
6. После определения всех параметров необходимо составить подпись. Подробную информацию см. в разделе Работа с подписью к данным.

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

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

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

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

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

   {
        "project_id": 200,
        "payment": {
            "id": "TEST_Ref1215267492448813313",
            "type": "purchase",
            "status": "success",
            "date": "2019-09-03T10:58:10+0000",
            "method": "airtel-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": "airtel-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 с использованием метода Airtel со стороны веб-сервиса необходимо:

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

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

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

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

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

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

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

{
    "general": {
        "project_id": 200,
        "payment_id": "payment_id",
        "signature": "PJkV8ej\/UG0Di8NN5e7cV+VHq3LwY3T\/pOMeSaRfBaNIip...=="
    },
    "customer": {
      "id": "12345",
      "ip_address": "1.1.1.1",
      "email": "Johnson@mail.com",
      "phone": "312567890"
    },
    "payment": {
      "amount": 250,
      "currency": "USD"
    },
    "return_url": {
        "return": "http://merchant.com/returnurl.asp"
    }
}

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

Для перенаправления пользователя от веб-сервиса в сервис Airtel необходимо принять оповещение от платёжной платформы, содержащее ссылку для перенаправления в параметре 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"
                }

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

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

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

   {
        "project_id": 200,
        "payment": {
            "id": "TEST_Ref1215267492448813313",
            "type": "purchase",
            "status": "success",
            "date": "2019-09-03T10:58:10+0000",
            "method": "airtel-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": "airtel-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 также могут быть полезны следующие материалы:

• Организация взаимодействия
• Работа с подписью к данным
• Модель проведения платежей
• Информация о выполнении операций

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

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

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

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

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