Singapore Online Banking

Обзор

Введение

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

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

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

Тип платёжного метода банковские платежи
Платёжные инструменты банковские счета
Регионы использования SG
Валюты платежей SGD
Конвертация валют на стороне ecommpay
Разовые оплаты +
Полные возвраты
Частичные возвраты
Выплаты +
Опротестования
Особенности при работе с Payment Page поддерживаются разные варианты выбора банка (подробнее)
Организация и стоимость подключения по согласованию с курирующим менеджером ecommpay

Схема работы

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



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

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

При работе с методом Singapore Online Banking применяются следующие ограничения по суммам отдельных операций.

Суммы, SGD
минимум максимум
Оплаты 10,00 30 000,00
Выплаты 10,00 10 000,00

Ограничения по времени выполнения операций зависят от банков, поддерживающих этот метод.

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

Проведение оплат с использованием метода Singapore Online Banking осуществляется с перенаправлением пользователей к сервисам банков, поддерживающих работу с этим методом, проведение выплат — с уведомлением пользователей через веб-сервис мерчанта.

Пользовательский сценарий оплаты через Payment Page (в базовом варианте с выбором пользователем метода и банка и перенаправлением с итоговой страницы платёжной формы к веб-сервису) выглядит следующим образом.

Общие сценарии проведения оплат и выплат можно представить следующим образом.

Сценарии выполнения операций через основные интерфейсы платёжной платформы соответствуют представленным на схемах. При использовании дополнительных возможностей (таких как платёжные ссылки) сценарии выполнения операций методом Singapore Online Banking соответствуют специфике этих возможностей.

Вместе с тем, к особенностям работы с методом Singapore Online Banking можно отнести то, что для каждого платежа с использованием этого метода должен быть выбран конкретный банк. При работе через Payment Page, как правило, выбор банка осуществляется пользователем уже в платёжной форме, но при вызовах Payment Page с предварительным выбором метода и банка, а также при инициировании оплат и выплат через Gate банк должен быть выбран на стороне веб-сервиса и в запросах должен указываться идентификатор этого банка. Возможные варианты выбора банка при работе через Payment Page описаны в разделе Оплаты через Payment Page этой статьи, а способы работы с идентификаторами банков — в следующем подразделе, Поддержка со стороны банков.

Вместе с тем, для оплат этим методом поддерживаются разные варианты выбора банка; они описаны в разделе Оплаты через Payment Page этой статьи.

Поддержка со стороны банков

В следующей таблице в ознакомительных целях приведены названия и идентификаторы банков, поддерживающих работу с методом Singapore Online Banking.

Табл. 1. Список банков
Банк ID Оплаты Выплаты
DBS Bank Singapore 57001 + +
OCBC Bank Singapore 57011 + +
UOB Singapore 57021 + +

Поскольку со временем состав доступных банков может меняться, для получения актуальной информации рекомендуется использовать POST-запрос к конечной точке /v2/info/banks/singapore/sale/list, которая относится к группе конечных точек /v2/info/banks/{payment_method}/{operationType}/list Gate API. В этом запросе должны указываться идентификатор проекта, идентификатор, валюта и сумма платежа и подпись к этим данным; при этом рекомендуется передавать реальные данные о платеже, но допускается и указание произвольных значений.

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

{
    "general": {
        "project_id": 200,
        "payment_id": "ORDER_155860015",
        "signature": "K6jllym+PtObocZtr345st...=="
    },
    "payment": {
        "amount": 16000,
        "currency": "SGD"
    }
}

Рис.: Пример данных из ответа с информацией о банках

[
  {
    "id": 57001, // Индентификатор банка
    "abbr": "DBSSGD", // Служебная аббревиатура банка, используемая в платформе
    "name": "DBS Bank Singapore", // Основное (международное) название банка
    "nativeName": "DBS Bank Singapore", // Локальное (национальное или региональное) название банка
    "currencies": [ // Массив с информацией о валютах, поддерживаемых банком
      {
        "id": 1087, // Идентификатор валюты в платёжной платформе
        "alpha_3_4217": "SGD", // Буквенный код валюты платежа в формате ISO-4217 alpha-3
        "number_3_4217": "702", // Цифровой код валюты платежа в формате ISO-4217 alpha-3
        "exponent": 2 // Число дробных разрядов валюты
      }
    ]
  }
]

