Сплитование

1 Обозначение
2 Предварительная настройка
3 Проведение платежа
- 3.1 Получение publicId
- 3.2 Проведение оплаты
  - 3.2.1 Ограничения

Обозначение

Сплитование позволяет перевести средства разным получателям посредством одной транзакции

Предварительная настройка

Для создания пользователей необходимо воспользоваться роутом Получатель | Создание получателя
Необходимо получить платежные идентификаторы пользователей (layoutId). Они возвращаются из ответа создания получателей или их можно получить по методу поиска пользователей Получатель | Получение списка получателей

Проведение платежа

Получение publicId

Перед проведением платежа определяем терминал, по которому будет происходить оплата.

Адрес: https://api.cloudtips.ru/api/payment/publicid

Тип: POST

Запрос:

Наименование	Тип	Обязательность(в флоу сплитования)	Описание

Наименование	Тип	Обязательность(в флоу сплитования)	Описание
layoutId	String	Да	Идентификатор платежной ссылки (один из пользователей, который участвует в сплитовании)
split	Array	Нет	Массив сотрудников, для которых будет применено сплитование
split[].layoutId	string	Нет	Идентификатор платежной страницы сотрудника
split[].amount	decimal	Нет	Сумма, которая будет переводиться конкретному получателю

Пример запроса:

{
  "layoutId": "layoutId2",
  "split" : 
  [
      {
          "layoutId" : "layoutId1",
          "amount" : 100
      },
      {
          "layoutId" : "layoutId2",
          "amount" : 200
      }
  ]
}

Ответ:

Наименование	Тип	Обязательность	Описание

Наименование	Тип	Обязательность	Описание
publicId	String	Да	Уникальный идентификатор терминала
succeed	Boolean	Да	Статус запроса, значение true и false
errors	Array of string	Да	Возвращатеся список ошибок, относящихся целиком к запросу
validationErrors	Array of string	Да	Поле представлено в формате ключ-значение и содержит ошибки, которые отнести к конкретному полю запроса

Пример ответа:

{
  "data": {
    "publicId": "string"
  },
  "succeed": true,
  "statusCode": 0,
  "errors": [
    "string"
  ],
  "validationErrors": {
    "additionalProp1": [
      "string"
    ],
    "additionalProp2": [
      "string"
    ],
    "additionalProp3": [
      "string"
    ]
  }
}

Проведение оплаты

В методы авторизации платежа добавляется объект Split, который отвечает за сплитование.

Методы, куда передается объект Split:

Оплата по карте -Оплата по карте | Авторизация платежа
Оплата по YandexPay - Оплата Yandex Pay | Авторизация платежаarchived
Оплата по TinkoffPay - Оплата Tinkoff Pay | Авторизация платежа
Оплата по СБП - Оплата через Систему быстрых платежей (СБП) | Авторизация платежа

Измененные параметры (только в request)

Наименование	Тип	Обязательность (в флоу сплитования)	Описание

Наименование	Тип	Обязательность (в флоу сплитования)	Описание
amount	decimal	Да	Сумма транзакции (сумма всех значений split[].Amount)
layoutId	Array	Да	Идентификатор платежной ссылки (один из пользователей, который участвует в сплитовании)
split[].layoutId	string	Да	идентификатор платежной страницы сотрудника
split[].amount	decimal	Да	сумма, которая будет переводиться сотруднику

Ограничения

Сумма amount должна быть равна sum(split[].amount)
Получатели должны быть созданы и относятся к одному заведению

CloudTips API