CUP P2P

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

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

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

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

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

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

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

EPayWidget.run(
    { payment_id: 'TEST_154', 
      payment_amount: 50000, 
      payment_currency: 'CNY',
      payment_description: 'test payment', 
      project_id: 581,   
      customer_id: 'customer121',
      language_code: 'zh',
      signature: "xq9k0XaXE0Ig0s%2B4%2BM2gtmkytwe3%2BP1pzXw%2BNPTTGrS%2...=="
    }
)

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

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

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

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

 {
        "project_id": 200,
        "payment": {
            "id": "ECT_TEST_15528942632552",
            "type": "purchase",
            "status": "success",
            "date": "2019-03-19T14:52:34+0000",
            "method": "cup-card",
            "sum": {
                "amount": 50000,
                "currency": "CNY"
            },
            "description": "ECT_TEST_1582894260335"
        },
        "account": {
            "number": "621661******6893"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 32895000000568,
            "type": "sale",
            "status": "success",
            "date": "2019-03-19T14:52:34+0000",
            "created_date": "2019-03-19T14:48:42+0000",
            "request_id": "f493ae438cf9e5851ba2ba4e884e698e99d2f17a",
            "sum_initial": {
                "amount": 50000,
                "currency": "CNY"
            },
            "sum_converted": {
                "amount": 50000,
                "currency": "CNY"
            },
            "provider": {
                "id": 1191,
                "payment_id": "xseHD8v0EsRw3vBuxXeVeDuPBvO7rdKT",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "Ai8OCc69Ik0J9S5HdzndRj6JqS4Z277vSF9V4aJIqfGKc19M
                             ii2ELEp9EdcjpSfr7QvuHGqrxY4MS9B1gIrVCw=="
    }

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

 {
        "project_id": 200,
        "payment": {
            "id": "ECT_TEST_1553500003191",
            "type": "purchase",
            "status": "decline",
            "date": "2019-03-25T11:36:41+0000",
            "method": "cup-card",
            "sum": {
                "amount": 12000,
                "currency": "CNY"
            },
            "description": "ECT_TEST_1553500003190"
        },
        "account": {
            "number": "622200******7804"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 30988000000770,
            "type": "sale",
            "status": "decline",
            "date": "2019-03-25T11:36:41+0000",
            "created_date": "2019-03-25T11:34:38+0000",
            "request_id": "145339509e08a645f9af43ab22652af21d7d",
            "sum_initial": {
                "amount": 12000,
                "currency": "CNY"
            },
            "sum_converted": {
                "amount": 12000,
                "currency": "CNY"
            },
            "provider": {
                "id": 1191,
                "payment_id": "kz4YwSN8TdYrB8CSJVFIeFPdeHTvjcd7",
                "auth_code": ""
            },
            "code": "20105",
            "message": "Insufficient funds on customer account"
        },
        "signature": "vLYJr+04aF4Y0/Vc1CFMsTlb8hzSjZYCYicc76YmlDz
                     f13OADccpMOAT+J1MIpmj0mE7RTmGU5FPSJYcqkpvbA=="
    }

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

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

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

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

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

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

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

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

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

1. Должен использоваться запрос, отправляемый методом POST на /v2/payment/cup/cup-card/sale.
2. В запросе должны использоваться следующие объекты и параметры:
   • general — объект, содержащий основные идентификационные сведения запроса:
     • project_id — идентификатор проекта, полученный от ecommpay при интеграции;
     • payment_id — идентификатор платежа, уникальный в рамках проекта;
     • signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
   • customer — объект, содержащий сведения о пользователе:
     • id — идентификатор, уникальный в рамках проекта,
     • ip_address — IP-адрес,
     • first_name — имя на китайском,
     • last_name — фамилия на китайском,
     • phone — номер телефона без знака +,
     • email — адрес электронной почты,
     • country— страна проживания (значение параметра всегда CN),
     • state — провинция на китайском,
     • address — адрес проживания,
     • city — город проживания на китайском,
     • zip — почтовый индекс;
   • payment — объект, содержащий сведения о платеже:
     • amount — сумма платежа в минорных единицах валюты,
     • currency — валюта платежа в формате ISO-4217 alpha-3,
     • description — описание;
   • card — объект, содержащий сведения о платёжной карте пользователя:
     • pan — номер карты;
   • return_url — URL для перенаправления пользователя:
     • success — при успешном проведении платежа.
3. Валютой платежа может быть только CNY.
4. Дополнительно могут использоваться все параметры, указанные в спецификации.

Таким образом, корректный запрос на оплату с применением метода CUP P2P должен содержать общие данные о запросе, данные о платеже, пользователе и его карте, а также URL для перенаправления:

{
  "general": {
    "project_id": 200,
    "payment_id": "TEST_1559134591371-pz-2",
    "signature": "keNRGu/zTi7tB7T1HPmvelS7k6xZnJP6A8CpU74zrBdFd0AT...=="
  },
  "customer": {
    "ip_address": "185.123.193.224",
    "first_name": "伍",
    "last_name": "倩文",
    "email": "qwe@qw.qw",
    "state": "state",
    "city": "city",
    "address":"address",
    "country": "CN",
    "phone": "phone",
    "zip": "zip",
    "id": "123"
   }
  },
  "payment": {
    "amount": 1000,
    "currency": "CNY",
    "description": "test payment"
  },
  "card": {
    "pan": "621661******6983"
  }, 
  "return_url":{
      "success" : "http://success.com"
  }
}

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

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

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

redirect_data: {
        body: { },
        method: "GET",
        url: "https://api.plusdebit.com/pd/tld/pay/G4aQEmzRbtpUxFOMuJVSZCQM6Exq6LCs",
        encrypted: {
            key: 3,
            message: "28d5ea9205996902a0d314608de875f4a78c00e8519916dc1bac7de61cbe2b6c"
        }
    }

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

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

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

 {
        "project_id": 200,
        "payment": {
            "id": "ECT_TEST_15528942632552",
            "type": "purchase",
            "status": "success",
            "date": "2019-03-19T14:52:34+0000",
            "method": "cup-card",
            "sum": {
                "amount": 60000,
                "currency": "CNY"
            },
            "description": "ECT_TEST_1582894260335"
        },
        "account": {
            "number": "621661******6893"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 32895000000568,
            "type": "sale",
            "status": "success",
            "date": "2019-03-19T14:52:34+0000",
            "created_date": "2019-03-19T14:48:42+0000",
            "request_id": "f493ae438cf9e5851ba2ba4e884e698e99d2f17a",
            "sum_initial": {
                "amount": 60000,
                "currency": "CNY"
            },
            "sum_converted": {
                "amount": 60000,
                "currency": "CNY"
            },
            "provider": {
                "id": 1191,
                "payment_id": "xseHD8v0EsRw3vBuxXeVeDuPBvO7rdKT",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "Ai8OCc69Ik0J9S5HdzndRj6JqS4Z277vSF9V4aJIqfGKc
                        19Mii2ELEp9EdcjpSfr7QvuHGqrxY4MS9B1gIrVCw=="
    }

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

 {
        "project_id": 200,
        "payment": {
            "id": "ECT_TEST_1553500003191",
            "type": "purchase",
            "status": "decline",
            "date": "2019-03-25T11:36:41+0000",
            "method": "cup-card",
            "sum": {
                "amount": 12000,
                "currency": "CNY"
            },
            "description": "ECT_TEST_1553500003190"
        },
        "account": {
            "number": "622200******7804"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 30988000000770,
            "type": "sale",
            "status": "decline",
            "date": "2019-03-25T11:36:41+0000",
            "created_date": "2019-03-25T11:34:38+0000",
            "request_id": "145339509e08a645f9af43ab22652af21d7d",
            "sum_initial": {
                "amount": 12000,
                "currency": "CNY"
            },
            "sum_converted": {
                "amount": 12000,
                "currency": "CNY"
            },
            "provider": {
                "id": 1191,
                "payment_id": "kz4YwSN8TdYrB8CSJVFIeFPdeHTvjcd7",
                "auth_code": ""
            },
            "code": "20105",
            "message": "Insufficient funds on customer account"
        },
        "signature": "vLYJr+04aF4Y0/Vc1CFMsTlb8hzSjZYCYicc76YmlDz
                     f13OADccpMOAT+J1MIpmj0mE7RTmGU5FPSJYcqkpvbA=="
    }

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

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

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

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

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

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

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

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

1. Должен использоваться запрос /v2/payment/chinaunionpay/payout.
2. В запросе должны использоваться следующие объекты и параметры:
   • general — объект, содержащий основные идентификационные сведения запроса:
     • project_id — идентификатор проекта, полученный от ecommpay при интеграции;
     • payment_id — идентификатор платежа, уникальный в рамках проекта;
     • signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
   • customer — объект, содержащий сведения о пользователе:
     • id — идентификатор,
     • ip_address — IP-адрес,
     • email — адрес электронной почты,
     • phone — номер телефона без знака +,
     • state — провинция на китайском,
     • city — город на китайском,
     • country — страна (значение параметра всегда CN),
     • zip — почтовый индекс,
     • street — адрес на китайском,
     • first_name — имя на китайском,
     • last_name — фамилия на китайском;
   • payment — объект, содержащий сведения о платеже:
     • amount — сумма платежа в минорных единицах валюты,
     • currency — валюта платежа в формате ISO-4217 alpha-3;
     • description — описание платежа;
   • card — объект, содержащий сведения о банковской карте или счёте пользователя:
     • pan — номер банковской карты (для некоторых провайдеров требуется указать номер банковского счёта пользователя, подробности следует уточнять у курирующего менеджера ecommpay);
   • account — объект, содержащий сведения о банковском счёте пользователя:
     • city — город из адреса банка,
     • bank_id — идентификатор банка (информация о названиях банков и соответствующих им идентификаторах представлена в пункте Поддержка со стороны банков),
     • region_id — идентификатор региона банка (информация о названиях банков и соответствующих им идентификаторах представлена в пункте Регионы проведения выплат),
     • branch — филиал (аббревиатура).
3. Дополнительно для повышения проходимости можно использовать параметр customer.identify.doc_number — номер документа, подтверждающего личность.
4. Валютой платежа может быть только CNY.
5. Дополнительно могут использоваться все параметры, указанные в спецификации.

Таким образом, корректный запрос на выплату с применением метода CUP P2P должен содержать общие данные о запросе, данные о платеже, пользователе, счёте и номер карты:

{
    "general": {
        "project_id": 255,
        "payment_id": "TEST_15392667771145",
        "signature": "Uhka8CiYAlDlc2wRq60vlSmTTCb0Zp0KYV4NF0...=="
    },
    "customer": {
        "id": "127",
        "ip_address": "185.123.193.224",
        "email": "qwe@qw.qw",
        "state": "state",
        "city": "city",
        "country": "CN",
        "phone": "phone",
        "zip": "zip",
        "street": "street",
        "first_name": "伍",
        "last_name": "倩文",
        "identify": {
            "doc_number": "23512361283"
    },
    "payment": {
        "amount": 501,
        "currency": "CNY"
    }, 
    "card": {
        "pan": "621661******6793"
   },  
    "account": {
        "bank_id": "123",
        "branch": "qwert",
        "city": "City",
        "region_id": "region_id"
    }
}

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

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

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

{
        "project_id": 200,
        "payment": {
            "id": "ECT_TEST_1563863519243_test2-gate-4",
            "type": "payout",
            "status": "success",
            "date": "2019-08-28T08:44:51+0000",
            "method": "ChinaUnionPay",
            "sum": {
                "amount": 48560,
                "currency": "CNY"
            },
            "description": "ECT_TEST_1563863519243"
        },
        "account": {
            "number": "621799******3840"
        },
        "customer": {
            "id": "1",
            "phone": "89102345678"
        },
        "operation": {
            "id": 45343000001495,
            "type": "payout",
            "status": "success",
            "date": "2019-08-28T08:44:51+0000",
            "created_date": "2019-08-28T08:42:08+0000",
            "request_id": "c21daec7a134",
            "sum_initial": {
                "amount": 48560,
                "currency": "CNY"
            },
            "sum_converted": {
                "amount": 48560,
                "currency": "CNY"
            },
            "provider": {
                "id": 1321,
                "payment_id": "10019082821621938",
                "date": "2019-08-28T16:42:12+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "aW/oS/l7RTlKabsqCZXs1zile11EIX8mkM3+gJfwddjvtszeiMXcU7...=="
    }

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

{
        "project_id": 200,
        "payment": {
            "id": "ECT_TEST_122127637126536125",
            "type": "payout",
            "status": "decline",
            "date": "2019-03-22T14:02:44+0000",
            "method": "cup-card",
            "sum": {
                "amount": 48560,
                "currency": "CNY"
            },
            "description": ""
        },
        "account": {
            "number": "621661******6993"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 32988000000665,
            "type": "payout",
            "status": "decline",
            "date": "2019-03-22T14:02:44+0000",
            "created_date": "2019-03-22T14:02:12+0000",
            "request_id": "b78ffab13002d994a6a572410b943ed110",
            "sum_initial": {
                "amount": 48560,
                "currency": "CNY"
            },
            "sum_converted": {
                "amount": 48560,
                "currency": "CNY"
            },
            "provider": {
                "id": 1191,
                "payment_id": "6UBPgonfNE4kjjPB6HoV5pjTdBo34Lni",
                "date": "2019-03-22T14:02:43+0000",
                "auth_code": ""
            },
            "code": "20106",
            "message": "Customer account is no longer available"
         },
        "signature": "rP/FoxRIdBJtMLKP5KAndJwmJHWQ3HXsDCpcbmaaqqk
                    8w26a2toW057NtmDcT+Rgenr2hxTMYit9JUmQkYdtVg=="
    }

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

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

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

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

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

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

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

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

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

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

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

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

1. Отправить в платёжную платформу корректный тестовый запрос на открытие Payment Page.
2. Если в запросе не был указан метод cup-card — выбрать метод CUP P2P на странице эмулятора.
3. Указать необходимые данные в полях ввода. При указании номера платёжной карты можно использовать номер действующей карты или тестовый номер 4111 1111 1111 1111.
4. Щёлкнуть кнопку Success или Decline (с учётом того, какая сумма была указана в запросе).
5. Принять оповещение с информацией о результате оплаты (это оповещение отправляется по истечении 60 секунд после формирования страницы с кнопкой Success или Decline, отображаемой на шаге 4).

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

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

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

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

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

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

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

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

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

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