Оплаты с использованием наличных и интернет-банкинга в Мексике

Обзор

Введение

«Оплаты с использованием наличных и интернет-банкинга в Мексике» — метод, позволяющий проводить платежи в долларах США с использованием наличных и банковских счетов в Мексике. Для этого метода в платёжной платформе ecommpay поддерживаются оплаты и возвраты.

В этой статье представлена информация о работе с методом «Оплаты с использованием наличных и интернет-банкинга в Мексике»: обзорный раздел с общими сведениями и последующие разделы с информацией о действиях, необходимых со стороны мерчанта для решения разных задач.

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

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

Схема работы

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

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

Для проведения платежей и выполнения операций с использованием метода «Оплаты с использованием наличных и интернет-банкинга в Мексике» могут применяться различные интерфейсы платёжной платформы. Так, оплаты могут проводиться через Payment Page, Gate и Dashboard (с применением платёжных ссылок), а возвраты — через Gate и Dashboard. При этом, независимо от используемых интерфейсов, для этого метода характерны следующие свойства и ограничения.

При работе с методом «Оплаты с использованием наличных и интернет-банкинга в Мексике», независимо от используемых интерфейсов, актуальны следующие свойства и ограничения.

	Суммы		Время ¹
	Минимум	Максимум	Базовое	Предельное
Оплаты	–	эквивалент 190 000,00 MXN в 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, приведена далее в этом разделе; общая информация о работе с Payment Page API — в отдельной статье Организация взаимодействия.

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

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

Должен использоваться базовый минимум параметров, обязательный для любого платежа:
- project_id — идентификатор проекта, полученный от ecommpay при интеграции;
- payment_id — идентификатор платежа, уникальный в рамках проекта;
- payment_currency — код валюты платежа в формате ISO-4217 alpha-3;
- payment_amount — сумма платежа в дробных единицах валюты;
- customer_id — идентификатор пользователя в рамках проекта.
Должен использоваться базовый минимум параметров: project_id, payment_id, payment_currency, payment_amount, customer_id.
Валютой платежа может быть только USD.
Дополнительно рекомендуется указывать фамилию пользователя в параметре customer_last_name (для предотвращения ошибок при проведении платежей рекомендуется указывать не менее 3 и не более 100 символов). Если параметр отсутствует в запросе, в платёжной форме могут отображаться поля для ввода пользователем недостающих значений (подробнее — в разделе Дополнение информации о платежах).
Для предварительного выбора метода «Оплаты с использованием наличных и интернет-банкинга в Мексике» необходимо указывать код этого метода в параметре force_payment_method — online-mexico-banks.
Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page (подробнее).
После указания всех целевых параметров необходимо составлять подпись (подробнее).

Таким образом, корректный запрос на открытие платёжной формы с применением метода «Оплаты с использованием наличных и интернет-банкинга в Мексике» должен содержать идентификатор проекта, базовые сведения о платеже (идентификатор, сумму и код валюты), идентификатор и фамилию пользователя, а также подпись.

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 1000,
   "payment_currency": "USD",
   "customer_id": "customer1",
   "customer_last_name": "Johnson",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

Рис.: Пример достаточного набора данных для запроса на оплату

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 1000,
   "payment_currency": "USD",
   "customer_id": "customer1",
   "identify_doc_number": "12345678901",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/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": "mexico",
            "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": "mexico",
            "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 также могут быть полезны следующие материалы:

Организация взаимодействия — о том, как организовать взаимодействие веб-сервиса с платёжной платформой через Payment Page.
Работа с подписью к данным — о порядке создания и проверки подписи в программных запросах и оповещениях при взаимодействии с платёжной платформой.
Модель проведения платежей — о типах, схемах проведения и возможных статусах поддерживаемых платежей и операций.
Разовая оплата в одну стадию — о том, как проводить разовые оплаты через Payment Page.
Информация о выполнении операций — о служебных кодах, которые используются в платёжной платформе, чтобы фиксировать информацию о выполнении операций.

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

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

Для проведения оплаты через Gate с использованием метода «Оплаты с использованием наличных и интернет-банкинга в Мексике» со стороны веб-сервиса необходимо:

Отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ecommpay.
Принять промежуточное оповещение от платёжной платформы и осуществить перенаправление пользователя к сервису «Оплаты с использованием наличных и интернет-банкинга в Мексике».
Принять итоговое оповещение от платёжной платформы.

Полная схема проведения оплаты выглядит следующим образом.

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