С вопросами о работе с банками, поддерживающими метод Singapore Online Banking, можно обращаться к курирующему менеджеру ecommpay.

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

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

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



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

  1. Пользователь на стороне веб-сервиса инициирует оплату.
  2. От веб-сервиса на заданный URL ecommpay передаётся запрос на проведение оплаты через Payment Page.
  3. Запрос на проведение оплаты поступает в платёжную платформу.
  4. В платёжной платформе выполняется приём запроса, с проверкой наличия обязательных параметров и корректной подписи.
  5. Осуществляется подготовка Payment Page согласно параметрам проекта и вызова.
  6. Пользователю отображается платёжная форма.
  7. Пользователь выбирает для оплаты метод Singapore Online Banking, а также один из банков, поддерживающих работу с этим методом.
  8. В платёжную платформу передаётся запрос на проведение оплаты через выбранный банк.
  9. В платёжной платформе выполняются обработка полученного запроса и его отправка в сервис банка.
  10. В сервисе банка выполняется обработка запроса на оплату.
  11. От сервиса банка к платёжной платформе передаются данные для перенаправления пользователя к сервису банка.
  12. Данные для перенаправления пользователя передаются к Payment Page.
  13. Пользователь перенаправляется к сервису банка.
  14. Пользователь выполняет необходимые действия для оплаты.
  15. В сервисе банка выполняется обработка платежа.
  16. Информация о результате оплаты отображается пользователю в сервисе банка.
  17. Пользователь перенаправляется к Payment Page.
  18. От сервиса банка к платёжной платформе направляется информация о результате оплаты.
  19. От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
  20. От платёжной платформы к Payment Page направляется информация о результате оплаты.
  21. Информация о результате оплаты отображается пользователю на Payment Page.

