Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Если получатель не был в системе, то он вернется в массиве created и layoutStatus = NoneWaitingForConfirmation. Никаких подтверждений со стороны пользователя не требуется.

Если получатель уже есть в системе и не в вашем скоупе, то он вернется в массиве created и layoutStatus = WaitingForConfirmation, то необходимо подтверждение привязки от пользователя. Для этого надо получателями не планируется использование личного кабинета CloudTips, то для дальнейшей работы необходимо воспользоваться методом Привязка получателя к заведению.

...

Описание: Позволяет отредактировать данные получателя. Можно передавать одно значение из списка, а не весь список.

Адрес: https://api.cloudtips.ru/api/receivers​receivers/{userId}, где userId уникальный идентификатор получателя в системе

...

Code Block
[
  {
    "op": "replace",
    "path": "/Name",
    "value":  "string"
  },
  {
    "op": "replace",
    "path": "/Email",
    "value":  "string"
  }
]

Ответ:

Наименование

Тип

Обязательность

Описание

succeed

String

Да

Статус запроса

errors

Array of string

Да

Возвращатеся список ошибок, относящихся целиком к запросу

validationErrors

Array of string

Да

Поле представлено в формате ключ-значение и содержит ошибки, которые отнести к конкретному полю запроса

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

Code Block
{
  "succeed": true,
  "errors": [
    "string"
  ],
  "validationErrors": {
    "additionalProp1": [
      "string"
    ],
    "additionalProp2": [
      "string"
    ],
    "additionalProp3": [
      "string"
    ]
  }
}

Редактирование данных платежной страницы

Описание: Позволяет отредактировать данные о платежной страницы.

Адрес: https://api.cloudtips.ru/api/paymentpages/{layoutId}, где layoutId идентификатор платежной страницы получателя

Тип: PATCH

Запрос:

Наименование

Тип

Обязательность

Описание

WorkInfo.ChannelUrl

String

Да

Ссылка на канал пользователя

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

Code Block
languagejson
[
  {
    "op": "replace",
    "path": "/WorkInfo/ChannelUrl",
    "value":  "string"
  }
]

Ответ:

Наименование

Тип

Обязательность

Описание

succeed

String

Да

Статус запроса

errors

Array of string

Да

Возвращатеся список ошибок, относящихся целиком к запросу

validationErrors

Array of string

Да

Поле представлено в формате ключ-значение и содержит ошибки, которые отнести к конкретному полю запроса

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

Code Block
{
  "succeed": true,
  "errors": [
    "string"
  ],
  "validationErrors": {
    "additionalProp1": [
      "string"
    ],
    "additionalProp2": [
      "string"
    ],
    "additionalProp3": [
      "string"
    ]
  }
}

...