CloudPayments API: POST /orders/create — Создание счёта со ссылкой на оплату

Формирует ссылку на оплату и при необходимости отправляет её плательщику по e-mail, SMS или Viber.

Пример ответа (сокращён):

Параметр Где Тип Обяз. Описание
Amount body Number да Сумма платежа
Currency body String нет Валюта, по умолчанию RUB
Description body String да Назначение платежа
Email body String нет E-mail плательщика
RequireConfirmation body Bool нет true — двухстадийная схема
SendEmail body Bool нет Отправить письмо со ссылкой
InvoiceId body String нет Номер заказа
AccountId body String нет Идентификатор пользователя
OfferUri body String нет Ссылка на оферту
Phone body String нет Телефон плательщика
SendSms body Bool нет Отправить SMS со ссылкой
SendViber body Bool нет Отправить сообщение в Viber
CultureName body String нет Язык уведомлений
SubscriptionBehavior body String нет Платёж с подпиской: CreateWeekly, CreateMonthly
SuccessRedirectUrl body String нет Редирект при успешной оплате
FailRedirectUrl body String нет Редирект при неуспешной оплате
JsonData body Json нет Данные транзакции, в том числе для онлайн-чека

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

{
    "Amount":10.0,
    "Currency":"RUB",
    "Description":"Оплата на сайте example.com",
    "Email":"client@test.local",
    "RequireConfirmation":true,
    "SendEmail":false
}

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

{
    "Model": {
        "Id": "gASGZVgUN21hcpPF",
        "Number": 2130,
        "Amount": 10.0,
        "Currency": "RUB",
        "Url": "https://orders.cloudpayments.ru/d/gASGZVgUN21hcpPF"
    },
    "Success": true,
    "Message": null
}

Базовые URL

Авторизация

Тип: Basic Auth

HTTP Basic Auth: логин — Public ID, пароль — API Secret. Оба значения есть в личном кабинете. Без заголовка авторизации или с неверными данными API возвращает HTTP 401 Unauthorized. API Secret нужно хранить в защищённом месте.

Параметры передаются методом POST в теле запроса: application/x-www-form-urlencoded («ключ=значение») или application/json. Ответ всегда JSON и содержит как минимум Success и Message.

{ "Success": false, "Message": "Invalid Amount value" }

Нюансы

Сценарии с этим методом


Если этого недостаточно — официальная документация: https://developers.cloudpayments.ru/#api Вся интеграция одним документом: https://mcp-everything.ru/integrations/cloudpayments.md