Как правило, после того как пользователь на стороне веб-сервиса подтверждает готовность перейти к оплате, он перенаправляется к Payment Page, выбирает платёжный метод и, в случае работы с методом Singapore Online Banking, дополнительно выбирает один из доступных банков. Вместе с тем, в некоторых ситуациях могут быть актуальны другие варианты выбора платёжного метода и банка. Например, при открытии Payment Page можно сразу перенаправлять пользователя к выбору банка либо ограничивать список поддерживаемых банков для отдельного платежа и отображать пользователю только кнопки выбора целевых банков. Конкретный вариант выбора платёжного метода и банка определяется через параметры, указанные в запросе на открытие Payment Page (подробнее далее), при этом допустимы следующие варианты:

  • 1 — при открытии платёжной формы в ней последовательно отображаются отдельные страницы для выбора метода и банка, и пользователь выбирает сначала метод, а затем банк (этот вариант используется по умолчанию);
  • 2 — при открытии платёжной формы в ней отображается страница с кнопками выбора методов и банков для данного метода, и пользователь выбирает один из этих банков;
  • 3 — при открытии платёжной формы в ней отображается страница с кнопками выбора всех доступных банков для данного метода, и пользователь выбирает один из этих банков;
  • 4 — при открытии платёжной формы в ней отображается страница с кнопками выбора заданных банков для данного метода, и пользователь выбирает один из этих банков;
  • 5 — при открытии платёжной формы в ней отображается страница подтверждения перенаправления к сервису заданного банка, и пользователь соглашается с этим перенаправлением.

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

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

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

  1. Должен использоваться базовый минимум параметров, обязательный для любого платежа:
    • project_id — идентификатор проекта, полученный от ecommpay при интеграции;
    • payment_id — идентификатор платежа, уникальный в рамках проекта;
    • payment_currency — код валюты платежа в формате ISO-4217 alpha-3;
    • payment_amount — сумма платежа в дробных единицах валюты;
    • customer_id — идентификатор пользователя в рамках проекта.
  2. Должен использоваться базовый минимум параметров: project_id, payment_id, payment_currency, payment_amount, customer_id.
  3. Вариант выбора банка может определяться следующим образом:

    1. Через выбор в Payment Page метода и банка (1) — как вариант по умолчанию, применяемый, если не указываются параметр force_payment_method и объект payment_methods_options, упоминаемые в подпунктах 2–5.
    2. Через выбор в Payment Page банка среди методов (2) — для этого в объекте payment_methods_options необходимо указывать объект online_singapore_banks, содержащий параметр split_banks со значением true:
      "payment_methods_options": "{\"online_singapore_banks\": {\"split_banks\": true}}"
    3. Через выбор в Payment Page банка из числа доступных (3) — для этого в параметре force_payment_method необходимо указывать код предварительного выбора метода online-singapore-banks.
    4. Через выбор в Payment Page банка из числа заданных (4) — для этого необходимо указывать:
      • код online-singapore-banks в параметре force_payment_method;
      • объект payment_methods_options с объектом online_singapore_banks, который должен содержать параметр split_banks со значением true и объект banks_id с массивом, включающим в себя идентификаторы целевых банков:
        "payment_methods_options": "{\"online_singapore_banks\": {"\split_banks\": true, "banks_id": [57001, 57011]}}"
    5. Через подтверждение в Payment Page перенаправления к сервису заданного банка (5) — для этого необходимо указывать:
      • код online-singapore-banks в параметре force_payment_method;
      • объект payment_methods_options с объектом online_singapore_banks, который должен содержать параметр split_banks со значением true и объект banks_id с массивом, включающим в себя идентификатор целевого банка:
        "payment_methods_options": "{\"online_singapore_banks\": {"\split_banks\": true, "banks_id": [57001]}}"
  4. Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page (подробнее).
  5. После указания всех целевых параметров необходимо составлять подпись (подробнее).

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

