yookassa.php¶

В этой статье

Методы API

yookassa/check_payment

yookassa/init

yookassa/sync_payments

Интеграция с сервисом ЮKassa для обработки платежей, инициализации сессий оплаты и синхронизации транзакций

Методы API¶

Метод	Действие	Описание
`check_payment`	проверка статуса платежа	Проверяет статус платежа в ЮKassa и при успешной оплате обновляет данные инвойса и создает транзакцию в системе.
`init`	инициализация оплаты	Создает платежную сессию в ЮKassa для конкретного инвойса и возвращает токен подтверждения.
`sync_payments`	синхронизация платежей	Запускает процесс синхронизации всех активных биллингов с ЮKassa для проверки статусов транзакций.

yookassa/check_payment¶

Проверяет статус платежа в ЮKassa и при успешной оплате обновляет данные инвойса и создает транзакцию в системе.

HTTP-метод: POST

Параметры:

action	✅	string	Идентификатор метода: `check_payment`
token	✅	string	Токен авторизации
id	✅	integer	Идентификатор платежа (payment id) для проверки статуса
source	❌	string	Источник вызова метода для определения логики обработки платежа.

Пример запроса

curl -s "https://invapi.hostkey.ru/yookassa.php" -X POST \
--data "action=check_payment" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE"

Пример успешного ответа

{
"result": "OK",
"message": "Paid",
"invoice_id": 123,
"rate": 1.0,
"comission": 5.5,
"subscription_activated": true
}

Примеры ошибок

{
"code": -1,
"message": "Invalid payment id"
}

yookassa/init¶

Создает платежную сессию в ЮKassa для конкретного инвойса и возвращает токен подтверждения.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: init
token	✅	string	Токен авторизации
force_subscr	❌	boolean	Флаг принудительного создания подписки для платежа.
invoice_id	✅	integer	Уникальный идентификатор счета в системе биллинга.

Пример запроса

curl -s "https://invapi.hostkey.ru/yookassa.php" -X POST \
--data "action=init" \
--data "token=HOSTKEY_TOKEN" \
--data "invoice_id=12345"

Пример успешного ответа

{
"result": "OK",
"message": "confirmation_token",
"id": 987654321
}

Примеры ошибок

{
"code": -1,
"message": "yookassa init failed: error_description"
}

yookassa/sync_payments¶

Запускает процесс синхронизации всех активных биллингов с ЮKassa для проверки статусов транзакций.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `sync_payments`
token	✅	string	Токен авторизации
billing	❌	`array<string>`	Список идентификаторов биллингов для синхронизации платежей.

Пример запроса

curl -s "https://invapi.hostkey.ru/yookassa.php" -X POST \
--data "action=sync_payments" \
--data "token=HOSTKEY_TOKEN" \
--data "billing[]=1" \
--data "billing[]=2"

Пример успешного ответа

{
"result": "OK",
"action": "sync_payments",
"data": {}
}

Примеры ошибок

{
"code": -1,
"message": "unable to identify target billing"
}