Alipay

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

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

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

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

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

1. Должен использоваться базовый минимум параметров — параметры, обязательные для любого платёжного метода:
   • project_id — идентификатор проекта, полученный от ecommpay при интеграции;
   • payment_id — идентификатор платежа, уникальный в рамках проекта;
   • payment_currency — валюта платежа в формате ISO-4217 alpha-3;
   • payment_amount — сумма платежа в дробных единицах,
   • customer_id — идентификатор пользователя, уникальный в рамках проекта.
2. Доступные валюты платежа уточняйте у курирующего менеджера ecommpay.
3. Дополнительно должен использоваться параметр language_code — код языка Payment Page в формате ISO 639-1 alpha-2; необходимо указать код zh.
4. Для предварительного выбора метода Alipay необходимо указывать в параметре force_payment_method код платёжного метода — alipay.
5. Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page.
6. После указания целевых параметров необходимо составлять подпись (подробнее — в разделе Работа с подписью к данным).

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

EPayWidget.run(
    { payment_id: 'TEST_1549606366224', 
      payment_amount: 1800, 
      payment_currency: 'CNY', 
      project_id: 580, 
      customer_id: '123',
      language_code: 'zh',
      signature: "xq9k0XaXE0Ig0s%2B4%2BM1gtmkytwe3%2BP1pzXw%2BNPTTGrS%2FV4pdM22U3%2FtkGVNsug19oD1upt%2F%2BABrIsG37IPKbfw%3D%3D"
    }
)

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

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

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

 {
        "project_id": 201,
        "payment": {
            "id": "ECT_TEST_155125514200636",
            "type": "purchase",
            "status": "success",
            "date": "2019-02-27T16:01:25+0000",
            "method": "alipay",
            "sum": {
                "amount": 1000,
                "currency": "CNY"
            },
            "description": "ECT_TEST_1551255142006"
        },
        "customer": {
            "id": "125"
        },
        "operation": {
            "id": 20891000000045,
            "type": "sale",
            "status": "success",
            "date": "2019-02-27T16:01:25+0000",
            "created_date": "2019-02-27T15:46:21+0000",
            "request_id": "85d4801f8fa9dead54d315ae1945c02179219cecb4550201cdcafab",
            "sum_initial": {
                "amount": 1000,
                "currency": "CNY"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "CNY"
            },
            "provider": {
                "id": 1189,
                "payment_id": "Abe9VAEokJyIqyRcX10TLkz30XQbmK3f",
                "date": "2019-02-27T16:01:24+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "T/v8rquB+C0K7TR7sz1vvOrpCsV1/hr9LE0TciPhiQW/cTwYnkyJ
                                     vMjXKcrzgAET24a4XeZFoJhIh27fY9PF7Q=="
    }

 {
            "id": "ECT_TEST_1551103453746538344",
            "type": "purchase",
            "status": "decline",
            "date": "2019-02-27T14:41:30+0000",
            "method": "alipay",
            "sum": {
                "amount": 10000,
                "currency": "CNY"
            },
            "description": ""
        },
        "operation": {
            "id": 20370000000023,
            "type": "sale",
            "status": "decline",
            "date": "2019-02-27T14:41:30+0000",
            "created_date": "2019-02-26T13:39:44+0000",
            "request_id": "36e07e85504ec76924435475b3b967e22b3d6e59e5d5066ebb",
            "sum_initial": {
                "amount": 10000,
                "currency": "CNY"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "CNY"
            },
            "provider": {
                "id": 1189,
                "payment_id": "g4Ld5b6iSuzTmukZUj1RVkXNMuYSj07I",
                "date": "2019-02-27T14:41:29+0000",
                "auth_code": ""
            },
            "code": "20105",
            "message": "Insufficient funds on customer account"
        },
        "signature": "EezTcWDrcp8RW2Wb+bLmytXR+qczUZltlNDlBvJYGj2voXt1J9W6K
                                       +dZmmuOod7K9HNUqox9BRWctzaanCrzhw=="
    }

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

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

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

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

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

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

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

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

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

1. Должен использоваться запрос /v2/payment/wallet/alipay/sale, отправляемый методом POST. Этот запрос относится к группе запросов для платежей через электронный кошелёк /v2/payment/wallet/{payment_method}/sale.
2. В запросе должны использоваться следующие объекты и параметры:
   • general — объект, содержащий основные идентификационные сведения о запросе:
     • project_id — идентификатор проекта, полученный от ecommpay при интеграции;
     • payment_id — идентификатор платежа, уникальный в рамках проекта;
     • signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
   • customer — объект, содержащий сведения о пользователе:
     • id — идентификатор в рамках проекта,
     • ip_adress — используемый IP-адрес,
     • first_name * — имя,
     • last_name * — фамилия,
     • phone * — номер телефона без знака +,
     • email * — адрес электронной почты,
     • zip * — почтовый индекс,
     • country * — страна в формате ISO 3166-1 alpha-2,
     • city * — город на китайском,
     • street * — адрес на китайском;
   • payment — объект, содержащий сведения о платеже:
     • amount — сумма платежа в дробных единицах,
     • currency — валюта платежа в формате ISO-4217 alpha-3;
     • description * — описание или комментарий к платежу;
   • return_url — объект, содержащий URL для перенаправления пользователя в веб-сервис:
     • return — URL сайта для возврата на любом шаге проведения платежа,
     • success * — URL возврата в случае проведенного платежа.
   Прим.: * Необходимость использования этих параметров следует уточнять у курирующего менеджера ecommpay. Если хотя бы один из тех параметров, которые должны использоваться, отсутствует в запросе, то на стороне платёжной платформы выявляется необходимость в дополнении данных и применяется соответствующая процедура — Дополнение информации о платеже.
3. Доступные валюты платежа уточняйте у курирующего менеджера ecommpay.
4. Дополнительно могут использоваться все параметры, указанные в спецификации.

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

{
  "general": {
    "project_id": 201,
    "payment_id": "ECT_TEST_155125514400636",
    "signature": "cMlzFj8zqZJbum1wysO3wE0qLdboEYQAteO62aewWX7xcG+Ttb0fhuenWNptFZg=="
  },
  "customer": {
    "id": "123",
    "ip_address": "111.193.57.157",
    "first_name": "之的",
    "last_name": "张",
    "phone": "13632264148",
    "email": "2524243674@example.com",
    "street":"street",
    "city": "city",
    "zip": "123045608",
    "country": "CH"
  },
  "payment": {
    "amount": 1000,
    "currency": "CNY",
    "description": "payment"
  },
    "return_url": {
      "return": "http://example.com/return",
      "success": "http://example.com/success"
    }
}

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

Для перенаправления пользователя от веб-сервиса к сервису Alipay со стороны платёжной платформы к веб-сервису отправляется оповещение с данными для перенаправления. В зависимости от провайдера, обрабатывающего платёж, для перенаправления могут использоваться URL или QR-код:

• URL — в этом случае в оповещении содержится объект redirect_data.
• QR-код — в этом случае в оповещении содержится массив display_data.

За информацией об используемом типе перенаправления следует обращаться к курирующему менеджеру ecommpay.

Объект redirect_data

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

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

"redirect_data": {
            "method": "POST",
            "body": {
                "order_no": "29895000000582",
                "amount": "13.00",
                "payment_channel": "ALIPAY",
                "sign": "****************",
                "return_url": "https://site.com/process/wsid=pls2vp8vrcmdj95nhnjf2h9cd3",
                "signType": "RSA",
                "currency": "CNY",
                "body": "ECT_TEST_1552972940011",
                "app_id": "4391"
            },
            "encrypted": [],
            "url": "https://test.com:443/payment/otoSoft/v3/h5.html"
        }

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

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

 {
        "project_id": 201,
        "payment": {
            "id": "ECT_TEST_155125514200636",
            "type": "purchase",
            "status": "success",
            "date": "2019-02-27T16:01:25+0000",
            "method": "alipay",
            "sum": {
                "amount": 1000,
                "currency": "CNY"
            },
            "description": "ECT_TEST_1551255142006"
        },
        "customer": {
            "id": "125"
        },
        "operation": {
            "id": 20891000000045,
            "type": "sale",
            "status": "success",
            "date": "2019-02-27T16:01:25+0000",
            "created_date": "2019-02-27T15:46:21+0000",
            "request_id": "85d4801f8fa9dead54d315ae1945cebd734eeefc",
            "sum_initial": {
                "amount": 1000,
                "currency": "CNY"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "CNY"
            },
            "provider": {
                "id": 1189,
                "payment_id": "Abe9VAEokJyIqyRcX10TLkz30XQbmK3f",
                "date": "2019-02-27T16:01:24+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "T/v8rquB+C0K7TR7sz1vvOrpCsV1/hr9LE0TciPhiQW/cT
                         wYnkyJvMjXKcrzgAET24a4XeZFoJhIh27fY9PF7Q=="
    }

 {
            "id": "ECT_TEST_1551103453746538344",
            "type": "purchase",
            "status": "decline",
            "date": "2019-02-27T14:41:30+0000",
            "method": "alipay",
            "sum": {
                "amount": 10000,
                "currency": "CNY"
            },
            "description": ""
        },
        "operation": {
            "id": 20370000000023,
            "type": "sale",
            "status": "decline",
            "date": "2019-02-27T14:41:30+0000",
            "created_date": "2019-02-26T13:39:44+0000",
            "request_id": "36e07e85504ec76924435475b3544d1422b3d6e59e5d5066ebb",
            "sum_initial": {
                "amount": 10000,
                "currency": "CNY"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "CNY"
            },
            "provider": {
                "id": 1189,
                "payment_id": "g4Ld5b6iSuzTmukZUj1RVkXNMuYSj07I",
                "date": "2019-02-27T14:41:29+0000",
                "auth_code": ""
            },
            "code": "20105",
            "message": "Insufficient funds on customer account"
        },
        "signature": "EezTcWDrcp8RW2Wb+bLmytXR+qczUZltlNDlBvJYGj2voXt1J9W6K+dZmmuOod7K9HNUqox9BRWctzaanCrzhw=="
    }

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

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

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

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

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

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

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

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

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

Таким образом, корректный запрос на возврат с применением метода Alipay должен содержать идентификаторы проекта и платежа, подпись, 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"
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1. Отправить в платёжную платформу корректный тестовый запрос на открытие Payment Page.
2. Если в запросе не был указан метод alipay — выбрать метод Alipay на странице эмулятора.
3. Убедиться в отображении инструкции и щёлкнуть кнопку Оплатить.
4. Указать в поле ввода произвольную фамилию.
5. Щёлкнуть кнопку Success или Decline (в зависимости от запрашиваемой суммы).
6. Принять оповещение с информацией о результате оплаты.

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

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

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

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

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

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

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

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

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

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

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

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