KakaoPay

Обзор

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

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

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

Схема работы

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



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

Интерфейсы Суммы, KRW Время*
Payment Page CMS Plug-ins Gate Dashboard минимум максимум базовое предельное
Оплаты + – + – – – – –
Полные возвраты – – + – – – – –
Частичные возвраты – – + – – – – –
* Базовое и предельное время определяются следующим образом:
  • Базовое время — среднее расчётное время проведения платежа от момента его инициирования на стороне платёжной платформы до момента отправки инициатору оповещения о результате. Это время, определяемое для условий штатной работы всех технических средств и каналов связи, а также типичных действий со стороны пользователя (там, где они необходимы). Базовое время рекомендуется использовать для реагирования на отсутствие оповещений о результате платежа и выполнения опроса состояния платежа.
  • Предельное время — максимально допустимое время проведения платежа от момента его инициирования на стороне платёжной платформы до момента отправки инициатору оповещения о результате. Если платёж не был проведён или отклонён за это время, он автоматически переводится в статус decline. Для индивидуальной настройки предельного времени следует обращаться к специалистам технической поддержки ECommPay.

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

В процесе проведения оплат с использованием метода KakaoPay пользователи сканируют QR-коды с использованием электронных кошельков. Проведение возвратов выполняется с уведомлением пользователей через веб-сервис мерчанта.

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



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



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



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

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

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

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



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

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

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

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

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

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

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

EPayWidget.run(
    { payment_id: 'X03936', 
      payment_amount: 1000, 
      payment_currency: 'KRW', 
      project_id: 123,
      customer_id: '1234', 
      signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y1Y4HAS...zUCwX6R\/ekpZhkIQg=="
    }
)

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

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

В следующем примере оповещение свидетельствует о том, что в рамках проекта 1234 для пользователя customer1 была успешно проведена оплата в размере 1000 KRW.

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

{
        "project_id": 1234,
        "payment": {
            "id": "ABC123",
            "type": "purchase",
            "status": "success",
            "date": "2020-12-10T10:44:49+0000",
            "method": "kakaopay",
            "sum": {
                "amount": 1000,
                "currency": "KRW"
            },
            "description": ""
        },
        "customer": {
            "id": "customer1"
        },
        "operation": {
            "id": 123,
            "type": "sale",
            "status": "success",
            "date": "2020-12-10T10:44:49+0000",
            "created_date": "2020-12-10T10:44:41+0000",
            "request_id": "46d13cf06a05f023ab53dd2d3d5c266a31c537a7-bd729b81...0001",
            "sum_initial": {
                "amount": 1000,
                "currency": "KRW"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "KRW"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 12345,
                "payment_id": "ABC12345",
                "auth_code": ""
            }
        },
        "signature": "Q8ccLF2ERNK0fbnnVil8NPh8vx83gF4aift64dN/dwyHkQIT2QN...Zr3OQ=="
}

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

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

{
        "project_id": 1234,
        "payment": {
            "id": "ABC123",
            "type": "purchase",
            "status": "decline",
            "date": "2020-12-15T11:14:03+0000",
            "method": "kakaopay",
            "sum": {
                "amount": 1000,
                "currency": "KRW"
            },
            "description": ""
        },
        "customer": {
            "id": "customer1"
        },
        "operation": {
            "id": 12345,
            "type": "sale",
            "status": "decline",
            "date": "2020-12-15T11:14:03+0000",
            "created_date": "2020-12-15T11:13:54+0000",
            "request_id": "f70a332cee48f25311ea302c334cc189993a8db4-4bb39ad...0001",
            "sum_initial": {
                "amount": 1000,
                "currency": "KRW"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "KRW"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 1234,
                "payment_id": "",
                "auth_code": ""
            }
        },
        "signature": "ZAXzfe6IG0dMypLzKledh0Glk6uDiRy1Ql5xORwb4avqJK...oi+c86GRGEQ=="
}

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

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

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

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

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

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

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



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

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

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

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

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

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

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

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

{
     "general": {
        "project_id": 1234,
        "payment_id": "ABC1234",
        "signature": "asdfvg...rty"
     },
     "payment": {
        "amount": 1000,
        "currency": "KRW"
     },
     "customer": {
        "id": "customer1",
        "ip_address": "1.1.1.1"
     },
     "return_url": {
        "decline" : "http://example.url/decline",
        "success" : "http://example.url/success",
        "return": "http://example.url/return"
     }
}

Форматы данных для отображения платёжной инструкции

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

Массив display_data содержит следующие параметры:

  • type — тип передаваемых данных (в значении всегда передаётся qr_img);
  • title — название передаваемых данных, которые необходимо отобразить пользователю (в значении всегда передаётся QR code);
  • data — строка с закодированным изображением QR-кода.

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

