«Платежи с использованием карт через партнёра (Аргентина)»

Обзор

Платёжный метод, который позволяет проводить оплаты с использованием платёжных карт через сервис партнёра. Оплаты осуществляются через Payment Page и Gate.

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

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

Схема работы

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

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

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

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

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

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

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

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

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

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

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

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

Пользователь на стороне веб-сервиса инициирует оплату.
От веб-сервиса на заданный URL ECommPay передаётся запрос на проведение оплаты через Payment Page.
Запрос на проведение оплаты поступает в платёжную платформу.
Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
Осуществляется генерация Payment Page согласно настройкам проекта и параметрам вызова.
Пользователю отображается сгенерированная платёжная форма.
Пользователь выбирает для оплаты метод партнёра.
Запрос на проведение оплаты через партнёра поступает в платёжную платформу.
Выполняются дальнейшая обработка запроса и его отправка в сервис партнёра.
На стороне партнёра выполняется обработка запроса на оплату.
От сервиса партнёра к платёжной платформе передаются данные для перенаправления пользователя в сервис партнёра.
Данные для перенаправления пользователя передаются к Payment Page.
Пользователь перенаправляется в сервис партнёра.
Пользователь выполняет необходимые действия для оплаты.
На стороне сервиса партнёра выполняется обработка платежа.
Результат оплаты отображается пользователю в сервисе партнёра.
Пользователь перенаправляется к Payment Page.
От сервиса партнёра к платёжной платформе направляется результат оплаты.
От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
От платёжной платформы к Payment Page направляется результат проведения оплаты.
Результат оплаты отображается пользователю на Payment Page.

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

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

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

Должен использоваться базовый минимум параметров — параметры, обязательные для любого платёжного метода:
- project_id — идентификатор проекта, полученный от ECommPay при интеграции;
- payment_id — идентификатор платежа, уникальный в рамках проекта;
- payment_currency — код валюты платежа в формате ISO-4217 alpha-3;
- payment_amount — целочисленная сумма платежа в минорных единицах;
- customer_id — идентификатор пользователя в рамках проекта.
Валютой платежа может быть только USD.
Для предварительного выбора метода необходимо указать код платёжного метода в параметре force_payment_method — card-partner и передать код 4on в параметре payment_extra_param.
Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page. Детальная информация обо всех параметрах приведена в разделе Параметры открытия платежной формы Payment Page.
После определения всех параметров необходимо составить подпись. Подробную информацию см. в Работа с подписью к данным.

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

    { payment_id: 'X03936', 
      payment_amount: 1000, 
      payment_currency: 'USD',
      customer_id: 'customer1', 
      project_id: 123, 
      signature: "kUi2x9dKHAVNU0FYldJRLCvhtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg=="
    }

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

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

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

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

{
        "project_id": 239,
        "payment": {
            "id": "S0100_20200626_102701_21215202",
            "type": "purchase",
            "status": "success",
            "date": "2020-06-26T07:27:11+0000",
            "method": "Card partner",
            "sum": {
                "amount": 1000,
                "currency": "USD"
            },
            "description": "purchase"
        },
        "customer": {
            "id": "123"
        },
        "operation": {
            "id": 1592,
            "type": "sale",
            "status": "success",
            "date": "2020-06-26T07:27:11+0000",
            "created_date": "2020-06-26T07:27:02+0000",
            "request_id": "dd536f8cbe316cb418170a81a6be7ad1c900e2b2056-00000001",
            "sum_initial": {
                "amount": 1000,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "USD"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 2174,
                "payment_id": "1593156426371",
                "auth_code": "",
                "date": "2020-06-26T07:27:06+0000"
            }
        },
        "signature": "a9/KmYMksEr+0ZAMCBA0F8tEhts55i3IxSl/bdLVvzhhMFg=="
    }
}

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

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

{
        "project_id": 2511,
        "payment": {
            "id": "D0100_20200626_103733_29570862",
            "type": "purchase",
            "status": "decline",
            "date": "2020-06-26T07:37:43+0000",
            "method": "Card partner",
            "sum": {
                "amount": 20500,
                "currency": "USD"
            },
            "description": "purchase"
        },
        "customer": {
            "id": "customer2"
        },
        "operation": {
            "id": 1593,
            "type": "sale",
            "status": "decline",
            "date": "2020-06-26T07:37:43+0000",
            "created_date": "2020-06-26T07:37:33+0000",
            "request_id": "13f5e69966da766f2fbbdf836f481c-00000001",
            "sum_initial": {
                "amount": 20500,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 20500,
                "currency": "USD"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 2174,
                "payment_id": "1593157057421",
                "auth_code": "",
                "date": "2020-06-26T07:37:37+0000"
            }
        },
        "signature": "+ydiKiPFRjEVgpbSMi6U2BwiWYKgjt1DHr6Nqwg4SsrA=="
    }
}

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

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

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

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

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

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

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

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

