API AvantPay

API AvantPay принимает онлайн-платежи от ваших покупателей: по СБП и банковской картой, в рублях. Через API можно и вернуть покупателю деньги — всю сумму платежа или часть.

Адрес API: https://api.avantpay.io/v3

Как проходит оплата

1. Вы создаёте платёж: POST https://api.avantpay.io/v3/payments с суммой, email покупателя и адресом, куда вернуть покупателя после оплаты. В ответе — объект платежа со ссылкой на оплату confirmation.confirmation_url.
2. Покупатель переходит по ссылке и платит на странице AvantPay. Потом AvantPay возвращает его на ваш return_url.
3. AvantPay присылает уведомление на ваш сервер: payment.succeeded (оплачен) или payment.canceled (не оплачен).
4. Вы проверяете статус запросом GET https://api.avantpay.io/v3/payments/{payment_id} и выполняете заказ, только если status равен succeeded, а amount — сумме заказа.

Все четыре шага с готовыми запросами — в быстром старте.

Методы API

Метод	Что делает	В справочнике
POST /v3/payments	Создать платёж	Создать платёж
GET /v3/payments/{payment_id}	Получить платёж по его id	Получить платёж
GET /v3/payments	Список платежей с фильтрами	Список платежей
POST /v3/payment_methods	Сохранить карту для автоплатежей без платежа	Создать способ оплаты
GET /v3/payment_methods/{payment_method_id}	Получить способ оплаты по его id	Получить способ оплаты
POST /v3/refunds	Создать возврат	Создать возврат
GET /v3/refunds/{refund_id}	Получить возврат по его id	Получить возврат
GET /v3/refunds	Список возвратов с фильтрами	Список возвратов

Все поля и ошибки — в справочнике API: одна страница, методы и объекты подряд.

Куда дальше

• Быстрый старт — первый платёж за четыре шага.
• Справочник API — все методы, поля и ошибки.
• Возвраты — как вернуть покупателю деньги через API.
• Уведомления — как принять и проверить уведомление, готовые обработчики.
• Интеграция с помощью ИИ — дайте ассистенту ссылку https://avantpay.io/developers/llms-full.txt: это вся документация одним файлом.

Термины

Термин	Что это
ID магазина	Число, логин для запросов к API. Есть в личном кабинете.
Секретный ключ	Пароль для запросов к API. Создаётся в личном кабинете.
Платёж	Одна попытка оплаты: сумма, статус и ссылка на оплату.
Возврат	Возврат денег покупателю по оплаченному платежу: всей суммы или части.
Email покупателя	Адрес покупателя в metadata.email.
Ключ идемпотентности	Ваша уникальная строка в заголовке Idempotence-Key. Защищает от двойного платежа или двойного возврата, если запрос пришлось повторить.
Номер заказа	Ваш номер заказа в metadata.order_id. Вернётся в объекте платежа и в уведомлениях.
Уведомление	POST-запрос от AvantPay на ваш сервер, когда платёж оплачен или отменён и когда выполнен возврат.
Личный кабинет	https://avantpay.io/lk/ — ключи, настройки уведомлений, способы оплаты, платежи и возвраты.

Вопросы — в поддержку: support@avantpay.io.