Versions Compared

Key

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

...

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

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

Адрес: https://api.cloudtips.ru/api/paymentpages​/{layoutId}

Тип: POST

Запрос:

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

Тип

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

Описание

layoutId

String

Да

Уникальный идентификатор страницы оплаты получателя

...

Code Block
{
  "data": {
    "url": "string",
    "title": "string",
    "backgroundUrl": "string",
    "avatarUrl": "string",
    "logoUrl": "string",
    "nameText": "string",
    "backgroundColor": "string",
    "linksColor": "string",
    "buttonsColor": "string",
    "applePayEnabled": true,
    "googlePayEnabled": true,
    "userAgreementText": "string",
    "userAgreementUrl": "string",
    "hideReCaptchaHint": true,
    "excludeCharityBanner": 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"
    ]
  }
}

Получение publicId

Описание: Позволяет начать процедуру оплаты чаевых

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

Тип: POST

Запрос:

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

Тип

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

Описание

publicid

String

Да

Уникальный идентификатор терминала

...

Авторизация платежа

Описание: Получение publicId терминала, необходимо для формирования криптограммыПроведение платежа по карте

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

Тип: POST

Запрос:

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

Тип

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

Описание

cardholderName

String

Да

Уникальный идентификатор страницы оплаты получателя

cardCryptogramPacket

String

Да

Криптограмма карты

amount

Integer

Да

Сумма платежа

feeFromPayer

Boolean

Да

Комиссия с платящего, значения true и false

currency

String

Да

Валюта платежа, константа RUB

name

String

Нет

Имя платящего

comment

String

Нет

Комментарий платящего

layoutId

String

Да

Уникальный идентификатор страницы оплаты получателя

invoiceId

String

Нет

Внешний идентификатор партнера, например внутренний номер заказа

payerEmail

String

Нет

email платящего

receiverSubscriptionSettingId

String

Нет

Не используется

payerPhoneNumber

String

Нет

Телефон платящего

payerCity

String

Нет

Город платящего

routeId

String

Нет

Не используется

captchaVerificationToken

String

Нет

Не используется

rating

Нет

Компоненты рейтинга

score

Integer

Нет

Оценка, значение от 0 до 5

selectedComponents

Array of string

Нет

Выбранные компоненты полученные при запросе данных Страницы оплаты, передается список id выбранных компонентов

...

Описания: После возвращения платящего на ваш сайт необходимо завершить оплату.

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

Тип: POST

Запрос:

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

Тип

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

Описание

paRes

String

Да

md

String

Да

...