ATF24

Обзор

ATF24 — метод интернет-банкинга для проведения платежей между банковскими счетами. Для работы с этим методом доступно проведение оплат через Payment Page и Gate.

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

Тип платёжного метода Интернет-банкинг
Регионы использования Казахстан
Валюты платежей EUR, KZT, RUB, USD
Конвертация валют На стороне ECommPay
Оплаты +
Выплаты
Оплаты по сохранённым данным
Полные возвраты
Частичные возвраты
Опротестования
Особенности Оплата со стороны пользователя должна быть завершена в течение 7 суток с момента получения ссылки для перенаправления
Организация и стоимость подключения По согласованию с курирующим менеджером ECommPay

Схема работы

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



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

Интерфейсы Суммы
Payment Page CMS Plug-ins Gate Dashboard (Old Dashboard) Минимум Максимум
Оплаты + + 5,00 KZT

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

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

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



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



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

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

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

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



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

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

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

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

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

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

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

EPayWidget.run(
    { project_id: 198, 
      payment_id: 'X03936',
      payment_amount: 10000, 
      payment_currency: 'KZT, 
      customer_id: '123',
      signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y1Y4HASCQ9vySODJr...=="
    }
)

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

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

В следующем примере оповещение свидетельствует о том, что в рамках проекта 198 от пользователя 1 была успешно проведена оплата в размере 30 000,00 KZT.

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

