Об API

Справочник API

API PayQR основан на концепции REST. Наш API разработан так, чтобы вы получили предсказуемые URLы, ориентированные на выдачу ресурсов, и коды ответов по протоколу HTTP для информирования об ошибках API. Мы используем встроенные особенности протокола HTTP, такие как HTTP authentication и HTTP verbs, понятные любым существующим HTTP клиентам. Также мы поддерживаем cross-origin resource sharing (CORS), чтобы позволить вам безопасно взаимодействовать с нашими API из приложений на клиентской стороне (таким образом вы всегда уверены, что ваш секретный ключ для API не будет скомпрометирован в коде публичного web-сайта). Все данные из нашей системы будут направляться вам в формате JSON.

API сервиса PayQR является единым многофункциональным протоколом взаимодействия, включающем в себя поддержку множества различных сценариев совершения покупок и осуществления переводов денежных средств. Большинству партнеров PayQR достаточно реализации небольшой части API PayQR, необходимой для решения конкретных кейсов.
Самостоятельно компонуйте команды и функции, необходимые или возможные для реализации в ваших системах учета, программном обеспечении и так далее. Если вы испытываете затруднения с выбором функций API для своего бизнеса, обращайтесь на api@payqr.ru, и мы окажем максимально оперативную поддержку!

Для тестирования API не требуется заключение договора. Для вашего удобства в работе с нашим API до переведения магазина в «боевой режим» все операции будут осуществляться так, как они и осуществляются в PayQR, но все платежи будут автоматически отменяться, а денежные средства будут автоматически возвращаться в течение 10 минут после их совершения. Также значение атрибута livemode наших объектов в таких случаях будет false для простоты тестирования и учета тестовых платежей. Переводом магазинов в «боевом режим» вы управляете самостоятельно в личном кабинете PayQR.

Версионирование

Когда мы осуществляем изменения API без обратной совместимости, мы не отключаем устаревший API, а уведомляем всех своих партнеров о нововведениях. В таком случае вы можете по-прежнему использовать старую версию API или модифицировать код на вашей стороне под новую версию.
На данный момент устаревших версий нет.