Документация API для партнеров

Добро пожаловать на страницу документации API. Здесь вы найдете информацию о доступных запросах и примерах использования для интеграции в ваши телеграм-боты или другие системы.

Общая информация

В этой документации описаны основные запросы, которые можно выполнить, используя наш API. Она разработана для удобной интеграции с телеграм-ботами и другими системами партнеров для обеспечения бесперебойной обработки платежей и обновления статусов.

Аутентификация

Для использования нашего API, необходимо в каждом запросе включать ключ API и имя ресурса партнера. Это делается через заголовки X-API-KEY и X-RESOURCE-NAME.

curl -X GET "https://easy2pay.xyz/api/some_endpoint" \
    -H "X-API-KEY: ВАШ_API_КЛЮЧ" \
    -H "X-RESOURCE-NAME: ИМЯ_ВАШЕГО_РЕСУРСА"

Замените ВАШ_API_КЛЮЧ и ИМЯ_ВАШЕГО_РЕСУРСА на ваши реальные данные.

Ошибки

API возвращает стандартные HTTP коды ошибок. Например, 404 для ресурса, который не найден, или 500 для внутренней ошибки сервера.

Конечные точки:

POST /api/request_payment

Инициировать запрос на оплату. Необходимо предоставить имя пользователя, идентификатор пользователя в Telegram и сумму платежа.

curl -X POST "https://easy2pay.xyz/api/request_payment" \
    -H "X-API-KEY: ВАШ_API_КЛЮЧ" \
    -H "X-RESOURCE-NAME: ИМЯ_ВАШЕГО_РЕСУРСА" \
    -d '{"user_name": "ИМЯ_ПОЛЬЗОВАТЕЛЯ", "customer_telegram_id": "123456789", "amount": 100.50}'

POST /api/payment/add

После того как пользователь произвел оплату и вы получили от него подтверждение, используйте этот запрос, чтобы сообщить системе об успешной оплате.

curl -X POST "https://easy2pay.xyz/api/payment/add" \
    -H "X-API-KEY: ВАШ_API_КЛЮЧ" \
    -H "X-RESOURCE-NAME: ИМЯ_ВАШЕГО_РЕСУРСА" \
    -d '{"payment_id": "ID_ПЛАТЕЖА"}'

Где ID_ПЛАТЕЖА - идентификатор платежа, для которого пользователь подтвердил оплату.

POST /api/upload_receipt

Загрузить квитанцию об оплате для ранее созданного платежа. Необходимо предоставить ID платежа и файл квитанции.

curl -X POST "https://easy2pay.xyz/api/upload_receipt" \
    -H "X-API-KEY: ВАШ_API_КЛЮЧ" \
    -H "X-RESOURCE-NAME: ИМЯ_ВАШЕГО_РЕСУРСА" \
    -F "receipt=@path/to/receipt.pdf" \
    -F "payment_id=123"

GET /api/payment/status/{payment_id}

Проверить статус платежа по его ID.

curl -X GET "https://easy2pay.xyz/api/payment/status/123" \
    -H "X-API-KEY: ВАШ_API_КЛЮЧ" \
    -H "X-RESOURCE-NAME: ИМЯ_ВАШЕГО_РЕСУРСА"

POST /api/reissue_api_key

Перевыпуск API ключа для обеспечения безопасности. Этот метод следует использовать, если ваш текущий ключ был скомпрометирован.

curl -X POST "https://easy2pay.xyz/api/reissue_api_key" \
    -H "X-API-KEY: ВАШ_ТЕКУЩИЙ_API_КЛЮЧ" \
    -H "X-RESOURCE-NAME: ИМЯ_ВАШЕГО_РЕСУРСА" \
    -d '{"partner_id": "ваш_partner_id"}'

В ответ вы получите новый API ключ, который следует использовать в дальнейших запросах.

GET /api/cards

Получение списка карт с возможностью фильтрации.

curl -X GET "https://easy2pay.xyz/api/cards?active=true&min_amount=0" \
    -H "X-API-KEY: ВАШ_API_КЛЮЧ" \
    -H "X-RESOURCE-NAME: ИМЯ_ВАШЕГО_РЕСУРСА"

Поддержка

Если у вас возникли вопросы по работе с API или нужна помощь, пожалуйста, обращайтесь в нашу службу поддержки:

support@easy2pay.xyz