«Локальные выплаты на банковские счета в Великобритании»

Введение

«Локальные выплаты на банковские счета в Великобритании» — метод, позволяющий проводить платежи в фунтах стерлингов с использованием банковских счетов в Великобритании. Для этого метода в платёжной платформе Ecommpay поддерживаются выплаты. Вместе с тем, для проведения оплат при работе с этим методом может использоваться комплементарный метод Open Banking in the UK.

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

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

Схема работы

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

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

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

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

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

Проведение выплат с использованием метода «Локальные выплаты на банковские счета в Великобритании» осуществляется с уведомлением пользователей через веб-сервис мерчанта.

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

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

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

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

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

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

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

 {
  "general": {
    "project_id": 3027,
    "payment_id": "payout1",
    "signature": "M1vT4q9c8hA8xCjEwH6bgBOp8DTf8d/XdoV+vd7Q=="
  },
   "customer": {
     "id": "customer1",
     "ip_address": "192.0.2.0",
     "first_name": "John Doe"
  },
   "account": {
     "bank_code": "123",
     "number": "1020304010"
  },
   "payment": {
     "amount": 10000,
     "currency": "GBP",
     "description": "test payout"
  }
}

 {
  "general": {
    "project_id": 3027,
    "payment_id": "payout1",
    "signature": "M1vT4q9c8hA8xCjEwH6bgBOp8DTf8d/XdoV+vd7Q=="
  },
   "customer": {
     "id": "customer1",
     "ip_address": "192.0.2.0",
     "first_name": "John Doe"
  },
   "account": {
     "bank_code": "123",
     "number": "1020304010"
  },
   "payment": {
     "amount": 10000,
     "currency": "GBP",
     "description": "test payout"
  }
}

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

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

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

 {
        "project_id": 4991,
        "payment": {
            "id": "85777022",
            "type": "payout",
            "status": "success",
            "date": "2021-02-22T13:47:30+0000",
            "method": "bank-transfer-uk",
            "sum": {
                "amount": 30500,
                "currency": "GBP"
            },
            "description": "test payout"
        },
        "account": {
            "number": "5345765"
        },
        "customer": {
            "id": "customer1"
        },
        "operation": {
            "id": 4205000000072,
            "type": "payout",
            "status": "success",
            "date": "2021-02-22T13:47:30+0000",
            "created_date": "2021-02-22T13:47:09+0000",
            "request_id": "d61112fb05c3c558a5b77dde36fa41b649d-00004206",
            "sum_initial": {
                "amount": 30500,
                "currency": "GBP"
            },
            "sum_converted": {
                "amount": 30500,
                "currency": "GBP"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 2944,
                "payment_id": "j29UpFMgQ0",
                "auth_code": ""
            }
        },
        "signature": "EaiGnnSGbZ20U0wmq1x1v/UiIDbzAAxECZegwQqZlYUA=="
    }

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

 {
        "project_id": 4991,
        "payment": {
            "id": "31596106",
            "type": "payout",
            "status": "decline",
            "date": "2021-02-22T13:57:40+0000",
            "method": "bank-transfer-uk",
            "sum": {
                "amount": 23400,
                "currency": "GBP"
            },
            "description": "test payout"
        },
        "account": {
            "number": "312312543"
        },
        "customer": {
            "id": "customer2"
        },
        "operation": {
            "id": 7033000000070,
            "type": "payout",
            "status": "decline",
            "date": "2021-02-22T13:57:40+0000",
            "created_date": "2021-02-22T13:57:37+0000",
            "request_id": "c84225facb18f7218f76b053af8b717f946-00007034",
            "sum_initial": {
                "amount": 23400,
                "currency": "GBP"
            },
            "sum_converted": {
                "amount": 23400,
                "currency": "GBP"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 2944,
                "payment_id": "j29ih8EBLQ",
                "auth_code": ""
            }
        },
        "signature": "9PcGBHYLfgObqD1cUHXN/iGInDB0KVS2RFVyht5k5wIei75g=="
    }

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

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

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