GET /v1/link/{id} · POST /v1/link/{id}/checkout
Публичные методы платёжной ссылки: показать ссылку покупателю и создать по ней
счёт.
Публичные методы. Аутентификация не требуется — их вызывает браузер покупателя, у которого
нет и не должно быть вашего секрета. Именно поэтому платёжная ссылка — единственный способ
принимать платежи без бэкенда: страницу на Tilda, Wix или в Notion можно подключить к оплате,
ничего не подписывая.
https://api.oblodai.com
GET /v1/link/{id}
Публичная карточка ссылки: что показывать покупателю и какой виджет суммы рисовать.Параметры пути
Пример запроса
Пример ответа
Ответ намеренно не содержит ничего о мерчанте — ни идентификаторов, ни настроек, ни статистики.
Его безопасно запрашивать из браузера.
Коды ошибок
POST /v1/link/{id}/checkout
Создать по ссылке настоящий счёт для этого покупателя. Возвращает объект платежа — сuuid,
адресом и ссылкой url на hosted‑страницу оплаты, куда покупателя и нужно отправить.
Параметры запроса
string
Сумма, которую ввёл покупатель, в валюте цены ссылки. Обязательна для
open и range; для fixed игнорируется (сумму задаёт ссылка).string
Валюта расчёта — монета, которой платит покупатель. Нужна, только если ссылка не закрепила
pinned_currency.string
Сеть расчёта. Нужна, только если ссылка не закрепила
pinned_network.string
Email покупателя. На него автоматически уйдёт чек после оплаты.
Для
fixed сумму можно не передавать вовсе. Если ссылка закрепила монету/сеть,
переданные значения игнорируются — выигрывает закрепление.Пример запроса
Пример ответа
Обычный объект платежа — точно такой же, как уPOST /v1/payment:
Коды ошибок
Кроме них может прийти любая ошибка создания счёта — checkout выполняет тот же путь, что и
POST /v1/payment: payment.below_minimum, payment.network_required,
payment.unsupported_network, invoice.quote_failed и т. д. Показывайте покупателю понятный текст
и давайте повторить.
Нюансы
- Секрет в браузер не попадает. Оба метода публичные — этим ссылка и отличается от прямого создания счёта.
- Каждый checkout — новый счёт. Двое покупателей по одной ссылке получат разные
uuidи разные адреса. Один и тот же покупатель, нажав дважды, тоже получит два счёта — идемпотентности здесь нет (её нечем ключевать:order_idпокупатель не задаёт). - Выключенная ссылка отдаёт
404на обоих методах, но уже созданные по ней счета остаются оплачиваемыми. payer_email= чек. Если покупатель оставил email, после оплаты ему автоматически уйдёт чек. Прислать письмо со счётом («оплатите») можно и вручную —POST /v1/payment/send-email.
Связанные страницы
POST /v1/payment/link · /list · /info · /toggle
управление ссылками.