Пользователь на стороне веб-сервиса инициирует оплату с использованием метода «Оплаты с использованием наличных и интернет-банкинга в Мексике».
От веб-сервиса на заданный URL ecommpay передаётся запрос на проведение оплаты через Gate.
Запрос на проведение оплаты поступает в платёжную платформу ecommpay.
В платёжной платформе выполняется приём запроса с проверкой наличия обязательных параметров и корректной подписи.
От платёжной платформы к веб-сервису направляется ответ с информацией о получении запроса и его корректности (подробнее).
В платёжной платформе выполняются дальнейшая обработка запроса (с проверкой согласованности параметров) и его оправка в сервис «Оплаты с использованием наличных и интернет-банкинга в Мексике».
В сервисе «Оплаты с использованием наличных и интернет-банкинга в Мексике» выполняется обработка запроса на оплату.
От сервиса «Оплаты с использованием наличных и интернет-банкинга в Мексике» к платёжной платформе передаются данные для перенаправления пользователя к сервису «Оплаты с использованием наличных и интернет-банкинга в Мексике».
От платёжной платформы к веб-сервису направляется оповещение с данными для перенаправления пользователя к сервису «Оплаты с использованием наличных и интернет-банкинга в Мексике».
Пользователь перенаправляется к сервису «Оплаты с использованием наличных и интернет-банкинга в Мексике».
Пользователь выполняет необходимые действия для оплаты.
В сервисе «Оплаты с использованием наличных и интернет-банкинга в Мексике» выполняется обработка платежа.
Пользователю отображается информация о результате оплаты.
Пользователь перенаправляется к веб-сервису.
От сервиса «Оплаты с использованием наличных и интернет-банкинга в Мексике» к платёжной платформе направляется информация о результате оплаты.
От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
На стороне веб-сервиса обеспечивается информирование пользователя о результате оплаты.

Информация о форматах запросов и оповещений, используемых для проведения оплат методом «Оплаты с использованием наличных и интернет-банкинга в Мексике» через Gate, приведена далее в этом разделе; общая информация о работе с Gate API — в отдельной статье Организация взаимодействия.

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

При работе с запросами на оплаты с применением метода «Оплаты с использованием наличных и интернет-банкинга в Мексике» необходимо учитывать следующее:

Для инициирования каждой оплаты должен использоваться отдельный POST-запрос к конечной точке /v2/payment/banks/mexico/sale. Эта точка относится к группе /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 символов);,
- return_url — объект, содержащий URL для перенаправления пользователя в веб-сервис:
  - return — URL для перенаправления пользователя по нажатию кнопки на любом шаге оплаты.
Валютой платежа может быть только USD.
Дополнительно могут использоваться любые другие параметры из числа указанных в спецификации.

Таким образом, корректный запрос на оплату с применением метода «Оплаты с использованием наличных и интернет-банкинга в Мексике» должен содержать идентификатор проекта, базовые сведения о платеже (идентификатор, сумму и код валюты), идентификатор, IP-адрес и фамилию пользователя, URL для перенаправления, а также подпись.

{
    "general": {
      "project_id": 211,
      "payment_id": "payment_id",
      "signature": "PJkV8ej\/UG0Di8NN5e7cV+VIipTv+AWoXW\/9MTO8yJA=="
    },
    "payment": {
      "amount": 1000,
      "currency": "USD"
    },
    "customer": {
      "last_name": "Johnson",
      "id": "123",
      "ip_address": "192.0.2.0"
    },
    "return_url": {
      "return": "http://example.com/return"
    }  
}

Рис.: Пример достаточного набора данных для запроса на оплату

{
    "general": {
      "project_id": 211,
      "payment_id": "payment_id",
      "signature": "PJkV8ej\/UG0Di8NN5e7cV+VIipTv+AWoXW\/9MTO8yJA=="
    },
    "payment": {
      "amount": 1000,
      "currency": "USD"
    },
    "customer": {
      "last_name": "Johnson",
      "id": "123",
      "ip_address": "192.0.2.0"
    },
    "return_url": {
      "return": "http://example.com/return"
    }  
}

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

Для перенаправления пользователей от веб-сервиса мерчанта к сервису «Оплаты с использованием наличных и интернет-банкинга в Мексике» при проведении каждого платежа с использованием метода «Оплаты с использованием наличных и интернет-банкинга в Мексике» необходимо принять промежуточное оповещение от платёжной платформы и использовать информацию из него, включённую в объект redirect_data. Формат таких оповещений является типовым (подробнее), при этом в состав объекта redirect_data включаются следующие объекты и параметры:

body — объект с данными для отправки в теле запроса;
method — параметр с указанием HTTP-метода отправки запроса (GET или POST);
url — параметр со ссылкой для перенаправления.

Рис.: Пример объекта redirect_data

  "redirect_data": {
    "body": {...},
    "method": "GET",
    "url": "https://www.example.com/pay"
  }

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

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

