WeChat

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

Схема работы

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

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

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

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

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

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

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

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

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

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

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

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

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

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

3. Для предварительного выбора метода WeChat необходимо указывать код платёжного метода в параметре force_payment_method — wechat.
4. Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page.
5. После определения всех параметров необходимо составить подпись. Подробную информацию см. в разделе Работа с подписью к данным.

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

EPayWidget.run(
    { payment_id: 'X03936', 
      payment_amount: 10000, 
      payment_currency: 'EUR', 
      project_id: 239,    
      language_code: zh, 
      customer_id: 'customer1',
      signature: "kUi2x9dKHAVNU0xh4yo+52Kt8KU\/RLCvhtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg=="
    }
)

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

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

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

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

 {
        "project_id": 238,
        "payment": {
            "id": "TEST_154866061847343331",
            "type": "purchase",
            "status": "success",
            "date": "2019-01-28T08:07:22+0000",
            "method": "wechat",
            "sum": {
                "amount": 100,
                "currency": "EUR"
            },
            "description": "TEST_1548660618473453"
        },
        "operation": {
            "id": 9227000002916,
            "type": "sale",
            "status": "success",
            "date": "2019-01-28T08:07:22+0000",
            "created_date": "2019-01-28T08:06:40+0000",
            "request_id": "67af98801524dfa9c5cddb1a09129",
            "sum_initial": {
                "amount": 100,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 100,
                "currency": "EUR"
            },
            "provider": {
                "id": 1173,
                "payment_id": "423163569",
                "date": "2019-01-28T08:07:22+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "yuuYzrj3kD1cKFh6Ba66wmDUY2a+CUnsiPrp5Q+ZYgrxBGJrJMo8oJqiyD7GgoTS+mvRA=="
    }

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

{
        "project_id": 238,
        "payment": {
            "id": "TEST_154996862174000",
            "type": "purchase",
            "status": "decline",
            "date": "2019-02-12T10:56:22+0000",
            "method": "wechat",
            "sum": {
                "amount": 10000,
                "currency": "USD"
            },
            "description": "TEST_154996862174000"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 9172000003183,
            "type": "sale",
            "status": "decline",
            "date": "2019-02-12T10:56:22+0000",
            "created_date": "2019-02-12T10:56:18+0000",
            "request_id": "11d4aabf869cb74c0681927ad7",
            "sum_initial": {
                "amount": 10000,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "USD"
            },
            "provider": {
                "id": 1169,
                "payment_id": "",
                "auth_code": ""
            },
            "code": "20105",
            "message": "Insufficient funds on customer account"
        },
        "signature": "ghmnbvc1oVdS/mE0AlVOUDbbNqlXO/+e0Vt05S8vyeI14MBiRz0yJRrqn7HiBOEIObz2tN5SLw=="
    }
}

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

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

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

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

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

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

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

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

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

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

1. Должен использоваться запрос /v2/payment/wallet/wechat/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,
     • description — описание.
3. Дополнительно, в зависимости от провайдера, обрабатывающего платёж, рекомендуется указывать номер телефона и адрес электронной почты пользователя. Если параметры отсутствуют в запросе, список недостающих параметров отправляется в оповещении на уточнение. Подробнее об уточнении параметров — в разделе Дополнение информации о платеже.

   Рекомендуется использовать следующие объекты и параметры:

   • customer — объект, содержащий сведения о пользователе:
     • email — адрес электронной почты,
     • phone — номер телефона без знака + (например, 861234567890);
4. Валютой платежа может быть одна из следующих валют: CNY, EUR, HKD, JPY, SGD, THB, USD.
5. Дополнительно могут использоваться все параметры, указанные в спецификации.

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

{
  "general": {
    "project_id": 200,
    "payment_id": "TEST_1559134591371-pz-2",
    "signature": "leNRGu/zTi7tB7T1HPmvelS7k6xZnJP6A8CpU74zrBdFd0ATe
                           CJjfr3dcxwEo6FgBqHDJMQmmWyDUcq3rJKqtw=="
  },
  "customer": {
    "ip_address": "185.123.193.224",
    "id": "customer123",
    "email": "customer@example.com",
    "phone": "861234567890"
  },
  "payment": {
    "amount": 1000,
    "currency": "EUR",
    "description": "test payment"
  }
}

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

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

• type — тип объекта,
• title — название объекта,
• data — данные, соответствующие указанному типу объекта.

Массив display_data формируется с учётом следующих условий:

• Обязательным является объект с указанием данных для передачи QR-кода. Значение параметра data в таком объекте соответствует значению параметра type, который может принимать следующие значения:
  • qr_url — при передаче QR-кода как ссылки на изображение. В этом случае в параметре data передаётся URL.
  • qr_img — при передаче QR-кода как изображения. В этом случае в параметре data передаётся строка, закодированная с использованием схемы Base64.
  • qr_data — при передаче QR-кода как строки. В этом случае в параметре data передаётся строка, на основании которой на стороне веб-сервиса должен быть создан QR-код.
• В дополнение к обязательному объекту с указанием данных для передачи QR-кода могут передаваться один или несколько объектов c дополнительной информацией. Параметр type таких объектов принимает значение add_info, а в параметре data может передаваться разнообразная информация.
• Если в массиве присутствуют один или несколько объектов с дополнительной информацией, то в такой массив включается объект с информацией о сроке действия QR-кода с момента его создания на стороне сервиса WeChat. Параметру title такого объекта присваивается значение QR Code Timeout, а срок действия указывается в секундах в параметре data.

Далее приведён фрагмент оповещения, содержащего строку для создания QR-кода и срок его действия в качестве дополнительной информации.

 "display_data": [
            {
                "type": "qr_data",
                "title": "QR code",
                "data": "weixin://wxpay/bizpayurl?pr=dMrSpJG"
            },
            {
                "type": "add_info",
                "title": "QR Code Timeout",
                "data": "600"
            }
        ]

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

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

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

 {
        "project_id": 238,
        "payment": {
            "id": "TEST_154866061847343331",
            "type": "purchase",
            "status": "success",
            "date": "2019-01-28T08:07:22+0000",
            "method": "wechat",
            "sum": {
                "amount": 100,
                "currency": "EUR"
            },
            "description": "TEST_1548660618473453"
        },
        "operation": {
            "id": 9227000002916,
            "type": "sale",
            "status": "success",
            "date": "2019-01-28T08:07:22+0000",
            "created_date": "2019-01-28T08:06:40+0000",
            "request_id": "67af98801524dfa9c5cddb1a09129",
            "sum_initial": {
                "amount": 100,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 100,
                "currency": "EUR"
            },
            "provider": {
                "id": 1173,
                "payment_id": "423163569",
                "date": "2019-01-28T08:07:22+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "yuuYzrj3kD1cKFh6Ba66wmDUY2a+CUnsiPrp5Q+ZYgrxBGJrJMo8oJqiyD7GgoTS+mvRA=="
    }

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

{
        "project_id": 238,
        "payment": {
            "id": "TEST_154996862174000",
            "type": "purchase",
            "status": "decline",
            "date": "2019-02-12T10:56:22+0000",
            "method": "wechat",
            "sum": {
                "amount": 10000,
                "currency": "USD"
            },
            "description": "TEST_154996862174000"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 9172000003183,
            "type": "sale",
            "status": "decline",
            "date": "2019-02-12T10:56:22+0000",
            "created_date": "2019-02-12T10:56:18+0000",
            "request_id": "11d4aabf869cb74c0681927ad7",
            "sum_initial": {
                "amount": 10000,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "USD"
            },
            "provider": {
                "id": 1169,
                "payment_id": "",
                "auth_code": ""
            },
            "code": "20105",
            "message": "Insufficient funds on customer account"
        },
        "signature": "ghmnbvc1oVdS/mE0AlVOUDbbNqlXO/+e0Vt05S8vyeI14MBiRz0yJRrqn7HiBOEIObz2tN5SLw=="
    }
}

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

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

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

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

Проведение возвратов через WeChat выполняется следующим способом: со стороны веб-сервиса мерчанта необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ecommpay и принять оповещение о результате проведения возврата. Полная схема проведения возврата представлена далее.

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

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

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

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

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

  "general": {    
    "project_id": 239,    
    "payment_id": "refund_02",   
    "signature": "of8k9xerKSK4XL1QFaDH3p9Mh0CIcjmOwSwKJ7KLTZYO56lCv+f1M0Sf/7eg=="
  },  
   "customer": {    
     "ip_address": "1.2.3.4" 
 },  
  "payment": {    
    "amount": 10000,    
    "description": "refund_02"
}

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

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

В следующем примере оповещение свидетельствует о том, что в рамках проекта 238 для пользователя был успешно проведён возврат в размере 100,00 USD на счёт № 2626324568.

{
        "project_id": 238,
        "payment": {
            "id": "refund_02",
            "type": "purchase",
            "status": "refunded",
            "date": "2019-02-19T14:25:25+0000",
            "method": "wechat",
            "sum": {
                "amount": 10000,
                "currency": "USD"
            },
            "description": "test_02"
        },
        "account": {
            "number": "2626324568"
        },
        "operation": {
            "id": 14153000003282,
            "type": "refund",
            "status": "success",
            "date": "2019-02-19T14:25:25+0000",
            "created_date": "2019-02-19T14:25:24+0000",
            "request_id": "9d11b2ca618ec3ba0f588af8af3c4fc9f5fa58f174",
            "sum_initial": {
                "amount": 10000,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "USD"
            },
            "provider": {
                "id": 413,
                "payment_id": "105887607",
                "date": "2019-02-19T14:25:24+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "of8k9xerKSKpFBR4XL1QFaDH3p9Mh0CIcjmOwSwKJ7KLTZYO56lCv+f1M0Sf/7eg=="
    }

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

{
        "project_id": 198,
        "payment": {
            "id": "ECT_TEST_15428009030783",
            "type": "purchase",
            "status": "success",
            "date": "2018-11-23T13:46:39+0000",
            "method": "wechat",
            "sum": {
                "amount": 10000,
                "currency": "EUR"
            },
            "description": "ECT_TEST_1542800903078"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 13792000002073,
            "type": "refund",
            "status": "decline",
            "date": "2018-11-30T09:25:36+0000",
            "created_date": "2018-11-30T09:25:33+0000",
            "request_id": "d848450ce489c6293ef711269d2746527eaad747-995c67b9e87b97da81f86522434873a99f534e2c",
            "sum_initial": {
                "amount": 10000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "EUR"
            },
            "provider": {
                "id": 413,
                "payment_id": "",
                "auth_code": ""
            },
            "code": "3283",
            "message": "Refund amount more than init amount"
        },
        "signature": "AO081Lg6GT/+VIRKN/C3Fh4qq7eL/X83wtvK2Ap9XTFAV7uHcrzXFse5nX1DAqn57Ypq8MxSMtpOBca0mhZ9ag=="
    }

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

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

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

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

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

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

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

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