TrueMoney

Обзор

Введение

TrueMoney — метод, позволяющий проводить платежи батах с использованием банковских счетов в Тайланде. Для этого метода в платёжной платформе ecommpay поддерживаются оплаты.

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

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

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

Схема работы

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

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

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

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

	Суммы, THB ¹
	Минимум	Максимум
Оплаты	100,00	500 000,00

Прим.:

Более подробную информацию можно уточнять у курирующего менеджера ecommpay

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

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

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

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

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

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

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

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

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

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

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

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

Должен использоваться базовый минимум параметров, обязательный для любого платежа:
- 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.
Валютой платежа может быть только THB.
Для предварительного выбора метода TrueMoney необходимо указывать код платёжного метода в параметре force_payment_method — true-money.
Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page. Детальная информация обо всех параметрах приведена в разделе Параметры вызова платёжной формы.
После определения всех параметров необходимо составить подпись (подробнее).

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

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 10000,
   "payment_currency": "THB",
   "customer_id": "customer1",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

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

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 10000,
   "payment_currency": "THB",
   "customer_id": "customer1",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

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

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

В следующем примере оповещение свидетельствует о том, что в рамках проекта 12345 была проведена оплата в размере 100,00 THB.

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

 {
        "customer": {
            "id": "customer1"
        },
        "project_id": 12345,
        "payment": {
            "id": "payment1234",
            "type": "purchase",
            "status": "success",
            "date": "2021-10-12T08:16:05+0000",
            "method": "true-money",
            "sum": {
                "amount": 10000,
                "currency": "THB"
            },
            "description": ""
        },
        "operation": {
            "id": 5054705010079872,
            "type": "sale",
            "status": "success",
            "date": "2021-10-12T08:16:05+0000",
            "created_date": "2021-10-12T08:14:01+0000",
            "request_id": "a41fcbe99835e5fbc69770344bce...cc2f804083379379c2da5-05054706",
            "sum_initial": {
                "amount": 10000,
                "currency": "THB"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "THB"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 6641,
                "payment_id": "2021101203031281",
                "auth_code": ""
            }
        },
        "signature": "EIrbFLdIqieeX/Oi2Xl/3xADlmidzSRqKsFz7VX5s...wKVXTkpC2CNA=="
    }

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

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

{
        "customer": {
            "id": "1"
        },
        "project_id": 67890,
        "payment": {
            "id": "payment5678",
            "type": "purchase",
            "status": "decline",
            "date": "2021-10-13T08:10:17+0000",
            "method": "true-money",
            "sum": {
                "amount": 10000,
                "currency": "THB"
            },
            "description": "TEST_PAYMENT_812515"
        },
        "operation": {
            "id": 5000375010078322,
            "type": "sale",
            "status": "decline",
            "date": "2021-10-13T08:10:17+0000",
            "created_date": "2021-10-12T08:10:11+0000",
            "request_id": "6d2129131a347e8107b6bc2e3249f13...a483c36017-05000376",
            "sum_initial": {
                "amount": 10000,
                "currency": "THB"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "THB"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 6641,
                "payment_id": "",
                "auth_code": ""
            }
        },
        "signature": "bRj3VHm1qT1/RRrWrqW9LwxM5C9bTpoTx7Ip...emz2GxIdEyAeC4oA8w=="
    }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

{
  "general": {
    "project_id": 210,
    "payment_id": "test_payment",
    "signature": "PJkV8ej\/UG0Di8hTng6JvipTv+AWoXW\/9MTO8yJA=="
  },
  "payment": {
    "amount": 10000,
    "currency": "THB"
  },
  "customer": {
    "id": "customer123",
    "ip_address": "192.0.2.0"
  },
    "return_url":{
      "success" : "http://example.com",
      "decline" : "http://anotherexample.com"
  }
}

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

{
  "general": {
    "project_id": 210,
    "payment_id": "test_payment",
    "signature": "PJkV8ej\/UG0Di8hTng6JvipTv+AWoXW\/9MTO8yJA=="
  },
  "payment": {
    "amount": 10000,
    "currency": "THB"
  },
  "customer": {
    "id": "customer123",
    "ip_address": "192.0.2.0"
  },
    "return_url":{
      "success" : "http://example.com",
      "decline" : "http://anotherexample.com"
  }
}

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

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

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

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

    "redirect_data": {
        "body": {
            "Data": "4dg65h72G63k68g61J6eK74I49h44i3dj41H454J4dK42I2eh46i54j",
            "Remarks": "",
            "EncryptText": "8F4AC9ED17D1579A7DE5121B16A45B4F"
        },
        "method": "POST",
        "url": "https://www.example.com/pay"
    }

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

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

 {
        "customer": {
            "id": "customer1"
        },
        "project_id": 12345,
        "payment": {
            "id": "payment1234",
            "type": "purchase",
            "status": "success",
            "date": "2021-10-12T08:16:05+0000",
            "method": "true-money",
            "sum": {
                "amount": 10000,
                "currency": "THB"
            },
            "description": ""
        },
        "operation": {
            "id": 5054705010079872,
            "type": "sale",
            "status": "success",
            "date": "2021-10-12T08:16:05+0000",
            "created_date": "2021-10-12T08:14:01+0000",
            "request_id": "a41fcbe99835e5fbc69770344bce...cc2f804083379379c2da5-05054706",
            "sum_initial": {
                "amount": 10000,
                "currency": "THB"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "THB"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 6641,
                "payment_id": "2021101203031281",
                "auth_code": ""
            }
        },
        "signature": "EIrbFLdIqieeX/Oi2Xl/3xADlmidzSRqKsFz7VX5s...wKVXTkpC2CNA=="
    }

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

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

{
        "customer": {
            "id": "1"
        },
        "project_id": 67890,
        "payment": {
            "id": "payment5678",
            "type": "purchase",
            "status": "decline",
            "date": "2021-10-13T08:10:17+0000",
            "method": "true-money",
            "sum": {
                "amount": 10000,
                "currency": "THB"
            },
            "description": ""
        },
        "operation": {
            "id": 5000375010078322,
            "type": "sale",
            "status": "decline",
            "date": "2021-10-13T08:10:17+0000",
            "created_date": "2021-10-12T08:10:11+0000",
            "request_id": "6d2129131a347e8107b6bc2e3249f13...a483c36017-05000376",
            "sum_initial": {
                "amount": 10000,
                "currency": "THB"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "THB"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 6641,
                "payment_id": "",
                "auth_code": ""
            }
        },
        "signature": "bRj3VHm1qT1/RRrWrqW9LwxM5C9bTpoTx7Ip...emz2GxIdEyAeC4oA8w=="
    }

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

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

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

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

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

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

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

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

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