"callbackBody": {
        "customer": {
            "id": "1",
            "phone": "79017525555"
        },
        "payment": {
            "date": "2019-09-11T16:46:26+0000",
            "id": "0660fb72c46f852c71b70fb4f4ccb58d",
            "method": "atf24",
            "status": "success",
            "sum": {
                "amount": 30000,
                "currency": "KZT"
            },
            "type": "purchase",
            "description": "deposit"
        },
        "project_id": 198,
        "phone": "79017525555",
        "operation": {
            "id": 8000002523,
            "type": "sale",
            "status": "success",
            "date": "2019-09-11T16:46:26+0000",
            "created_date": "2019-09-11T16:42:10+0000",
            "request_id": "6d496bb819538",
            "sum_initial": {
                "amount": 30000,
                "currency": "KZT"
            },
            "sum_converted": {
                "amount": 30000,
                "currency": "KZT"
            },
            "provider": {
                "id": 1115,
                "payment_id": "74521463",
                "date": "2019-09-11T22:45:02+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "oSqSPD2HxeRlnHzNILQONMto4Kik9geDXneREGA+e9p+1...=="
    }

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

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

 "callbackBody": {
        "project_id": 532,
        "payment": {
            "id": "2123292",
            "type": "purchase",
            "status": "decline",
            "date": "2019-09-10T11:59:17+0000",
            "method": "atf24",
            "sum": {
                "amount": 500000,
                "currency": "KZT"
            },
            "description": ""
        },
        "customer": {
            "id": "1",
            "phone": "79017525555"
        },
        "operation": {
            "id": 49705000001895,
            "type": "sale",
            "status": "decline",
            "date": "2019-09-10T11:59:17+0000",
            "created_date": "2019-09-03T11:49:14+0000",
            "request_id": "a05a1b72966a05a8226b68fadea",
            "sum_initial": {
                "amount": 500000,
                "currency": "KZT"
            },
            "sum_converted": {
                "amount": 500000,
                "currency": "KZT"
            },
            "provider": {
                "id": 1115,
                "payment_id": "70953275",
                "auth_code": ""
            },
            "code": "20602",
            "message": "Time-out"
        },
        "signature": "+acXy66J1d7wLCbHHJv7DyPFF5i8f1jb4bWtub...=="
    }

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

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

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

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

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

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

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



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

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

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

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

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

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

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

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

{
    "general": {
      "project_id": 198,
      "payment_id": payment_id,
      "signature": "PJkV8ej\/UG0Di8hTng6JvC7vQsaC6tajQVVfBaNIipT...=="
    },
    "payment": {
      "amount": 3000000,
      "currency": "KZT"
      },
    "customer": {
      "ip_address": "1.1.1.1",
      "id": "123",
      "phone": "79017525555"
   }
}

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

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

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

 "redirect_data": {
                    "body": {
                        "lifetime": 604800,
                        "id": 77722445
                    },
                    "method": "GET",
                    "url": "https://atf24.kz/Authorize/Login"
                }

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

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

В следующем примере оповещение свидетельствует о том, что в рамках проекта 198 от пользователя 1 была успешно проведена оплата в размере 30 000,00 KZT.

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

"callbackBody": {
        "customer": {
            "id": "1",
            "phone": "79017525555"
        },
        "payment": {
            "date": "2019-09-11T16:46:26+0000",
            "id": "0660fb72c46f852c71b70fb4f4ccb58d",
            "method": "atf24",
            "status": "success",
            "sum": {
                "amount": 30000,
                "currency": "KZT"
            },
            "type": "purchase",
            "description": "deposit"
        },
        "project_id": 198,
        "phone": "79017525555",
        "operation": {
            "id": 8000002523,
            "type": "sale",
            "status": "success",
            "date": "2019-09-11T16:46:26+0000",
            "created_date": "2019-09-11T16:42:10+0000",
            "request_id": "6d496bb819538",
            "sum_initial": {
                "amount": 30000,
                "currency": "KZT"
            },
            "sum_converted": {
                "amount": 30000,
                "currency": "KZT"
            },
            "provider": {
                "id": 1115,
                "payment_id": "74521463",
                "date": "2019-09-11T22:45:02+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "oSqSPD2HxeRlnHzNILQONMto4Kik9geDXneREGA+e9p+1...=="
    }

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

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

 "callbackBody": {
        "project_id": 532,
        "payment": {
            "id": "2123292",
            "type": "purchase",
            "status": "decline",
            "date": "2019-09-10T11:59:17+0000",
            "method": "atf24",
            "sum": {
                "amount": 500000,
                "currency": "KZT"
            },
            "description": ""
        },
        "customer": {
            "id": "1",
            "phone": "79017525555"
        },
        "operation": {
            "id": 49705000001895,
            "type": "sale",
            "status": "decline",
            "date": "2019-09-10T11:59:17+0000",
            "created_date": "2019-09-03T11:49:14+0000",
            "request_id": "a05a1b72966a05a8226b68fadea",
            "sum_initial": {
                "amount": 500000,
                "currency": "KZT"
            },
            "sum_converted": {
                "amount": 500000,
                "currency": "KZT"
            },
            "provider": {
                "id": 1115,
                "payment_id": "70953275",
                "auth_code": ""
            },
            "code": "20602",
            "message": "Time-out"
        },
        "signature": "+acXy66J1d7wLCbHHJv7DyPFF5i8f1jb4bWtub...=="
    }

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

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

Тестирование

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

Для метода ATF24 доступно тестирование оплат через Payment Page и Gate.

Тестирование может выполняться в рамках тестового проекта, и для подключения и отключения этой функциональности необходимо обращаться к специалистам технической поддержки ECommPay support@ecommpay.com.

При проведении тестовых платежей следует учитывать, что в запросах должен указываться идентификатор тестового проекта, а интерфейсы эмулятора платёжных форм Payment Page и ATF24 могут отличаться от рабочих.

Статусы тестовых платежей

При тестировании оплат их итоговые статусы определяются исходя из сумм, указанных в запросах:

  • decline — при указании суммы 40000 или 40400,
  • success — при указании любой другой суммы.

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

Для проведения тестовой оплаты через Payment Page необходимо:

  1. Отправить в платёжную платформу корректный тестовый запрос на открытие Payment Page.
  2. Если в запросе не был указан метод atf24 — выбрать метод ATF24 на странице эмулятора.
  3. Указать в поле ввода произвольный номер телефона.
  4. Убедиться в отображении инструкции.
  5. Принять оповещение с информацией о результате оплаты (это оповещение отправляется по истечении 10 секунд после формирования страницы с инструкцией, отображаемой на шаге 4).

Подробная информация о проведении оплат с использованием метода ATF24 через Payment Page представлена в пункте Оплаты через Payment Page.

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

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

  1. Отправить в платёжную платформу корректный тестовый запрос на оплату.
  2. Принять оповещение с данными для перенаправления.
  3. Принять оповещение с информацией о результате оплаты (это оповещение отправляется по истечении 10 секунд после формирования оповещения с данными для перенаправления).

Подробная информация о проведении оплат с использованием метода ATF24 через Gate представлена в пункте Оплаты через Gate.

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

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

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

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

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

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