Пользователь на стороне веб-сервиса инициирует оплату через партнёра.
От веб-сервиса на заданный URL ECommPay передаётся запрос на проведение оплаты через Gate.
Запрос на проведение оплаты поступает в платёжную платформу ECommPay.
Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
От платёжной платформы к веб-сервису направляется ответ с информацией о получении запроса и его корректности. Подробнее см. в разделе Формат ответа.
В платёжной платформе выполняются дальнейшая обработка запроса и его отправка в сервис партнёра.
На стороне партнёра выполняется обработка запроса на оплату.
От сервиса партнёра к платёжной платформе передаются данные для перенаправления пользователя на сайт партнёра.
От платёжной платформы к веб-сервису направляется оповещение с данными для перенаправления пользователя в сервис партнёра в объекте redirect_data.
Пользователь перенаправляется в сервис партнёра.
Пользователь выполняет необходимые действия для оплаты.
На стороне сервиса партнёра выполняется обработка платежа.
Пользователю отображается результат оплаты.
Пользователь перенаправляется к веб-сервису.
От сервиса партнёра к платёжной платформе направляется уведомление о результате оплаты.
От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
От веб-сервиса пользователю направляется результат оплаты.

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

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

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

Должен использоваться запрос v2/payment/card-partner/sale, отправляемый методом POST.
В запросе должны использоваться следующие объекты и параметры:
- general — объект, содержащий основные идентификационные сведения запроса:
  - project_id — идентификатор проекта, полученный от ECommPay при интеграции;
  - payment_id — идентификатор платежа, уникальный в рамках проекта;
  - signature — подпись, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
- payment — объект, содержащий сведения о платеже:
  - amount — целочисленная сумма платежа в минорных единицах валюты,
  - currency — код валюты платежа в формате ISO-4217 alpha-3;
- customer — объект, содержащий сведения о пользователе:
  - id — идентификатор, уникальный в рамках проекта,
  - ip_address — IP-адрес пользователя.
Валютой платежа может быть только USD.
Дополнительно могут использоваться все параметры, указанные в спецификации.

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

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

{
    "general": {
        "project_id": 1233,
        "payment_id": "test_payment_1",
        "signature": "fgret983tyufghndfh*YURGJhuufgsdf=="
    },
    "payment": {
        "amount": 1000,
        "currency": "USD"  
    }
    "customer": {
        "id": "customer123",
        "ip_address": "1.1.1.1"
    }
}

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

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

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

    "redirect_data": {
        "body": {
            "merchantID": "example-4b019406196c",
            "country": "AR",
            "user": "592461",
            "operation_id": 334,
            "paymentID": "exampleID",
            "returnURL": "http://test.ams",
            "callbackURL": "http://text.test/callback/",
            "amount": "10.00"
        },
        "method": "POST",
        "url": "http://example.test/"
    }

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

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

{
        "project_id": 239,
        "payment": {
            "id": "S0100_20200626_102701_21215202",
            "type": "purchase",
            "status": "success",
            "date": "2020-06-26T07:27:11+0000",
            "method": "Card partner",
            "sum": {
                "amount": 1000,
                "currency": "USD"
            },
            "description": "purchase"
        },
        "customer": {
            "id": "123"
        },
        "operation": {
            "id": 1592,
            "type": "sale",
            "status": "success",
            "date": "2020-06-26T07:27:11+0000",
            "created_date": "2020-06-26T07:27:02+0000",
            "request_id": "dd536f8cbe316cb418170a81a6be7ad1c900e2b2056-00000001",
            "sum_initial": {
                "amount": 1000,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "USD"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 2174,
                "payment_id": "1593156426371",
                "auth_code": "",
                "date": "2020-06-26T07:27:06+0000"
            }
        },
        "signature": "a9/KmYMksEr+0ZAMCBA0F8tEhts55i3IxSl/bdLVvzhhMFg=="
    }
}

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

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

{
        "project_id": 2511,
        "payment": {
            "id": "D0100_20200626_103733_29570862",
            "type": "purchase",
            "status": "decline",
            "date": "2020-06-26T07:37:43+0000",
            "method": "Card partner",
            "sum": {
                "amount": 20500,
                "currency": "USD"
            },
            "description": "purchase"
        },
        "customer": {
            "id": "customer2"
        },
        "operation": {
            "id": 1593,
            "type": "sale",
            "status": "decline",
            "date": "2020-06-26T07:37:43+0000",
            "created_date": "2020-06-26T07:37:33+0000",
            "request_id": "13f5e69966da766f2fbbdf836f481c-00000001",
            "sum_initial": {
                "amount": 20500,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 20500,
                "currency": "USD"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 2174,
                "payment_id": "1593157057421",
                "auth_code": "",
                "date": "2020-06-26T07:37:37+0000"
            }
        },
        "signature": "+ydiKiPFRjEVgpbSMi6U2BwiWYKgjt1DHr6Nqwg4SsrA=="
    }
}

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

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

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

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

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

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

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

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