kostikpenzin/alfabank-api-acquiring
Composer 安装命令:
composer require kostikpenzin/alfabank-api-acquiring
包简介
Api client for Alfabank acquiring
关键字:
README 文档
README
Полнофункциональная PHP библиотека для интеграции с API интернет-эквайринга Альфа-Банка. Предоставляет простой и удобный интерфейс для проведения онлайн-платежей, управления заказами и работы с привязанными картами.
Особенности
- 🚀 Полная поддержка API - все методы интернет-эквайринга Альфа-Банка
- 🔐 Гибкая аутентификация - поддержка токенов и логин/пароль
- 💳 Привязанные карты - полный цикл работы с сохраненными картами
- 🛡️ Безопасность - валидация параметров и обработка ошибок
- 📋 PSR-совместимость - современные стандарты PHP
- 🔧 Простая интеграция - минимум настроек для старта
- 📚 Подробная документация - примеры для всех сценариев
Требования
- PHP 7.4 или выше
- Composer
- Расширения:
curl,json,mbstring - Аккаунт мерчанта в Альфа-Банке
Установка
composer require kostikpenzin/alfabank-api-acquiring
Быстрый старт
Инициализация клиента
<?php require_once 'vendor/autoload.php'; use kostikpenzin\AlfabankApiAcquiring\Client; // Аутентификация по токену (рекомендуется) $client = new Client([ 'baseUrl' => 'https://alfa.rbsuat.com', // тестовая среда 'token' => 'your-api-token' ]); // Или аутентификация по логину/паролю $client = new Client([ 'baseUrl' => 'https://alfa.rbsuat.com', 'userName' => 'your-username', 'password' => 'your-password' ]);
Создание заказа
$orderId = 'order_' . time(); $response = $client->register([ 'orderNumber' => $orderId, 'amount' => 10000, // сумма в копейках (100.00 руб) 'returnUrl' => 'https://your-site.com/payment/success', 'failUrl' => 'https://your-site.com/payment/fail', 'description' => 'Оплата заказа #' . $orderId, 'language' => 'ru', 'clientId' => 'customer_123', 'email' => 'customer@example.com', ]); if (isset($response['formUrl'])) { // Перенаправить клиента на страницу оплаты header('Location: ' . $response['formUrl']); } else { // Обработать ошибку echo 'Ошибка создания заказа: ' . ($response['errorMessage'] ?? 'Unknown error'); }
Проверка статуса заказа
$status = $client->getOrderStatus([ 'orderId' => $response['orderId'] // ID заказа из предыдущего примера ]); switch ($status['OrderStatus']) { case 0: echo 'Заказ зарегистрирован, но не оплачен'; break; case 1: echo 'Предавторизованная сумма захолдирована'; break; case 2: echo 'Проведена полная авторизация суммы заказа'; break; case 3: echo 'Авторизация отменена'; break; case 4: echo 'По транзакции была проведена операция возврата'; break; case 5: echo 'Инициирована авторизация через ACS банка-эмитента'; break; case 6: echo 'Авторизация отклонена'; break; }
Подробная документация
Конфигурация
Доступные параметры конфигурации
$client = new Client([ 'baseUrl' => 'https://web.rbsuat.com', // URL API (prod: https://web.rbsuat.com) 'token' => 'your-token', // API токен 'userName' => 'merchant_login', // Логин мерчанта 'password' => 'merchant_password', // Пароль мерчанта 'timeout' => 30, // Таймаут соединения в секундах 'connect_timeout' => 10, // Таймаут подключения в секундах ]);
Переменные окружения
Рекомендуется использовать переменные окружения для хранения конфиденциальных данных:
$client = new Client([ 'baseUrl' => $_ENV['ALFABANK_BASE_URL'] ?? 'https://alfa.rbsuat.com', 'token' => $_ENV['ALFABANK_TOKEN'], ]);
Основные операции
1. Регистрация заказа
// Базовая регистрация $response = $client->register([ 'orderNumber' => 'ORDER_001', 'amount' => 150000, // 1500.00 руб в копейках 'returnUrl' => 'https://shop.com/success', 'failUrl' => 'https://shop.com/fail', 'description' => 'Покупка товара', ]); // Расширенная регистрация с дополнительными параметрами $response = $client->register([ 'orderNumber' => 'ORDER_001', 'amount' => 150000, 'currency' => 643, // RUB 'returnUrl' => 'https://shop.com/success', 'failUrl' => 'https://shop.com/fail', 'description' => 'Покупка товара', 'language' => 'ru', 'pageView' => 'DESKTOP', 'clientId' => 'client_123', 'merchantLogin' => 'sub_merchant', 'jsonParams' => [ 'email' => 'client@example.com', 'phone' => '+7-900-123-45-67' ], 'sessionTimeoutSecs' => 1200, 'expirationDate' => '2024-12-31T23:59:59', 'features' => 'AUTO_PAYMENT' ]);
2. Предавторизация
$response = $client->registerPreAuth([ 'orderNumber' => 'PREAUTH_001', 'amount' => 50000, 'returnUrl' => 'https://shop.com/success', 'description' => 'Предавторизация платежа' ]); // Позже подтвердить платеж if ($response['orderId']) { $depositResponse = $client->deposit([ 'orderId' => $response['orderId'], 'amount' => 30000 // можно списать меньше ]); }
3. Расширенная информация о заказе
$detailedStatus = $client->getOrderStatusExtended([ 'orderId' => 'order-uuid', 'orderNumber' => 'ORDER_001' ]); // Получить дополнительную информацию echo "Номер карты: " . $detailedStatus['Pan']; echo "Код авторизации: " . $detailedStatus['approvalCode']; echo "Сумма к списанию: " . $detailedStatus['depositAmount'];
Управление платежами
Отмена авторизации
$response = $client->reverse([ 'orderId' => 'order-uuid' ]); if ($response['errorCode'] === '0') { echo 'Авторизация успешно отменена'; }
Возврат средств
// Полный возврат $response = $client->refund([ 'orderId' => 'order-uuid', 'amount' => 150000 // полная сумма заказа ]); // Частичный возврат $response = $client->refund([ 'orderId' => 'order-uuid', 'amount' => 50000 // частичная сумма ]);
Работа с привязанными картами
Получение списка привязанных карт
$bindings = $client->getBindings([ 'clientId' => 'client_123' ]); foreach ($bindings as $binding) { echo "Карта: " . $binding['pan']; echo "ID привязки: " . $binding['bindingId']; echo "Срок действия: " . $binding['expiryDate']; }
Оплата привязанной картой
// Сначала создать заказ с привязкой $order = $client->register([ 'orderNumber' => 'BINDING_ORDER_001', 'amount' => 75000, 'returnUrl' => 'https://shop.com/success', 'bindingId' => 'binding-uuid-here', 'description' => 'Оплата сохраненной картой' ]); // Затем провести оплату $payment = $client->paymentOrderBinding([ 'mdOrder' => $order['orderId'], 'bindingId' => 'binding-uuid-here', 'ip' => $_SERVER['REMOTE_ADDR'], 'cvc' => '123', // опционально 'email' => 'client@example.com' ]);
Управление привязками
// Отвязать карту $client->unBindCard([ 'bindingId' => 'binding-uuid' ]); // Продлить привязку $client->extendBinding([ 'bindingId' => 'binding-uuid', 'newExpiry' => 202512 // YYYYMM ]); // Найти привязки по номеру карты $bindings = $client->getBindingsByCardOrId([ 'pan' => 411111111111, 'showExpired' => false ]);
Дополнительные операции
Добавление параметров к заказу
$response = $client->addParams([ 'orderId' => 'order-uuid', 'params' => [ 'custom_field_1' => 'value1', 'custom_field_2' => 'value2' ] ]);
Получение списка заказов
$orders = $client->getLastOrdersForMerchants([ 'size' => 20, 'from' => '2024-01-01T00:00:00', 'to' => '2024-01-31T23:59:59', 'transactionStates' => 'DEPOSITED,APPROVED', 'merchants' => 'merchant_login' ]);
Проверка участия в 3DS
$enrollment = $client->verifyEnrollment([ 'pan' => 4111111111111111 ]); if ($enrollment['enrolled'] === 'Y') { echo 'Карта поддерживает 3D-Secure'; }
Обработка ошибок
Базовая обработка
try { $response = $client->register([ 'orderNumber' => 'ORDER_001', 'amount' => 100000, 'returnUrl' => 'https://shop.com/success' ]); if (isset($response['errorCode']) && $response['errorCode'] !== '0') { throw new Exception('API Error: ' . $response['errorMessage']); } // Успешная обработка $orderId = $response['orderId']; $paymentUrl = $response['formUrl']; } catch (Exception $e) { error_log('Alfabank API Error: ' . $e->getMessage()); // Обработка ошибки }
Коды ошибок
| Код | Описание |
|---|---|
| 0 | Обработка прошла без ошибок |
| 1 | Заказ с таким номером уже зарегистрирован |
| 3 | Неизвестная валюта |
| 4 | Отсутствует обязательный параметр |
| 5 | Ошибка значения параметра |
| 6 | Незарегистрированный OrderId |
| 7 | Системная ошибка |
Тестирование
Тестовые карты
Для тестирования используйте следующие номера карт:
| Номер карты | Результат |
|---|---|
| 4111 1111 1111 1111 | Успешная оплата |
| 4111 1111 1111 1112 | Отклонение по недостатку средств |
| 4111 1111 1111 1113 | Отклонение по другим причинам |
Данные для тестирования:
- CVV: любые 3 цифры
- Срок действия: любая будущая дата
- Имя держателя: любое
Настройка тестовой среды
// Конфигурация для тестирования $testClient = new Client([ 'baseUrl' => 'https://alfa.rbsuat.com', // тестовый сервер 'token' => 'test-token-from-alfabank', 'timeout' => 60 // увеличенный таймаут для отладки ]);
Интеграция с фреймворками
Symfony
// config/services.yaml services: app.alfabank.client: class: kostikpenzin\AlfabankApiAcquiring\Client arguments: - baseUrl: '%env(ALFABANK_BASE_URL)%' token: '%env(ALFABANK_TOKEN)%' // В контроллере class PaymentController extends AbstractController { public function __construct( private Client $alfabankClient ) {} public function createPayment(Request $request): Response { $response = $this->alfabankClient->register([ 'orderNumber' => $request->get('order_id'), 'amount' => $request->get('amount'), 'returnUrl' => $this->generateUrl('payment_success', [], UrlGeneratorInterface::ABSOLUTE_URL), 'failUrl' => $this->generateUrl('payment_fail', [], UrlGeneratorInterface::ABSOLUTE_URL), ]); return $this->redirect($response['formUrl']); } }
Laravel
// config/alfabank.php return [ 'base_url' => env('ALFABANK_BASE_URL', 'https://alfa.rbsuat.com'), 'token' => env('ALFABANK_TOKEN'), ]; // В сервис-провайдере $this->app->singleton(Client::class, function () { return new Client(config('alfabank')); }); // В контроллере class PaymentController extends Controller { public function create(Request $request, Client $alfabank) { $response = $alfabank->register([ 'orderNumber' => $request->order_id, 'amount' => $request->amount, 'returnUrl' => route('payment.success'), 'failUrl' => route('payment.fail'), ]); return redirect($response['formUrl']); } }
Webhooks и уведомления
Обработка callback-уведомлений
// callback.php $orderId = $_POST['orderId'] ?? null; if ($orderId) { $status = $client->getOrderStatus(['orderId' => $orderId]); switch ($status['OrderStatus']) { case 2: // Оплачено // Обновить статус заказа в БД updateOrderStatus($orderId, 'paid'); // Отправить уведомление клиенту sendPaymentConfirmation($status['clientId']); break; case 6: // Отклонено updateOrderStatus($orderId, 'failed'); break; } } // Ответ банку http_response_code(200); echo 'OK';
Безопасность
Рекомендации по безопасности
- Никогда не храните токены в коде - используйте переменные окружения
- Валидируйте callback-уведомления - проверяйте подпись запросов
- Используйте HTTPS - для всех взаимодействий с API
- Логируйте операции - для аудита и отладки
- Ограничивайте доступ - используйте IP-ограничения
Пример безопасной конфигурации
// .env ALFABANK_BASE_URL="https://web.rbsuat.com" ALFABANK_TOKEN="your-production-token" ALFABANK_CALLBACK_SECRET="your-callback-secret" // Валидация callback function validateCallback($data, $signature) { $expectedSignature = hash_hmac('sha256', json_encode($data), $_ENV['ALFABANK_CALLBACK_SECRET'] ); return hash_equals($expectedSignature, $signature); }
Логирование и мониторинг
Добавление логирования
use Monolog\Logger; use Monolog\Handler\StreamHandler; $logger = new Logger('alfabank'); $logger->pushHandler(new StreamHandler('logs/alfabank.log', Logger::INFO)); // При выполнении операций $logger->info('Creating payment order', [ 'order_id' => $orderId, 'amount' => $amount, 'client_id' => $clientId ]); try { $response = $client->register($params); $logger->info('Payment order created successfully', [ 'alfabank_order_id' => $response['orderId'] ]); } catch (Exception $e) { $logger->error('Failed to create payment order', [ 'error' => $e->getMessage(), 'params' => $params ]); }
Поддержка и сообщество
- Документация Альфа-Банка: alfabank.ru/sme/payservice/internet-acquiring/docs/
- GitHub Issues: Сообщить о проблеме
- Email: penzin85@gmail.com
Лицензия
Данный проект распространяется под лицензией MIT. Подробности в файле LICENSE.
API connection with the payment page on the bank's side.
Installation
$ composer require kostikpenzin/alfabank-api-acquiring
Example
<?php include 'vendor/autoload.php'; $client = new \kostikpenzin\AlfabankApiAcquiring\Client([ 'baseUrl' => 'https://alfa.rbsuat.com', 'token' => "token", // or token 'userName' => "name", // or userName and password 'password' => "password" ]); $orderId = "test" . rand(); // create order for pay // https://alfabank.ru/sme/payservice/internet-acquiring/docs/connection-options/api/rest/#zapros_registratsii_zakaza $response = $client->register([ 'orderNumber' => $orderId, 'amount' => 10000, 'returnUrl' => "https://returnUrl", 'failUrl' => "https://failUrl", 'description' => "description order", 'language' => "ru", 'clientId' => rand(), 'email' => "penzin85@gmail.com", ]); print_r($response); /* response: { "orderId":"70906e55-7114-41d6-8332-4609dc6590f4", "formUrl":"https://alfa.rbsuat.com/payment/merchants/test/payment_ru.html?mdOrder=70906e55-7114-41d6-8332-4609dc6590f4" } */ // check status order // https://alfabank.ru/sme/payservice/internet-acquiring/docs/connection-options/api/rest/#zapros_sostojanija_zakaza $response = $client->getOrderStatus([ 'orderId' => $orderId ]); print_r($response); /* response: { "expiration":"201512", "cardholderName":"tr tr", "depositAmount": 789789, "currency":"810", "approvalCode":"123456", "authCode": 2, "clientId":"666", "bindingId":"07a90a5d-cc60-4d1b-a9e6-ffd15974a74f", "ErrorCode":"0", "ErrorMessage":"Успешно", "OrderStatus": 2, "OrderNumber":"23asdafaf", Pan":"411111**1111", "Amount": 789789 } */
Test cards for check integration
kostikpenzin/alfabank-api-acquiring 适用场景与选型建议
kostikpenzin/alfabank-api-acquiring 是一款 基于 PHP 开发的 Composer 扩展包,目前已累计 1.11k 次下载、GitHub Stars 达 6, 最近一次更新时间为 2023 年 12 月 08 日, 在 PHP 生态内属于活跃度较高的组件。
它主要适用于以下技术方向: 「acquiring」 「alfabank」 等业务场景。在实际项目中,围绕这些方向常见需要落地的问题包括:接口对接、性能调优、并发安全、与既有框架(Laravel / ThinkPHP / Yii / Webman 等)的兼容适配,以及生产环境的日志埋点与稳定性保障。
我们在过去多个企业项目中使用过 kostikpenzin/alfabank-api-acquiring 或与其功能相近的方案,如果你在选型或落地过程中遇到问题,例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查,欢迎联系我们协助评估。
基于 kostikpenzin/alfabank-api-acquiring 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。
线上偶发问题、内存泄漏、慢查询、并发异常等排查修复;针对高流量场景做缓存、队列、索引层面的调优。
承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维;也可按月提供技术保姆服务。
与 kostikpenzin/alfabank-api-acquiring 相关的其它包
同方向 / 同关键字的高下载量 PHP Composer 包推荐,方便对比选型:
Tinkoff Acquiring API PHP Client
Provides functionality to interoperate with Sberbank acquiring system
Библиотека для приема платежей через Альфабанк.
SberBank CallbackNotification handler
Simple PHP client for Sperbank acquiring REST API
Alfabank REST API integration
统计信息
- 总下载量: 1.11k
- 月度下载量: 0
- 日度下载量: 0
- 收藏数: 6
- 点击次数: 17
- 依赖项目数: 0
- 推荐数: 0
其他信息
- 授权协议: MIT
- 更新时间: 2023-12-08