Страница оплаты

Страницы оплаты получателей

Описание: получение всех страниц оплат получателей

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

Тип: GET

Запрос:

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

Наименование	Тип	Обязательность	Описание
LayoutId	String	Нет	Уникальный идентификатор страницы оплаты
UserId	String	Да	Уникальный идентификатор получателя
PhoneNumber	String	Нет	Номер получателя
CreatedDateFrom	String	Нет	Дата создания страницы оплаты с
CreatedDateTo	String	Нет	Дата создания страницы оплаты по
Page	Integer	Нет	Страница
Limit	Integer	Нет	Ограничение на страницу

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

{
  "layoutId": "string",
  "userId": "string",
  "phoneNumber": "string",
  "createdDateFrom": "string",
  "createdDateTo": "string",
  "page": "integer",
  "limit": "integer" 
}

Ответ:

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

Наименование	Тип	Обязательность	Описание
id	String	Да	Уникальный идентификатор страницы оплаты
userId	String	Да	Уникальный идентификатор получателя
phoneNumber	String	Да	Номер получателя
layoutId	String	Да	Список страниц оплаты
backgroundId	String	Да	Уникальный идентификатор фонового изображения
url	String	Да	Ссылка на страницу оплаты
title	String	Да	Название страницы оплаты
backgroundUrl	String	Да	Ссылка на фоновое изображение страницы оплаты
paymentMessage	String	Да	Текст на первом экране страницы оплаты
successMessage	String	Да	Текст на с транице успешной оплаты
failMessage	String	Да	Не используется
amount		Да	Управление суммой на форме оплаты
amountPresetSettings	String	Да	Предустановленные суммы на первом экране формы оплаты
enabled	Boolean	Да	Отвечает за показ предустановленных сумм, значения true и false
amounts	Array of Integer	Да	Список сумм
constraints		Да	Не используется
range		Да	Ограничение на сумму платежа
minimal	Integer	Да	минимальная сумма платежа
maximal	Integer	Да	максимальная сумма платежа
fixed	Integer	Да	фиксированная сумма платежа
createdDate	String	Да	Дата создания
totalCount	Integer	Да	Количество записей
succeed	String	Да	Стату запроса
errors	Array of string	Да	Возвращатеся список ошибок, относящихся целиком к запросу
validationErrors	Array of string	Да	Поле представлено в формате ключ-значение и содержит ошибки, которые отнести к конкретному полю запроса

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

{
  "data": {
    "items": [
      [
        {
          "id": "string",
          "userId": "string",
          "phoneNumber": "string",
          "layoutId": "string",
          "backgroundId": "string",
          "url": "string",
          "title": "string",
          "backgroundUrl": "string",
          "paymentMessage": {
            "additionalProp1": "string",
            "additionalProp2": "string",
            "additionalProp3": "string"
          },
          "successMessage": {
            "additionalProp1": "string",
            "additionalProp2": "string",
            "additionalProp3": "string"
          },
          "failMessage": {
            "additionalProp1": "string",
            "additionalProp2": "string",
            "additionalProp3": "string"
          },
          "amount": {
            "currency": "string",
            "amountPresetSettings": {
              "enabled": true,
              "amounts": [
                0
              ]
            },
            "constraints": [
              {
                "type": "string",
                "currency": "string",
                "value": 0
              }
            ],
            "range": {
              "minimal": 0,
              "maximal": 0,
              "fixed": 0
            }
          },
          "createdDate": "2021-12-01T14:14:27.796Z"
        }
      ]
    ],
    "totalCount": 0
  },
  "succeed": true,
  "statusCode": 0,
  "errors": [
    "string"
  ],
  "validationErrors": {
    "additionalProp1": [
      "string"
    ],
    "additionalProp2": [
      "string"
    ],
    "additionalProp3": [
      "string"
    ]
  }
}

Получение страницы оплаты

Описание: Получение страницы оплаты получателя

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