fiks / yoo-kassa-laravel
YooKassa Laravel Packagist
Requires
- ext-json: *
- guzzlehttp/guzzle: ^7.0.1
- jeremeamia/superclosure: ^2.4
- yoomoney/yookassa-sdk-php: ^2.1
Requires (Dev)
- orchestra/testbench: ^6.18
- dev-main
- 0.0.35-alpha
- 0.0.34-alpha
- 0.0.33-alpha
- 0.0.32-alpha
- 0.0.31-alpha
- 0.0.30-alpha
- 0.0.29-alpha
- 0.0.28-alpha
- 0.0.27-alpha
- 0.0.26-alpha
- 0.0.25-alpha
- 0.0.24-alpha
- 0.0.23-alpha
- 0.0.22-alpha
- 0.0.21-alpha
- 0.0.20-alpha
- 0.0.19-alpha
- 0.0.18-alpha
- 0.0.17-alpha
- 0.0.16-alpha
- 0.0.15-alpha
- 0.0.14-alpha
- 0.0.13-alpha
- 0.0.12-alpha
- 0.0.11-alpha
- 0.0.10-alpha
- 0.0.9-alpha
- 0.0.8-alpha
- 0.0.7-alpha
- 0.0.6-alpha
- 0.0.5-alpha
- 0.0.4-alpha
- 0.0.3-alpha
- 0.0.2-alpha
- 0.0.1-alpha
This package is auto-updated.
Last update: 2023-02-19 11:26:40 UTC
README
Lang: Russia
YooKassa Laravel Packagist
Version: 0.0.2-beta
Author: Danil Sidorenko
Оглавление
1. GetStarted | Top
Laravel пакет для YooKassa. Предназначен для упрощения работы
Установка
composer require fiks/yoo-kassa-laravel
config/app.php
'providers' => [ ... Fiks\YooKassa\YooKassaServiceProvider::class, ... ], 'aliases' => [ ... 'YooKassa' => Fiks\YooKassa\YooKassaFacade::class, ... ]
Публикация конфигураций
php artisan vendor:publish --provider=Fiks\YooKassa\YooKassaServiceProvider
Миграция (Обязательно)
Создать миграцию
php artisan migrate
Создает таблицу в базе данных: yookassa
Можно изменить название таблицы через .env:
YOOKASSA_DATABASE_TABLE_NAME
.
Столбец | Тип данных | Описание |
---|---|---|
{field_foreign} | unsignedBigInteger | null | ID-пользователя, если был передан.foreign {field_foreign} references {field_references} on {field_on} onDelete {field_delete} |
payment_id | string | ID-платежа из системы YooKassa |
status | enum(['pending', 'waiting_for_capture', 'succeeded', 'canceled']) | Статус платежа |
paid | boolean | Признак оплаты заказа |
sum | float, 2 | Сумма заказа с округлением в 2 знака после запятой |
currency | string | Код валюты по ISO 4217 |
payment_link | string | Ссылка для оплаты заказа на YooKassa |
description | string | Описание заказа |
paid_at | datetime | Дата оплаты в формате: 2018-07-25T10:52:00.233Z |
uniq_id | string | Уникальный ID в Вашей системе |
created_at | datetime | Дата создания заказа |
updated_at | datetime | Дата обновления заказа |
{field_foreign} -- возможно изменить данный столбец в .env:
YOOKASSA_DATABASE_FIELD_FOREIGN
. По умолчанию: user_id {field_on} -- возможно изменить данный столбец в .env:YOOKASSA_DATABASE_FIELD_ON
. По умолчанию: users {field_references} -- возможно изменить данный столбец в .env:YOOKASSA_DATABASE_FIELD_REFERENCES
. По умолчанию: id {field_delete} -- возможность изменить данный столбец в .env:YOOKASSA_DATABASE_FIELD_ON_DELETE
. По умолчанию: cascade
.env
Параметры в .env:
# Обязательные поля YOOKASSA_TOKEN=<API токен из магазина> YOOKASSA_ID=<ID-магазина> YOOKASSA_REDIRECT=<Ссылка после оплаты> # Необязательные поля YOOKASSA_DATABASE_FIELD_FOREIGN=<Поле которое будет зависить> YOOKASSA_DATABASE_FIELD_ON=<Таблица с которой есть зависимость> YOOKASSA_DATABASE_FIELD_REFERENCES=<Поле от которого будет зависить> YOOKASSA_DATABASE_FIELD_ON_DELETE=<Тип удаления строки> YOOKASSA_DATABASE_TABLE_NAME=<Имя таблицы в базе данной>
Токен можно взять: https://yookassa.ru/my/merchant/integration/api-keys
2. Доступные методы | Top
Методы для взаимодействия с API
Метод | Описание |
---|---|
createPayment | Создать ссылку на оплату |
createPayment | Top
Создать ссылку на оплату
Аргументы
Параметр | Тип данных | Описание | Пример |
---|---|---|---|
sum | float | Сумма заказа | 100.00 |
currency | string | Код валюты по ISO 4217 | RUB |
description | string | Описание заказа | Заказ №1 |
user_id | string | null | ID-пользователя | 1 |
Возможные ошибки:
Тип | Описание |
---|---|
ApiException | Неожиданный код ошибки. |
BadApiRequestException | Неправильный запрос. Чаще всего этот статус выдается из-за нарушения правил взаимодействия с API. |
ExtensionNotFoundException | Требуемое PHP расширение не установлено. |
ForbiddenException | Секретный ключ или OAuth-токен верный, но не хватает прав для совершения операции. |
InternalServerError | Технические неполадки на стороне ЮKassa. Результат обработки запроса неизвестен. Повторите запрос позднее с тем же ключом идемпотентности. |
NotFoundException | Ресурс не найден. |
ResponseProcessingException | Запрос был принят на обработку, но она не завершена. |
TooManyRequestsException | Превышен лимит запросов в единицу времени. Попробуйте снизить интенсивность запросов. |
UnauthorizedException | Неверный идентификатор вашего аккаунта в ЮKassa или секретный ключ (имя пользователя и пароль при аутентификации). |
Успешная операция
Возвращает класс CreatePayment
Методы | Описание | Возвращает |
---|---|---|
response() | Получить ответ от создания платежа | CreatePaymentResponse | null |