1. Платёжные ссылки
Platega.io API
  • Авторизация
  • Модули CMS
  • SDK
  • Платежи
    • Приём карт по H2H
    • Рекуррентные СБП-подписки
      • Пробный доступ и изменение суммы подписки
      • Подписки по H2H
      • Создать подписку
      • Получить подписку
      • Список подписок
      • Отменить подписку
      • Проверка возможности обновить подписку
      • Обновление подписки
    • Платёжные ссылки
      • Как подключить платёжные ссылки
      • Вебхуки по платёжным ссылкам
      • Создание платёжной ссылки
        POST
      • Получение платёжной ссылки
        GET
      • Платежи по ссылке
        GET
      • Отключение платёжной ссылки
        POST
    • Создание платежной ссылки без заданного метода
      POST
    • Создание платежной ссылки с заданным методом
      POST
    • Получение QR-кода для H2H-транзакции
      GET
    • Проверка статуса оплаты платежа
      GET
    • Выгрузка транзакций в CSV
      POST
    • Выгрузка транзакций в Excel
      POST
    • Выгрузка транзакций в Json
      POST
  • Балансы
    • Получение балансов
      GET
  • Возвраты
    • Проверка возможности отмены транзакции
      GET
    • Отмена транзакции
      POST
    • Частичная отмена транзакции
      POST
  • Выводы
    • Создаёт вывод на рублёвую карту через Payout API
    • Создаёт вывод на криптокошелек через Payout API
    • Получение сохранённых карт
      GET
    • Получение сохраненных криптокошельков
      GET
  • Callbacks
    • Колбэки — общая информация
    • CONFIRMED
    • CANCELED
    • CHARGEBACKED
    • PARTIALLY_REFUNDED
    • DISPUTED
  • Schemas
    • Schemas
      • PaymentStatus
      • PaymentMethodInt
      • CreateTransactionRequest
      • CreateTransactionResponse
      • TransactionStatusResponse
      • SubscriptionStatus
      • CallbackSubscriptionStatus
      • SubscriptionInterval
    • Статус платежа в колбэке
    • Результат операции возврата
    • Общие поля колбэка
    • Поля колбэка по возврату
    • CallbackPayload
    • Поля колбэка по подписке
  1. Платёжные ссылки

Создание платёжной ссылки