{
        "project_id": 239,
        "payment": {
            "id": "S0100_20200626_102701_21215202",
            "type": "purchase",
            "status": "success",
            "date": "2020-06-26T07:27:11+0000",
            "method": "mexico",
            "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": "mexico",
            "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.
Информация об операциях — о служебных кодах, используемых в платёжной платформе для фиксации информации о выполнении операций.

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

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

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

Рис.: Выполнение возврата через Gate. Описание шагов

Пользователь инициирует возврат.
От веб-сервиса на заданный URL ecommpay передаётся запрос на выполнение возврата.
Запрос на выполнение возврата поступает в платёжную платформу ecommpay.
В платёжной платформе выполняется приём запроса с проверкой наличия обязательных параметров и корректной подписи.
От платёжной платформы к веб-сервису направляется ответ с информацией о получении запроса и его корректности (подробнее).
В платёжной платформе обеспечиваются дальнейшая обработка запроса (с проверкой согласованности параметров) и его отправка в сервис «Оплаты с использованием наличных и интернет-банкинга в Мексике».
В сервисе «Оплаты с использованием наличных и интернет-банкинга в Мексике» выполняется обработка возврата.
От сервиса «Оплаты с использованием наличных и интернет-банкинга в Мексике» к платёжной платформе направляется информация о результате возврата.
От платёжной платформы к веб-сервису направляется оповещение о результате возврата.
На стороне веб-сервиса обеспечивается информирование пользователя о результате возврата.

Информация о форматах запросов и оповещений, используемых для выполнения возвратов методом «Оплаты с использованием наличных и интернет-банкинга в Мексике» через Gate, приведена далее в этом разделе; общая информация о работе с Gate API — в отдельной статье Организация взаимодействия.

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

При работе с запросами на возврат с применением метода «Оплаты с использованием наличных и интернет-банкинга в Мексике» необходимо учитывать следующее:

Для инициирования каждого возврата должен использоваться отдельный POST-запрос к конечной точке /v2/payment/banks/mexico/refund. Эта точка относится к группе /v2/payment/banks/{payment_method}/refund.
В каждом запросе должны использоваться следующие объекты и параметры:
- general — объект, содержащий основные идентификационные сведения запроса:
  - project_id — идентификатор проекта, полученный от ecommpay при интеграции;,
  - payment_id — идентификатор платежа, для которого необходимо выполнить возврат;,
  - signature — подпись запроса, составленная после указания всех целевых параметров (подробнее — в разделе Работа с подписью к данным); (подробнее)),
- payment — объект, содержащий сведения о возврате:
  - description — комментарий к возврату или его описание;,
  - amount — сумма возврата в дробных единицах валюты (является обязательной при частичном возврате);,
  - currency — код валюты возврата в формате ISO-4217 alpha-3 (является обязательным при частичном возврате);,
  - customer — объект, содержащий сведения о пользователе:
    - ip_address — IP-адрес пользователя, актуальный для инициируемого возврата.
Дополнительно могут использоваться любые другие параметры из числа указанных в спецификации.

Таким образом, корректный запрос на возврат с применением метода «Оплаты с использованием наличных и интернет-банкинга в Мексике» должен содержать идентификаторы проекта и платежа, описание возврата, IP-адрес пользователя, подпись, а также, при необходимости, код валюты и сумму возврата.

{
  "general": {
    "project_id": 210,
    "payment_id": "test_payment",
    "signature": "PJkV8ej\/UG0Di8hTng6JvipTv+AWoXW\/9MTO8yJA=="
  },
  "payment": {
    "description": "test refund",
    "amount": 1000,
    "currency": "USD"
  },
  "customer": {
    "ip_address": "192.0.2.0"
  }
}

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

{
  "general": {
    "project_id": 210,
    "payment_id": "test_payment",
    "signature": "PJkV8ej\/UG0Di8hTng6JvipTv+AWoXW\/9MTO8yJA=="
  },
  "payment": {
    "description": "test refund",
    "amount": 1000,
    "currency": "USD"
  },
  "customer": {
    "ip_address": "192.0.2.0"
  }
}

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

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

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

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

{
        "project_id": 442,
        "payment": {
            "id": "1234",
            "type": "purchase",
            "status": "refunded",
            "date": "2020-12-13T08:19:43+0000",
            "method": "mexico",
            "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+cX26o2uQgLTqDvQtCMGGHHJpUqPc4CGzungYw=="
    }

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

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

{
        "project_id": 442,
        "payment": {
            "id": "1234566",
            "type": "purchase",
            "status": "success",
            "date": "2020-12-13T08:18:43+0000",
            "method": "mexico",
            "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+6o2uQgLTqDvQtCMGGHHJpUqPc4C4324gYw=="
    }

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

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

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

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

Для анализа информации о платежах и операциях, как в отдельности по методу «Оплаты с использованием наличных и интернет-банкинга в Мексике», так и в совокупности с другими методами, можно использовать:

инструментарий интерфейса Dashboard, с различными реестрами и аналитическими панелями;,
отчёты в формате CSV, выгружаемые (как разово, так и периодически) через раздел Отчёты интерфейса Dashboard;,
данные в формате JSON, получаемые по программным запросам через интерфейс Data API.

С вопросами по анализу информации можно обращаться к разделам документации (Dashboard и Использование Data API) и специалистам ecommpay.