Yandex Pay API
version: 1.0.0
Совет
Для знакомства с платежными механиками используйте готовую Postman-коллекцию.
Аутентификация запроса продавца
Для использования API необходимо получить ключ Merchant API (API-ключ). Выпустите его в личном кабинете Яндекс Пэй по инструкции.
Примечание
В тестовой среде в качестве API-ключа используется Merchant ID магазина. Его значение также можно увидеть в личном кабинете. С настройками тестовой среды можно ознакомиться в разделе Тестирование.
Передавайте API-ключ в HTTP-заголовке Authorization каждого запроса:
--header 'Authorization: Api-Key <значение ключа>'
Если в запросе отсутствует или передан недействительный API-ключ, сервер возвращает HTTP-статус 401 Unauthorized.
Служебные заголовки
Чтобы повысить надежность и упростить отладку процессов, передавайте следующие HTTP-заголовки в ваших запросах:
|
Заголовок |
Значение |
Описание |
|
|
Уникальный идентификатор запроса |
Нужен для:
Сохраняйте одно и то же значение |
|
|
Таймаут в миллисекундах |
Нужен для deadline propagation при обработке запроса. Правила:
|
|
|
Номер попытки |
Полезен для общей диагностики. Например, 0 — первая попытка, 1, 2 и т. д. — перезапросы. |
Sections
Specification
Идемпотентность — свойство операции, при котором ее многократное выполнение с одинаковыми параметрами дает тот же результат, что и однократное выполнение.
Deadline propagation (распространение дедлайна) — это техника передачи информации о максимальном времени выполнения запроса через всю цепочку сервисов. Подробнее