"display_data": [
            {
                "type": "qr_img",
                "title": "QR code",
                "data": "data:image/png;base64,iVBORw0KGgo...AJBkEJMkgIEkGAUn/D/CW8OIAiZ8NAAAAAElFTkSuQmCC"
            }
]

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

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

В следующем примере оповещение свидетельствует о том, что в рамках проекта 1234 для пользователя customer1 была успешно проведена оплата в размере 1000 KRW.

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

{
        "project_id": 1234,
        "payment": {
            "id": "ABC123",
            "type": "purchase",
            "status": "success",
            "date": "2020-12-10T10:44:49+0000",
            "method": "kakaopay",
            "sum": {
                "amount": 1000,
                "currency": "KRW"
            },
            "description": ""
        },
        "customer": {
            "id": "customer1"
        },
        "operation": {
            "id": 123,
            "type": "sale",
            "status": "success",
            "date": "2020-12-10T10:44:49+0000",
            "created_date": "2020-12-10T10:44:41+0000",
            "request_id": "46d13cf06a05f023ab53dd2d3d5c266a31c537a7b14067e471...0001",
            "sum_initial": {
                "amount": 1000,
                "currency": "KRW"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "KRW"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 12345,
                "payment_id": "ABC12345",
                "auth_code": ""
            }
        },
        "signature": "Q8ccLF2ERNK0fbnnVil8NPh8vx83gF4aift64dN/dwyHkQIT2QNgv+Cf...Zr3OQ=="
}

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

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

{
        "project_id": 1234,
        "payment": {
            "id": "ABC123",
            "type": "purchase",
            "status": "decline",
            "date": "2020-12-15T11:14:03+0000",
            "method": "kakaopay",
            "sum": {
                "amount": 1000,
                "currency": "KRW"
            },
            "description": ""
        },
        "customer": {
            "id": "customer1"
        },
        "operation": {
            "id": 12345,
            "type": "sale",
            "status": "decline",
            "date": "2020-12-15T11:14:03+0000",
            "created_date": "2020-12-15T11:13:54+0000",
            "request_id": "f70a332cee48f25311ea302c334cc189993a8db4-4bb39ad...0001",
            "sum_initial": {
                "amount": 1000,
                "currency": "KRW"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "KRW"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 1234,
                "payment_id": "",
                "auth_code": ""
            }
        },
        "signature": "ZAXzfe6IG0dMypLzKledh0Glk6uDiRy1Ql5xORwb4avqJK...oi+c86GRGEQ=="
}

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

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

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

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

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



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

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

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

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

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

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

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

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

{
    "general": {
        "payment_id": "payment_id",
        "project_id": 1625,
        "signature": "asdfvg...rty"
        },
    "payment": {
        "description": "refund",
        "amount": 1000,
        "currency": "KRW"
        }
}

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

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

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

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

{
        "project_id": 1234,
        "payment": {
            "id": "ABC123",
            "type": "purchase",
            "status": "refunded",
            "date": "2020-12-15T11:15:58+0000",
            "method": "kakaopay",
            "sum": {
                "amount": 0,
                "currency": "KRW"
            },
            "description": "refund"
        },
        "customer": {
            "id": "customer1"
        },
        "operation": {
            "id": 12345,
            "type": "refund",
            "status": "success",
            "date": "2020-12-15T11:15:58+0000",
            "created_date": "2020-12-15T11:15:54+0000",
            "request_id": "74e1b0af0242c7d562f991b2203794fe48d6cbaa-681285...0001",
            "sum_initial": {
                "amount": 1000,
                "currency": "KRW"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "KRW"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 3456,
                "payment_id": "",
                "auth_code": ""
            }
        },
        "signature": "sfDbm8f+3edPKxf10/0K5btjGDOeOTdv2Mc92r...zThloXxg8xg=="
}

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

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

{
        "project_id": 1234,
        "payment": {
            "id": "customer1",
            "type": "purchase",
            "status": "success",
            "date": "2020-12-15T11:17:19+0000",
            "method": "kakaopay",
            "sum": {
                "amount": 1000,
                "currency": "KRW"
            },
            "description": "refund"
        },
        "customer": {
            "id": "customer1"
        },
        "operation": {
            "id": 2345,
            "type": "refund",
            "status": "decline",
            "date": "2020-12-15T11:17:19+0000",
            "created_date": "2020-12-15T11:17:17+0000",
            "request_id": "1d098669df63438f1a4079193218543f22c40160-4a9e06db...0001",
            "sum_initial": {
                "amount": 1000,
                "currency": "KRW"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "KRW"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 3456,
                "payment_id": "",
                "auth_code": ""
            }
        },
        "signature": "04fZ8UZhuCXotsbI+8sqk98hegbVEYc3iAfFOYx8XmBUWhjd...kHf/HIA=="
}

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

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

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

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

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

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

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

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