POST
/v2/payment-links
Создаёт платёжную ссылку и возвращает адрес, который нужно передать покупателю. На форме покупатель указывает сумму в заданных пределах и оплачивает. Результат платежа приходит на ваш сервер вебхуком.
Режим ссылки и способ оплаты
ПараметрЗначения и поведение
usageMode0 — многоразовая: несколько отдельных платежей. 1 — одноразовая: одна транзакция на всю ссылку.
paymentMode0 — выбор способа на форме, paymentMethod не передавать. 1 — фиксированный способ, paymentMethod обязателен.
Доступны все четыре сочетания режимов.
Одноразовая ссылка расходуется при создании транзакции, до успешной оплаты. Открытие формы её не расходует. Отмена, неуспех или возврат использование не восстанавливают: для нового платежа нужна новая ссылка. Исходная браузерная сессия может вернуться к созданной оплате, другой браузер увидит, что ссылка использована. Многоразовая принимает новые платежи, пока доступна.
Доступ
Создание ссылок должно быть включено вашему магазину. Многоразовые ссылки включаются отдельно — подключение уточняйте у менеджера. Запросы выполняйте с сервера.
Ограничения способов
Часть способов оплаты для платёжных ссылок недоступна, и набор ограничений зависит от режима ссылки. Какие способы доступны вашему магазину — уточняйте у вашего менеджера.
Фактическая доступность зависит от подключённых магазину способов, валюты и активных маршрутов. Способ обработки платежа в запросе не задаётся: система выбирает его по настройкам магазина.
Заголовки
ЗаголовокЧто передать
X-MerchantIdИдентификатор магазина в формате UUID.
X-SecretAPI-ключ магазина. Хранится на сервере, покупателю не передаётся.
Content-Typeapplication/json для запросов с телом.
Idempotency-KeyОбязателен при создании. Уникальный ключ операции, до 128 символов: латинские буквы, цифры и ._:-.
Поля тела запроса
ПолеОбязательноеПравила
usageModeнетЧисло 0 или 1, не строка. Без поля создаётся многоразовая ссылка.
paymentModeдаЧисло 0 или 1, не строка. Указывайте оба режима явно.
paymentMethodзависитЧисловой идентификатор способа оплаты. Обязателен при paymentMode: 1; при paymentMode: 0 поле нужно опустить.
currencyдаКод доступной валюты, например RUB. Совместимость проверяется по способам и настройкам магазина.
minAmountнетПоложительная сумма строкой, с точкой. До 2 знаков после точки, для USDT — до 8.
maxAmountнетТо же правило. Должна быть не меньше minAmount. Равные значения фиксируют сумму. Без обоих полей действуют системные лимиты.
nameнетНазвание ссылки, до 128 символов.
descriptionнетНазначение платежа, до 512 символов. При пустом значении подставляется «Оплата».
orderIdнетИдентификатор заказа, до 128 символов. Допустим только у одноразовой ссылки. Не заменяет payload.
payloadнетВаши данные, до 2048 байт UTF-8. Возвращаются в вебхуках и одинаковы для всех платежей ссылки.
returnнетАбсолютный HTTP(S)-адрес возврата после оплаты, до 2048 символов.
failedUrlнетАбсолютный HTTP(S)-адрес возврата при неуспехе, до 2048 символов.
expiresAtнетБудущая дата в формате ISO 8601 с часовым поясом, например 2027-01-31T23:59:59Z.
Неизвестные поля отклоняются. Сумма задаётся только через minAmount и maxAmount.
Ключевые поля ответа
ПолеЧто означает
idИдентификатор ссылки. Это не идентификатор платежа.
urlАдрес, который передаётся покупателю. Передавайте именно его.
activeПринимает ли ссылка платежи.
revisionСтроковая версия состояния. Нужна при отключении ссылки.
createdAtМомент создания.
Остальные поля повторяют то, что вы передали при создании.
Повторные запросы
Первый запрос возвращает 201. Тот же Idempotency-Key с теми же параметрами возвращает уже созданную ссылку и 200. Тот же ключ с другими параметрами — 409. Для новой ссылки используйте новый ключ.
Ошибки
INVALID_REQUEST и INVALID_AMOUNT — параметры запроса. METHOD_NOT_ALLOWED — способ недоступен. LINK_UNAVAILABLE — ссылка или функция недоступна. IDEMPOTENCY_CONFLICT — конфликт ключа. У кодов префикс PaymentLink:. Сохраняйте code и traceId — они нужны поддержке.
Неизвестные поля в теле запроса отклоняются. Сумма задаётся только через minAmount и maxAmount.

Request

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢201Ссылка создана
application/json
Bodyapplication/json

🟢200Повтор по тому же ключу
🟠409Конфликт ключа
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/v2/payment-links' \
--header 'X-MerchantId: 11111111-2222-4333-8444-555555555555' \
--header 'X-Secret: <API_KEY>' \
--header 'Idempotency-Key: single-order-1001' \
--header 'Content-Type: application/json' \
--data '{
    "name": "string",
    "description": "string",
    "usageMode": 0,
    "paymentMode": 0,
    "paymentMethod": 0,
    "currency": "string",
    "minAmount": "string",
    "maxAmount": "string",
    "orderId": "string",
    "payload": "string",
    "return": "string",
    "failedUrl": "string",
    "expiresAt": "string"
}'
Response Response Example
201 - Example 1
{
    "id": "string",
    "url": "string",
    "name": "string",
    "description": "string",
    "usageMode": 0,
    "paymentMode": 0,
    "paymentMethod": 0,
    "currency": "string",
    "minAmount": "string",
    "maxAmount": "string",
    "payload": "string",
    "return": "string",
    "failedUrl": "string",
    "orderId": "string",
    "expiresAt": "string",
    "createdAt": "string",
    "active": true,
    "canActivate": true,
    "revision": "string"
}
Modified at 2026-11-02 11:28:36
Previous
Вебхуки по платёжным ссылкам
Next
Получение платёжной ссылки
Built with