...

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

{
  "amount": 0;
  "layoutId": "string"
}

...

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

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

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

...

Описание: Получение информации о платежной странице получателя

Адрес: https: /wiki/api.cloudtips.ru/api/paymentpages​/{layoutId}spaces/TIPS/pages/2214756501

Тип: GET

Запрос:

Наименование	Тип	Обязательность	Описание
layoutId	String	Да	Уникальный идентификатор страницы оплаты получателя

...

Наименование	Тип	Обязательность	Описание
url	String	Да	Ссылка на страницу оплаты
title	String	Да	Название
backgroundUrl	String	Да	Ссылка на обложку
avatarUrl	String	Да	Ссылка на аватарку получателя
logoUrl	String	Да	Ссылка на логотип
nameText	String	Да	Имя получателя
backgroundColor	String	Да	Цвет бэкграунда страницы оплаты
linksColor	String	Да	Цвет ссылок
buttonsColor	String	Да	Цвет кнопок
applePayEnabled	Boolean	Да	Оплата по apple pay доступна, значения true и false
googlePayEnabled	Boolean	Да	Оплата по Google Pay доступна, значения true и false
tinkoffPayEnabled	Boolean	Да	Оплата по Tinkoff Pay доступна, значения true и false
sbpPayEnabled	Boolean	Да	Оплата по СБП доступна, значения true и false
userAgreementText	String	Да	Текст пользовательского соглашения
userAgreementUrl	String	Да	Ссылка на пользовательское соглашение
hideReCaptchaHint	Boolean	Да	Скрывать иконку капчи
paymentMessage	String	Да	Текст на странице оплаты
successMessage	String	Да	Текст на странице успешной оплаты
failMessage	String	Да	Не используется
amount		Да	Блок для управления полем сумма
amountPresetSettings		Да	Блок с предустановленными суммами
enabled	Boolean	Да	Включен, значения true и false
amounts	Array of integer	Да	Варианты сумм
constraints		Да	Не используется
range		Да	Ограничение на сумму платежа
minimal	Integer	Да	минимальная сумма платежа
maximal	Integer	Да	максимальная сумма платежа
fixed	Integer	Да	фиксированная сумма платежа
target		Да	Блок цель
startDate	Date	Да	Дата начала сбора денег
finishDate	Date	Да	Дата окончания сбора денег
targetAmount	Integer	Да	Сумма цели
currentAmount	Integer	Да	Текущая сумма
rating		Да	Блок рейтинг
enabled	Boolean	Да	Включен, значения true и false
components		Да	Компоненты рейтинга
id	String	Да	Уникальный идентификатор компоненты
title	String	Да	Название компоненты
imageUrl	String	Да	Ссылка на изображение
availableFields		Да	Блок полей для заполнения
comment		Да	Комментарий
title	String	Да	Название поля
enabled	Boolean	Да	Включен, значения true и false
required	Boolean	Да	Обязательно, значения true и false
email		Да	Почта платящего
title	String	Да	Название поля
enabled	Boolean	Да	Включен, значения true и false
required	Boolean	Да	Обязательно, значения true и false
name		Да	Имя платящего
title	String	Да	Название поля
enabled	Boolean	Да	Включен, значения true и false
required	Boolean	Да	Обязательно, значения true и false
phoneNumber		Да	Телефон платящего
title	String	Да	Название поля
enabled	Boolean	Да	Включен, значения true и false
required	Boolean	Да	Обязательно, значения true и false
payerCity		Да	Город платящего
title	String	Да	Название поля
enabled	Boolean	Да	Включен, значения true и false
required	Boolean	Да	Обязательно, значения true и false
afterPaymentActions		Да	Действие после оплаты
emailSending	Boolean	Да	Отправить email, значения true и false. Если выбран true, то поле email обязательно для заполнения
payerFee		Да	Блок комиссия за счет платящего
enabled	Boolean	Да	Включен, значения true и false
initialState	String	Да	Положение по умолчанию, значения: Disabled - отключена, Enabled - включена
buttonPosition	String	Да	Не используется
feedback		Да	Не используется
succeed	Boolean	Да	Стату запроса, значение true и false
errors	Array of string	Да	Возвращатеся список ошибок, относящихся целиком к запросу
validationErrors	Array of string	Да	Поле представлено в формате ключ-значение и содержит ошибки, которые отнести к конкретному полю запроса

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

