Оплаты с использованием наличных и интернет-банкинга в Бразилии
Обзор
«Оплаты с использованием наличных и интернет-банкинга в Бразилии» — платёжный метод, который позволяет пользователям совершать платежи наличными средствами и через интернет-банкинг в Бразилии. Для работы с этим методом доступно проведение оплат через Payment Page и Gate, а также возвратов через Gate и Dashboard.
Характеристика
Тип платёжного метода |
|
---|---|
Платёжные инструменты |
|
Регионы использования | BR |
Валюты платежей | USD |
Конвертация валют | – |
Оплаты | + |
Выплаты | – |
Оплаты по сохранённым данным | – |
Полные возвраты | + |
Частичные возвраты | + |
Опротестования | – |
Особенности | Возвраты доступны только для оплат через интернет-банкинг |
Организация и стоимость подключения | по согласованию с курирующим менеджером ecommpay |
Схема работы
В проведении отдельного платежа с использованием «Оплаты с использованием наличных и интернет-банкинга в Бразилии» задействуются веб-сервис мерчанта, один из интерфейсов и платёжная платформа ecommpay, а также технические средства провайдера.
Основные операции
Интерфейсы | Суммы | Время * | ||||||
---|---|---|---|---|---|---|---|---|
Payment Page | CMS Plug-ins | Gate | Dashboard | Минимум | Максимум | Базовое | Предельное | |
Оплаты | + | – | + | – | – | эквивалент 46 000,00 BRL в USD | – | 35 часов |
Полные возвраты | – | – | + | + | – | – | – | – |
Частичные возвраты | – | – | + | + | – | – | – | – |
* Базовое и предельное время определяются следующим образом:
- Базовое время — среднее расчётное время проведения платежа от момента его инициирования на стороне платёжной платформы до момента отправки инициатору оповещения о результате. Это время, определяемое для условий штатной работы всех технических средств и каналов связи, а также типичных действий со стороны пользователя (там, где они необходимы). Базовое время рекомендуется использовать для реагирования на отсутствие оповещений о результате платежа и выполнения опроса состояния платежа.
- Предельное время — максимально допустимое время проведения платежа от момента его инициирования на стороне платёжной платформы до момента отправки инициатору оповещения о результате. Если платёж не был проведён или отклонён за это время, он автоматически переводится в статус
decline
. Для индивидуальной настройки предельного времени следует обращаться к специалистам технической поддержки ecommpay.
Сценарии использования
Проведение оплат с использованием метода «Оплаты с использованием наличных и интернет-банкинга в Бразилии» выполняется с перенаправлением пользователей к сервису провайдера, возвратов — с получением заявки от пользователя.
Рис.: Оплата через Payment Page
Рис.: Оплата через Gate
Рис.: Возврат через 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 — идентификатор пользователя в рамках проекта.
- Дополнительно рекомендуется использовать следующие параметры:
- customer_last_name — фамилия пользователя в рамках проекта (для предотвращения ошибок при проведении платежей рекомендуется указывать не менее 3 и не более 100 символов),
- identify_doc_number — номер документа, подтверждающего личность пользователя, который должен состоять из 11 или 14 цифр.
Если параметры отсутствуют в запросе, на Payment Page пользователю отображаются поля для ввода недостающих значений. Подробнее об уточнении параметров — в разделе Дополнение информации о платежах.
- Валютой платежа может быть только USD.
- Для предварительного выбора метода «Оплаты с использованием наличных и интернет-банкинга в Бразилии» необходимо указывать код платёжного метода в параметре force_payment_method —
online-brazil-banks
. - Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page. Детальная информация обо всех параметрах приведена в разделе Параметры вызова платёжной формы.
- После определения всех параметров необходимо составить подпись. Подробную информацию см. в Работа с подписью к данным.
Таким образом, корректный запрос на открытие платёжной формы с применением метода «Оплаты с использованием наличных и интернет-банкинга в Бразилии» должен содержать идентификаторы проекта, пользователя и платежа, код валюты и сумму платежа, информацию о пользователе и подпись:
{ payment_id: 'X03936', payment_amount: 1000, payment_currency: 'USD', customer_id: 'customer1', customer_last_name: 'Johnson', identify_doc_number: '12345678901', 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": "brazil", "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": "brazil", "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/banks/brazil/sale
, отправляемый методом POST. Этот запрос относится к следующей группе запросов /v2/payment/banks/{payment_method}/sale. - В запросе должны использоваться следующие объекты и параметры:
- general — объект, содержащий основные идентификационные сведения запроса:
- project_id — идентификатор проекта, полученный от ecommpay при интеграции;
- payment_id — идентификатор платежа, уникальный в рамках проекта;
- signature — подпись, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
- payment — объект, содержащий сведения о платеже:
- amount — целочисленная сумма платежа в дробных единицах валюты,
- currency — код валюты платежа в формате ISO-4217 alpha-3;
- customer — объект, содержащий сведения о пользователе:
- id — идентификатор в рамках проекта,
- ip_address — используемый IP-адрес;
- last_name — фамилия (для предотвращения ошибок при проведении платежей рекомендуется указывать не менее 3 и не более 100 символов);
- identify — объект, содержащий сведения о документе, подтверждающем личность:
- doc_number — номер документа, подтверждающего личность, который должен состоять из 11 или 14 цифр,
- return_url — объект, содержащий URL для перенаправления пользователя в веб-сервис:
- return — URL для перенаправления пользователя по нажатию кнопки на любом шаге оплаты.
- general — объект, содержащий основные идентификационные сведения запроса:
- Валютой платежа может быть только USD.
- Дополнительно могут использоваться все параметры, указанные в спецификации.
Таким образом, корректный запрос на оплату с применением метода «Оплаты с использованием наличных и интернет-банкинга в Бразилии» должен содержать идентификаторы проекта, пользователя и платежа, подпись, информацию о пользователе, код валюты и сумму платежа:
Рис.: Пример запроса на оплату
{ "general": { "project_id": 211, "payment_id": "payment_id", "signature": "PJkV8ej\/UG0Di8NN5e7cV+VHq3LwY3T\/pOMeSaRfBaNIipTv+AWoXW\/9MTO8yJA==" }, "payment": { "amount": 1000, "currency": "USD" }, "customer": { "last_name": "Johnson", "id": "123", "ip_address": "1.1.1.1", "identify": { "doc_number": "84887177100" }, }, "return_url": { "return": "http://example.com/return" } }
Форматы данных для перенаправления пользователей
Для перенаправления пользователя от веб-сервиса на сайт сервиса «Оплаты с использованием наличных и интернет-банкинга в Бразилии» необходимо принять оповещение от платёжной платформы, содержащее ссылку для перенаправления в параметре redirect_data.url и данные для отправки в теле запроса redirect_data.body, и использовать эти параметры при открытии HTML-страницы сайта методом, указанным в redirect_data.method.
Далее приведён фрагмент оповещения, содержащего данные для перенаправления.
"redirect_data": { "body": {...}, "method": "GET", "url": "http://example.test/" }
Формат оповещений
Для оповещений о результатах оплат с применением метода «Оплаты с использованием наличных и интернет-банкинга в Бразилии» используется стандартный формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 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": "brazil", "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": "brazil", "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 также могут быть полезны следующие материалы:
Возвраты через Gate
Общая информация
«Оплаты с использованием наличных и интернет-банкинга в Бразилии» поддерживает проведение полных и частичных возвратов. Для проведения возврата через Gate с использованием метода «Оплаты с использованием наличных и интернет-банкинга в Бразилии» со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ecommpay и принять оповещение о результате. Полная схема проведения возврата представлена далее.
Рис.: Проведение возврата через Gate
- Пользователь запрашивает возврат.
- От веб-сервиса на заданный URL ecommpay передаётся запрос на проведение возврата.
- Запрос на проведение возврата поступает в платёжную платформу ecommpay.
- Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
- От платёжной платформы к веб-сервису направляется ответ с информацией о получении запроса и его корректности. Подробнее см. в разделе Формат ответа.
- В платёжной платформе выполняются дальнейшая обработка запроса и его отправка в сервис «Оплаты с использованием наличных и интернет-банкинга в Бразилии».
- На стороне «Оплаты с использованием наличных и интернет-банкинга в Бразилии» выполняется обработка платежа.
- От «Оплаты с использованием наличных и интернет-банкинга в Бразилии» к платёжной платформе направляется оповещение о результате.
- От платёжной платформы к веб-сервису направляется оповещение о результате.
- От веб-сервиса пользователю направляется результат возврата.
Информация о формате запросов и параметрах инициации возвратов методом «Оплаты с использованием наличных и интернет-банкинга в Бразилии» через Gate, а также о формате оповещений о результатах возвратов приведена далее, общая информация о работе с API см. в разделе Работа с API.
Формат запросов
При работе с запросами на возврат с применением метода «Оплаты с использованием наличных и интернет-банкинга в Бразилии» необходимо учитывать следующее:
- Должен использоваться запрос
/v2/payment/banks/brazil/refund
, отправляемый методом POST. Этот запрос относится к следующей группе запросов /v2/payment/banks/{payment_method}/refund. - В запросе должны использоваться следующие объекты и параметры:
- general — объект, содержащий основные идентификационные сведения о запросе:
- project_id — идентификатор проекта;
- payment_id — идентификатор платежа;
- signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
- customer — объект, содержащий сведения о пользователе:
- ip_address — используемый IP-адрес;
- payment — объект, содержащий сведения о возврате :
- description — комментарий или описание возврата,
- amount — сумма возврата в дробных единицах валюты (обязательный при частичном возврате),
- currency — валюта возврата в формате ISO-4217 alpha-3 (обязательный при частичном возврате).
- general — объект, содержащий основные идентификационные сведения о запросе:
- Дополнительно могут использоваться все параметры, указанные в спецификации.
Таким образом, корректный запрос на возврат с применением метода «Оплаты с использованием наличных и интернет-банкинга в Бразилии» должен содержать идентификаторы проекта и платежа, подпись, описание возврата и IP-адрес пользователя:
Рис.: Пример запроса на возврат
"general": { "project_id": 211, "payment_id": "refund_02", "signature": "of8k9xerKSKpFBR4XL1QFaDH3p9Mh0CIcjmOwSwKJ7KLTZYO56lCv+f1M0Sf/7eg==" }, "payment": { "amount": 1000, "currency": "USD", "description": "refund" }, "customer": { "ip_address": "1.1.1.1" }
Формат оповещений
Для оповещений о результатах возврата с применением метода «Оплаты с использованием наличных и интернет-банкинга в Бразилии» используется стандартный формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 442
был успешно проведён возврат в размере 10,00 USD
.
Рис.: Пример оповещения о проведенном возврате
{ "project_id": 442, "payment": { "id": "1234", "type": "purchase", "status": "refunded", "date": "2020-12-13T08:19:43+0000", "method": "brazil", "sum": { "amount": 0, "currency": "USD" }, "description": "" }, "customer": { "id": "67881" }, "operation": { "id": 1000000011, "type": "refund", "status": "success", "date": "2020-12-13T08:19:43+0000", "created_date": "2020-12-13T08:19:38+0000", "request_id": "3a97fd62a7ad166700adcde96c21831b005a7d5c329cbc3c16e", "sum_initial": { "amount": 1000, "currency": "USD" }, "sum_converted": { "amount": 1000, "currency": "USD" }, "provider": { "id": 1284, "payment_id": "105115311", "date": "2020-12-13T08:19:41+0000", "auth_code": "" }, "code": "0", "message": "Success" }, "signature": "kpghwSQiaUa8+cX2vHbgmbT...6o2uQgLTqDvQtCMGGHHJpUqPc4CGzungYw==" }
В следующем примере возврат был отклонён.
Рис.: Пример оповещения об отказе в проведении возврата
{ "project_id": 442, "payment": { "id": "1234566", "type": "purchase", "status": "success", "date": "2020-12-13T08:18:43+0000", "method": "brazil", "sum": { "amount": 1000, "currency": "USD" }, "description": "" }, "customer": { "id": "67881" }, "operation": { "id": 1000000011, "type": "refund", "status": "decline", "date": "2020-12-13T08:19:43+0000", "created_date": "2020-12-13T08:18:44+0000", "request_id": "3a97fd62a7ad166700adcde96c2c3c16e", "sum_initial": { "amount": 1000, "currency": "USD" }, "sum_converted": { "amount": 1000, "currency": "USD" }, "provider": { "id": 1169, "payment_id": "105887607", "date": "2020-02-19T14:25:24+0000", "auth_code": "" }, "code": "0", "message": "Success" }, "signature": "kpghwSQiaUa8+cX2vHbgmbT...6o2uQgLTqDvQtCMGGHHJpUqPc4C4324gYw==" }
Дополнительные материалы
Для организации работы с возвратами через Gate также могут быть полезны следующие материалы:
Анализ результатов проведения платежей
Как и при работе с другими платёжными методами, которые предоставляет ecommpay, при использовании метода «Оплаты с использованием наличных и интернет-банкинга в Бразилии» доступны разные способы анализа информации о платежах и операциях с применением этого метода — как в отдельности, так и в совокупности с другими методами.
Всю необходимую информацию можно получать и анализировать средствами Dashboard , в том числе с помощью аналитических панелей в разделе Аналитика.
Также можно выгружать необходимую информацию для последующего анализа с помощью специализированных аналитических средств сторонних разработчиков:
- Dashboard позволяет выгружать данные в формате CSV с помощью инструментов в разделе Отчёты. При этом можно выполнять разовые и периодические выгрузки информации на локальный компьютер.
- Data API позволяет получать информацию в формате JSON и отправлять ее на заданный URL — для этого применяются запросы к конечной точке /operations/get.
С любыми вопросами о возможностях анализа результатов можно обращаться в службу технической поддержки ecommpay.