{
   "project_id": 55120,
   "payment_id": "58550",
   "payment_amount": 34000,
   "payment_currency": "SGD",
   "customer_id": "customer55",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

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

{
   "project_id": 55120,
   "payment_id": "58550",
   "payment_amount": 34000,
   "payment_currency": "SGD",
   "customer_id": "customer55",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

Вместе с тем, в случае с выбором из заданных банков (4), запрос на открытие Payment Page может содержать расширенный набор данных.

{
   "project_id": 55120,
   "payment_id": "58550",
   "payment_amount": 34000,
   "payment_currency": "SGD",
   "customer_id": "customer55",
   "force_payment_method": "online-singapore-banks",
   "payment_methods_options": "{\"online_singapore_banks\": {"\split_banks\": true, "banks_id": [57001, 57011]}}",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

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

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

В следующем примере оповещение свидетельствует о том, что в рамках проекта 55120 для пользователя customer55 была проведена оплата в размере 340,00 SGD.

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

{
        "project_id": 55120,
        "payment": {
            "id": "58550",
            "type": "purchase",
            "status": "success",
            "date": "2022-08-26T11:06:48+0000",
            "method": "Singapore Banks",
            "sum": {
                "amount": 34000,
                "currency": "SGD"
            },
            "description": "PAYMENT_58550"
        },
        "customer": {
            "id": "customer55"
        },
        "operation": {
            "sum_initial": {
                "amount": 34000,
                "currency": "SGD"
            },
            "sum_converted": {
                "amount": 34000,
                "currency": "SGD"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 1111,
                "payment_id": "76666444",
                "auth_code": ""
            },
            "id": 544440057601,
            "type": "sale",
            "status": "success",
            "date": "2022-08-26T11:06:48+0000",
            "created_date": "2022-08-26T10:57:40+0000",
            "request_id": "bd8da81f8b73a960160b0ec44b8e9dfc2-00016185..."
        },
        "signature": "ly/4qzq1eDzKI9nwJe7N8aA9JcAjXoDjreWr9876FKm3eO+gaMA=="
    }

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

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

{
        "project_id": 55541,
        "payment": {
            "id": "PAYMENT_2745550925",
            "type": "purchase",
            "status": "decline",
            "date": "2022-08-26T11:06:48+0000",
            "method": "Singapore Banks",
            "sum": {
                "amount": 1000,
                "currency": "SGD"
            },
            "description": "PAYMENT_270925"
        },
        "customer": {
            "id": "424222"
        },
        "operation": {
            "sum_initial": {
                "amount": 1000,
                "currency": "SGD"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "SGD"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 61112,
                "payment_id": "64534535318185",
                "auth_code": ""
            },
            "id": 16464535601,
            "type": "sale",
            "status": "decline",
            "date": "2022-08-26T11:06:48+0000",
            "created_date": "2022-08-26T10:57:40+0000",
            "request_id": "bd8daae913d8a81f8b73a960160b0ec44b8e9dfc2-00016185..."
        },
        "signature": "ly/4qzq1eDzKI9nwJe7N8aA9JcAjXoDjreWru++Oc+inFKm3eO+gaMA=="
    }

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

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

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

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

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

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

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



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

  1. Пользователь на стороне веб-сервиса инициирует оплату с использованием метода Singapore Online Banking.
  2. От веб-сервиса на заданный URL ecommpay передаётся запрос на проведение оплаты через Gate.
  3. Запрос на проведение оплаты поступает в платёжную платформу ecommpay.
  4. В платёжной платформе выполняется приём запроса с проверкой наличия обязательных параметров и корректной подписи.
  5. От платёжной платформы к веб-сервису направляется ответ с информацией о получении запроса и его корректности (подробнее).
  6. В платёжной платформе выполняются дальнейшая обработка запроса (с проверкой согласованности параметров) и его оправка в сервис банка.
  7. В сервисе банка выполняется обработка запроса на оплату.
  8. От сервиса банка к платёжной платформе передаются данные для перенаправления пользователя к сервису банка.
  9. От платёжной платформы к веб-сервису направляется оповещение с данными для перенаправления пользователя на сайт банка.
  10. Пользователь перенаправляется к сервису банка.
  11. Пользователь выполняет необходимые действия для оплаты.
  12. В сервисе банка выполняется обработка платежа.
  13. Пользователю отображается информация о результате оплаты.
  14. Пользователь перенаправляется к веб-сервису.
  15. От сервиса банка к платёжной платформе направляется информация о результате оплаты.
  16. От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
  17. На стороне веб-сервиса обеспечивается информирование пользователя о результате оплаты.

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

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

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

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

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

{
  "general": {
    "project_id": 55120,
    "payment_id": "5855055",
    "signature": "PJkV8ej\/UG0Di8hTng6JvipTv+AWoXW\/9MTO8yJA=="
  },
  "payment": {
    "amount": 34000,
    "currency": "SGD"
  },
  "account":{
    "bank_id": 140
   },
  "customer": {
    "id": "customer123",
    "ip_address": "192.0.2.0"
  }
}

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

{
  "general": {
    "project_id": 55120,
    "payment_id": "5855055",
    "signature": "PJkV8ej\/UG0Di8hTng6JvipTv+AWoXW\/9MTO8yJA=="
  },
  "payment": {
    "amount": 34000,
    "currency": "SGD"
  },
  "account":{
    "bank_id": 140
   },
  "customer": {
    "id": "customer123",
    "ip_address": "192.0.2.0"
  }
}

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

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

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

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

"redirect_data": {
            "body": {},
            "method": "POST",
            "url": "https://www.example.com/payment.php"
        },

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

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

В следующем примере оповещение свидетельствует о том, что в рамках проекта 55120 для пользователя customer55 была проведена оплата в размере 340,00 SGD.

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

{
        "project_id": 55120,
        "payment": {
            "id": "58550",
            "type": "purchase",
            "status": "success",
            "date": "2022-08-26T11:06:48+0000",
            "method": "Singapore Banks",
            "sum": {
                "amount": 34000,
                "currency": "SGD"
            },
            "description": "PAYMENT_58550"
        },
        "customer": {
            "id": "customer55"
        },
        "operation": {
            "sum_initial": {
                "amount": 34000,
                "currency": "SGD"
            },
            "sum_converted": {
                "amount": 34000,
                "currency": "SGD"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 1111,
                "payment_id": "76666444",
                "auth_code": ""
            },
            "id": 544440057601,
            "type": "sale",
            "status": "success",
            "date": "2022-08-26T11:06:48+0000",
            "created_date": "2022-08-26T10:57:40+0000",
            "request_id": "bd8da81f8b73a960160b0ec44b8e9dfc2-00016185..."
        },
        "signature": "ly/4qzq1eDzKI9nwJe7N8aA9JcAjXoDjreWr9876FKm3eO+gaMA=="
    }

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

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

{
        "project_id": 55541,
        "payment": {
            "id": "PAYMENT_2745550925",
            "type": "purchase",
            "status": "decline",
            "date": "2022-08-26T11:06:48+0000",
            "method": "Singapore Banks",
            "sum": {
                "amount": 1000,
                "currency": "SGD"
            },
            "description": "PAYMENT_270925"
        },
        "customer": {
            "id": "424222"
        },
        "operation": {
            "sum_initial": {
                "amount": 1000,
                "currency": "SGD"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "SGD"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 61112,
                "payment_id": "64534535318185",
                "auth_code": ""
            },
            "id": 16464535601,
            "type": "sale",
            "status": "decline",
            "date": "2022-08-26T11:06:48+0000",
            "created_date": "2022-08-26T10:57:40+0000",
            "request_id": "bd8daae913d8a81f8b73a960160b0ec44b8e9dfc2-00016185..."
        },
        "signature": "ly/4qzq1eDzKI9nwJe7N8aA9JcAjXoDjreWru++Oc+inFKm3eO+gaMA=="
    }

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

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

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

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

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



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

  1. Пользователь на стороне веб-сервиса инициирует выплату через Singapore Online Banking.
  2. От веб-сервиса на заданный URL ecommpay передаётся запрос на проведение выплаты через Gate.
  3. Запрос на проведение выплаты поступает в платёжную платформу.
  4. В платёжной платформе выполняется приём запроса с проверкой наличия обязательных параметров и корректной подписи.
  5. От платёжной платформы к веб-сервису направляется ответ с информацией о получении запроса и его корректности (подробнее).
  6. В платёжной платформе выполняются дальнейшая обработка запроса (с проверкой согласованности параметров) и его отправка в сервис банка.
  7. В сервисе банка выполняется обработка выплаты.
  8. От сервиса банка к платёжной платформе направляется информация о результате выплаты.
  9. От платёжной платформы к веб-сервису направляется оповещение о результате выплаты.
  10. На стороне веб-сервиса обеспечивается информирование пользователя о результате выплаты.

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

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

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

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

Таким образом, корректный запрос на выплату с применением метода Singapore Online Banking должен содержать идентификатор проекта, базовые сведения о платеже (его идентификатор, сумму и код валюты), идентификатор и IP-адрес пользователя, номер счёта и имя его держателя, идентификатор банка и подпись.

{
  "general": {
    "project_id": 55120,
    "payment_id": "payment4444",
    "signature": "PJkV8ej\/UG0Di8hTng6JvipTv+AWoXW\/9MTO8yJA=="
  },
  "payment": {
    "amount": 56000,
    "currency": "SGD"
  },
  "customer": {
    "id": "customer123",
    "ip_address": "192.0.2.0",
  },
  "account": {
    "number": "55554598",
    "bank_id": 57001,
    "customer_name": "Putra account"
  }
}

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

{
  "general": {
    "project_id": 55120,
    "payment_id": "payment4444",
    "signature": "PJkV8ej\/UG0Di8hTng6JvipTv+AWoXW\/9MTO8yJA=="
  },
  "payment": {
    "amount": 56000,
    "currency": "SGD"
  },
  "customer": {
    "id": "customer123",
    "ip_address": "192.0.2.0",
  },
  "account": {
    "number": "55554598",
    "bank_id": 57001,
    "customer_name": "Putra account"
  }
}

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

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

В следующем примере оповещение свидетельствует о том, что в рамках проекта 55120 для пользователя customer123 была проведена выплата в размере 560,00 SGD.

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

 {
        "project_id": 55120,
        "payment": {
            "id": "payment4444",
            "type": "payout",
            "status": "success",
            "date": "2022-09-12T13:28:58+0000",
            "method": "Singapore Banks",
            "sum": {
                "amount": 56000,
                "currency": "SGD"
            },
            "description": "payout"
        },
        "account": {
            "number": "55554598",
            "bank_id": 57001
        },
        "customer": {
            "id": "customer123"
        },
        "operation": {
            "id": 9912000002236,
            "type": "payout",
            "status": "success",
            "date": "2022-09-12T13:28:58+0000",
            "created_date": "2022-09-12T13:22:15+0000",
            "request_id": "b54610e94a76",
            "sum_initial": {
                "amount": 56000,
                "currency": "SGD"
            },
            "sum_converted": {
                "amount": 56000,
                "currency": "SGD"
            },
            "provider": {
                "id": 15599,
                "payment_id": "88PZTPH0NBON42",
                "date": "2022-09-12T13:28:34+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "qV2FRs/wxoOaywQS0GYQDi+6spZFbiRXxt8zG
                            10zy9TNiJLT0P/+EOrpMkoW80mynkaQfSAUJpfQ=="
    }

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

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

{
        "project_id": 55120,
        "payment": {
            "id": "PAYOUT78966",
            "type": "payout",
            "status": "decline",
            "date": "2022-09-07T09:44:43+0000",
            "method": "Singapore banks",
            "sum": {
                "amount": 50000,
                "currency": "SGD"
            },
            "description": ""
        },
        "account": {
            "number": "666622",
            "bank_id": 67091
        },
        "customer": {
            "id": "68686"
        },
        "errors": [
            {
                "code": "57010",
                "message": "Bank ID not found",
                "description": "Gate. Bank ID was not found in request"
            }
        ],
        "operation": {
            "id": 533000002202,
            "type": "payout",
            "status": "decline",
            "date": "2022-09-07T09:44:43+0000",
            "created_date": "2022-09-07T09:44:43+0000",
            "request_id": "205d3536a91f4737d679ae44f5c707e248258224fe3f6",
            "sum_initial": {
                "amount": 50000,
                "currency": "SGD"
            },
            "sum_converted": {
                "amount": 50000,
                "currency": "SGD"
            },
            "provider": {
                "id": 1003,
                "payment_id": ""
            },
            "code": "2801",
            "message": "Bank ID not found"
        },
        "signature": "j4cxKDvx0EtSJw0bHot6v83rzDMlinxE915lAWGHKVjurpQ=="
    }

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

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

Выплаты через Dashboard

При использовании интерфейса Dashboard можно проводить одиночные и массовые выплаты методом Singapore Online Banking с единичной и пакетной отправкой запросов, называемые соответственно одиночными и массовыми.

  • Для проведения одиночной выплаты необходимо открыть форму выплаты, задать все необходимые параметры (включая метод), отправить запрос и убедиться в проведении выплаты.
  • Для проведения массовой выплаты необходимо подготовить и загрузить файл с информацией обо всех целевых выплатах, отправить пакет запросов и убедиться в проведении выплат.

    При этом должен использоваться файл формата CSV, структура которого соответствует требованиям, представленным в разделе Сведения о массовых платежах, а параметры выплат должны соответствовать требованиям, представленным в разделе Выплаты через Gate этой статьи (за исключением пункта о подписи).

Более подробная информация о проведении выплат через Dashboard представлена в отдельной статье.

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

Для анализа информации о платежах и операциях, как в отдельности по методу Singapore Online Banking, так и в совокупности с другими методами, можно использовать:

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

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