Code Block
language json
{ "data": { "url": "string", "title": "string", "backgroundUrl": "string", "avatarUrl": "string", "logoUrl": "string", "nameText": "string", "backgroundColor": "string", "linksColor": "string", "buttonsColor": "string", "applePayEnabled": true, "googlePayEnabled": true, "tinkoffPayEnabled": true, "sbpPayEnabled": true, "userAgreementText": "string", "userAgreementUrl": "string", "hideReCaptchaHint": true, "paymentMessage": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "successMessage": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "failMessage": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "amount": { "amountPresetSettings": { "enabled": true, "amounts": [ 0 ] }, "constraints": [ { "type": "string", "currency": "string", "value": 0 } ] }, "target": { "startDate": "2021-08-24T10:06:46.874Z", "finishDate": "2021-08-24T10:06:46.874Z", "targetAmount": 0, "currentAmount": 0 }, "rating": { "enabled": true, "components": [ { "id": "string", "title": "string", "imageUrl": "string" } ] }, "availableFields": { "comment": { "title": "string", "enabled": true, "required": true }, "email": { "title": "string", "enabled": true, "required": true }, "name": { "title": "string", "enabled": true, "required": true }, "phoneNumber": { "title": "string", "enabled": true, "required": true }, "payerCity": { "title": "string", "enabled": true, "required": true } }, "afterPaymentActions": { "emailSending": true }, "payerFee": { "enabled": true, "initialState": "string", "buttonPosition": "string" }, "feedback": { "enabled": true, "rating": { "enabled": true, "components": [ { "id": "string", "title": "string", "imageUrl": "string" } ] }, "availableFields": { "comment": { "title": "string", "enabled": true, "required": true }, "email": { "title": "string", "enabled": true, "required": true }, "name": { "title": "string", "enabled": true, "required": true }, "phoneNumber": { "title": "string", "enabled": true, "required": true }, "payerCity": { "title": "string", "enabled": true, "required": true } } } }, "succeed": true, "statusCode": 0, "errors": [ "string" ], "validationErrors": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] } }

...

Наименование	Тип	Обязательность	Описание
amount	Integer	Да	Сумма платежа Число с плавающей запятой, округление до 2 знаков после запятой
currency	String	Да	Валюта платежа, константа RUB
feeFromPayer	Boolean	Да	Комиссия с платящего, значения true и false
name	String	Нет	Имя платящего
comment	String	Нет	Комментарий платящего
layoutId	String	Да	Уникальный идентификатор страницы оплаты получателя
ipSource	String	Да	IP адрес плательщика
invoiceId	String	Нет	Внешний идентификатор партнера, например внутренний номер заказа
payerEmail	String	Нет	email платящего
receiverSubscriptionSettingId	String	Нет	Не используется
payerPhoneNumber	String	Нет	Телефон платящего
payerCity	String	Нет	Город платящего
rating		Нет	Компоненты рейтинга
score	Integer	Нет	Оценка, значение от 0 до 5
selectedComponents	Array of string	Нет	Выбранные компоненты полученные при запросе данных Страницы оплаты, передается список id выбранных компонентов
externalId	String	Нет	Внешний идентификатор получателя
routeId	String	Нет	Не используется
Device		Да	Данные устройства
Type	enum	Да	Тип платформы MobileApp = 1, MobileWeb = 2, DesktopWeb = 3
Os	String	Да	Операционная система
Webview	Boolean	Да	Наличие WebView, значения true и false
Browser	String	Да	Используемое имя браузера, без версии

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

Code Block
language json
{ "amount": 0, "feeFromPayer": true, "currency": "string", "name": "string", "comment": "string", "layoutId": "string", "invoiceId": "string", "ipSource" : "string", "payerEmail": "user@example.com", "receiverSubscriptionSettingId": "string", "payerPhoneNumber": "string", "payerCity": "string", "rating": { "score": 0, "selectedComponents": [ "string" ] }, "externalId": "string", "routeId": "string", "Device" : { "Type" : 0, //enum MobileApp = 1,MobileWeb = 2,DesktopWeb = 3 "Os" : "string", "Webview" : bool, "Browser" : "string" } } }

...

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

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

Code Block
language json
{ "succeed": true, "errors": [ "string" ], "validationErrors": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "data": { "transactionId": 0, "universalLinkUrl" : "string", "qrUrl" : "string" } }

...

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

Code Block
language json
{ "transactionId": 0, }

Ответ:

Наименование	Тип	Обязательность	Описание
transactionId	Long	Да	Уникальный идентификатор оплаты
status	enum	Да	Статус платежа: Status=Wait. Статус обозначает, что транзакция либо была не оплачена, либо находится в обработке. После получения этого статуса отправляем повторный запрос (5 раз). Если по истечению всех попыток, статус остается все тот же, то закрываем QR код и оставляем страницу со всеми введенными параметрами. Status=Success. Редирект на страницу успешной оплаты Status=Failed. Редирект на страницу неуспешной оплаты

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

Code Block
language json
{ "transactionId": 0, "status" : 0, //enum Wait = 1,Success = 2,Failed = 3 }

Завершение оплаты

Завершение оплаты происходит при получении одного из финальных статусов.

...