PHPackages                             yourpayments/php-api-client - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Payment Processing](/categories/payments)
4. /
5. yourpayments/php-api-client

ActivePackage[Payment Processing](/categories/payments)

yourpayments/php-api-client
===========================

Your Payments - powerful payment gateway PHP integration

1.8.1(2mo ago)710.9k↓12.2%2[2 PRs](https://github.com/yourpayments/php-api-client/pulls)mitPHPPHP >=7.4.0

Since Aug 16Pushed 2mo ago2 watchersCompare

[ Source](https://github.com/yourpayments/php-api-client)[ Packagist](https://packagist.org/packages/yourpayments/php-api-client)[ RSS](/packages/yourpayments-php-api-client/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (10)DependenciesVersions (65)Used By (0)

«Твои Платежи»: Интеграция на PHP
=================================

[](#твои-платежи-интеграция-на-php)

Готовая библиотека PHP API Client для YourPayments + примеры с комментариями

[![](https://repository-images.githubusercontent.com/638835276/2067d028-b541-4355-b069-3c12c8a28042)](https://repository-images.githubusercontent.com/638835276/2067d028-b541-4355-b069-3c12c8a28042)

Оглавление
----------

[](#оглавление)

- [Описание](#%D0%BE%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5)
- [Требования](#%D1%82%D1%80%D0%B5%D0%B1%D0%BE%D0%B2%D0%B0%D0%BD%D0%B8%D1%8F)
- [Установка](#%D1%83%D1%81%D1%82%D0%B0%D0%BD%D0%BE%D0%B2%D0%BA%D0%B0)
    - [Запуск встроенного сервера](#%D0%B7%D0%B0%D0%BF%D1%83%D1%81%D0%BA-%D0%B2%D1%81%D1%82%D1%80%D0%BE%D0%B5%D0%BD%D0%BD%D0%BE%D0%B3%D0%BE-%D1%81%D0%B5%D1%80%D0%B2%D0%B5%D1%80%D0%B0)
    - [Запуск в контейнере docker](#%D0%B7%D0%B0%D0%BF%D1%83%D1%81%D0%BA-%D0%B2-%D0%BA%D0%BE%D0%BD%D1%82%D0%B5%D0%B9%D0%BD%D0%B5%D1%80%D0%B5-docker)
- [Примеры использования](#%D0%BF%D1%80%D0%B8%D0%BC%D0%B5%D1%80%D1%8B-%D0%B8%D1%81%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D0%BD%D0%B8%D1%8F)
    - [Начало работы: настройка интеграции](#1-%D0%BD%D0%B0%D1%87%D0%B0%D0%BB%D0%BE-%D1%80%D0%B0%D0%B1%D0%BE%D1%82%D1%8B-%D0%BD%D0%B0%D1%81%D1%82%D1%80%D0%BE%D0%B9%D0%BA%D0%B0-%D0%B8%D0%BD%D1%82%D0%B5%D0%B3%D1%80%D0%B0%D1%86%D0%B8%D0%B8)
    - [Приём платежей](#2-%D0%BF%D1%80%D0%B8%D1%91%D0%BC-%D0%BF%D0%BB%D0%B0%D1%82%D0%B5%D0%B6%D0%B5%D0%B9)
    - [Подписки](#3-%D0%BF%D0%BE%D0%B4%D0%BF%D0%B8%D1%81%D0%BA%D0%B8) (рекуррентные платежи)
    - [Токенизация](#4-%D1%82%D0%BE%D0%BA%D0%B5%D0%BD%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F) (запомнить данные плательщика, чтобы не запрашивать и не вводить их повторно)
    - [Отчёты и статусы платежей](#5-%D0%BE%D1%82%D1%87%D1%91%D1%82%D1%8B)
    - [Возврат средств плательщику](#6-%D0%B2%D0%BE%D0%B7%D0%B2%D1%80%D0%B0%D1%82-%D1%81%D1%80%D0%B5%D0%B4%D1%81%D1%82%D0%B2-%D0%BF%D0%BB%D0%B0%D1%82%D0%B5%D0%BB%D1%8C%D1%89%D0%B8%D0%BA%D1%83-refund) (refunds, рефанды)
    - [Выплаты](#7-%D0%B2%D1%8B%D0%BF%D0%BB%D0%B0%D1%82%D1%8B) (отправка денег по номеру карты или телефона)
    - [Подключение продавцов](#8-%D0%BF%D0%BE%D0%B4%D0%BA%D0%BB%D1%8E%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-%D0%BF%D1%80%D0%BE%D0%B4%D0%B0%D0%B2%D1%86%D0%BE%D0%B2)
    - [Обработка вебхуков](#9-%D0%BE%D0%B1%D1%80%D0%B0%D0%B1%D0%BE%D1%82%D0%BA%D0%B0-%D0%B2%D0%B5%D0%B1%D1%85%D1%83%D0%BA%D0%BE%D0%B2)
    - [Страница после оплаты](#10-%D1%81%D1%82%D1%80%D0%B0%D0%BD%D0%B8%D1%86%D0%B0-%D0%BF%D0%BE%D1%81%D0%BB%D0%B5-%D0%BE%D0%BF%D0%BB%D0%B0%D1%82%D1%8B)
    - [Безопасные поля](#11-%D0%B1%D0%B5%D0%B7%D0%BE%D0%BF%D0%B0%D1%81%D0%BD%D1%8B%D0%B5-%D0%BF%D0%BE%D0%BB%D1%8F-secure-fields) (отдельный вид интеграции карточной формы)
    - [Обработка ошибок](#12-%D0%BE%D0%B1%D1%80%D0%B0%D0%B1%D0%BE%D1%82%D0%BA%D0%B0-%D0%BE%D1%88%D0%B8%D0%B1%D0%BE%D0%BA)
- [Обновление библиотеки](#%D0%BE%D0%B1%D0%BD%D0%BE%D0%B2%D0%BB%D0%B5%D0%BD%D0%B8%D0%B5)
- [Поддержка и контакты](#%D1%81%D1%81%D1%8B%D0%BB%D0%BA%D0%B8-%D0%BF%D0%BE%D0%B4%D0%B4%D0%B5%D1%80%D0%B6%D0%BA%D0%B0-%D0%B8-%D0%BA%D0%BE%D0%BD%D1%82%D0%B0%D0%BA%D1%82%D1%8B)

Описание
--------

[](#описание)

`yourpayments/php-api-client` — это PHP библиотека для быстрой и удобной интеграции с платежным шлюзом YourPayments. С её помощью можно принимать оплаты и создавать выплаты, получать отчёты, делать возвраты и работать с подпискам.

Библиотека ориентирована на простое и надёжное использование, подходит как для опытных, так и для начинающих разработчиков.

Пример быстрого старта для приёма платежей:

```
$merchant = new Merchant('MERCHANT_CODE', 'SECRET_KEY'); // Коды подключения API
$merchantPaymentReference = 123; // Номер заказа в вашей системе
$billing = (new Billing)
  ->setCountryCode('RU') // Страна Плательщика
  ->setFirstName('Иван') // Имя Плательщика
  ->setLastName('Петров') // Фамилия Плательщика
  ->setEmail('test1@ypmn.ru') // Почта Плательщика
  ->setPhone('+74996492009') // Телефон Плательщика
  ->setCity('Москва');  // Город Плательщика

$client = (new Client)->setBilling($billing);
$payment = (new Payment)
  ->addProduct(new Product([
    'name'  => 'Заказ №' . $merchantPaymentReference, // Наименование товарной позиции
    'sku'  => 'test_artikul', // Артикул
    'unitPrice'  => 20.42, // Стоимость единицы
    'quantity'  => 1, // Количество
]));
$payment_method = $_GET['method'] ?? PaymentMethods::CCVISAMC; // Определим платёжный метод
$authorization = new Authorization($payment_method, true);
$payment->setAuthorization($authorization);
$payment->setMerchantPaymentReference($merchantPaymentReference);
$payment->setSuccessUrl('https://' . $_SERVER['HTTP_HOST'] . '/?status=success'); // Редирект после успешной оплаты
$payment->setFailUrl('https://' . $_SERVER['HTTP_HOST'] . '/?status=success'); // Редирект в случае неоплаты
$payment->setClient($client);

$apiRequest = new ApiRequest($merchant);
$responseData = $apiRequest->sendAuthRequest($payment, $merchant);
$responseData = json_decode((string) $responseData["response"], true); // Отправка запроса и обработка ответа
if (isset($responseData["paymentResult"])) {
    if (!empty($responseData['paymentResult']['bankResponseDetails']['customBankNode']['qr'])) {
        $qr = $responseData['paymentResult']['bankResponseDetails']['customBankNode']['qr'];
    }

    // Выведем кнопку оплаты (рекомендуется)
    echo Std::drawYpmnButton([
        'qr' => ($qr ?? null),
        'url' => $responseData['paymentResult']['url'] ?? '',
        'sum' => $payment->sumProductsAmount() ?? 0,
        'payment_method' => $payment_method ?? null,
        'newpage' => true,
    ]);

    // .. или сделаем редирект на форму оплаты (опционально)
    // Std::redirect($responseData["paymentResult"]['url']);
}
```

Особенностями системы являются:

- мульти-эквайринг (работа сразу со многими банками, переключение в случае недоступности)
- поддержка сплитования (разделение одного платежа на несколько получателей платежа, в рамках одного чеке)
- безопасность и точность расчётов

Библиотека содержит:

- Клиент для работы с API платежей, выплат, отчётов
- Простой встроенный сервер с примерами
- Описание контейнера для запуска в Docker

---

Требования
----------

[](#требования)

- PHP 7.4 и выше (рекомендуется PHP 8.1+)
- Расширения PHP: `curl`, `json`, `mbstring`
- Рекомендуется: Composer для управления зависимостями

---

Установка
---------

[](#установка)

Установка с [пакета composer](https://packagist.org/packages/yourpayments/php-api-client) -- самый простой и рекомендуемый способ:

```
composer require yourpayments/php-api-client
```

Если на вашем проекте нет Composer, склонируйте или скачайте, а затем подключите файлы этого репозитория, ([пример](src/Examples/autoload.php))

### Запуск встроенного сервера

[](#запуск-встроенного-сервера)

```
php -S localhost:8080 index.php
```

После запуска по адресу  будут доступны интерактивные примеры в следующем виде: [![скриншот встроенного сервера с примерами](/assets/img/screenshot2.jpg)](/assets/img/screenshot2.jpg)

### Запуск в контейнере docker

[](#запуск-в-контейнере-docker)

Создайте и запустите docker контейнер следующей командой:

```
docker compose up
```

Либо в фоновом режиме командой:

```
docker compose up --detach
```

После выполнения сервис с документацией и примерами будет доступен по адресу

---

Примеры использования:
----------------------

[](#примеры-использования)

##### 1. [Начало работы: настройка интеграции](src/Examples/start.php)

[](#1-начало-работы-настройка-интеграции)

##### 2. Приём платежей

[](#2-приём-платежей)

1. [Платёж, токенизация, чеки](src/Examples/authorize.php)
2. [Минимальная установка](src/Examples/minimal.php)
3. [Списание средств (только для двустадийной оплаты)](src/Examples/paymentCapture.php)

##### 3. Подписки

[](#3-подписки)

Рекуррентные платежи

1. [Создание подписки СБП](src/Examples/getBindingFasterPayment.php)
2. [Оплата по подписке СБП](src/Examples/paymentByFasterBinding.php)
3. [Создание подписки SberPay, T-Pay, Картой не РФ](src/Examples/getBindingPays.php)
4. [Оплата по подписке SberPay, T-Pay, Картой не РФ](src/Examples/paymentByBindingPays.php)

##### 4. Токенизация

[](#4-токенизация)

Запомнить данные клиента, чтобы не запрашивать и не вводить их повторно

1. [Создание платёжного токена ](src/Examples/getToken.php)
2. [Оплата токеном](src/Examples/paymentByToken.php)

##### 5. Отчёты

[](#5-отчёты)

1. [Проверка статуса платежа](src/Examples/paymentGetStatus.php)
2. [Запрос детального отчета по заказу](src/Examples/getReportOrderDetails.php)
3. [Запрос быстрого отчёта по заказам для сверки](src/Examples/getReportOrder.php)
4. [Запрос отчёта по заказам](src/Examples/getReportGeneral.php)
5. [Запрос отчёта в виде графика](src/Examples/getReportChart.php)

##### 6. Возврат средств плательщику (Refund)

[](#6-возврат-средств-плательщику-refund)

1. [Возврат средств](src/Examples/paymentRefund.php)
2. [Возврат средств со сплитом (разделением платежа)](src/Examples/paymentRefundMarketplace.php)

##### 7. Выплаты

[](#7-выплаты)

1. [Выплаты на банковские карты](src/Examples/payout.php)
2. [Запрос баланса для выплаты](src/Examples/payoutGetBalance.php)

##### 8. Подключение продавцов

[](#8-подключение-продавцов)

Добавление сабмерчантов маркетплейсов по API

1. [Подключение продавца-юридического лица (отправка анкеты)](src/Examples/qstCreateOrg.php)
2. [Подключение продавца-ИП (отправка анкеты)](src/Examples/qstCreateIp.php)
3. [Получение статуса анкеты](src/Examples/qstStatus.php)
4. [Печать анкеты](src/Examples/qstPrint.php)
5. [Список анкет](src/Examples/qstList.php)

##### 9. [Обработка вебхуков](src/Examples/webhookProcessing.php)

[](#9-обработка-вебхуков)

Вебхуки -- HTTP запросы, оповещающие ваш сервер о событиях (успешные и неуспешные оплаты, списания)

##### 10. [Страница после оплаты](src/Examples/returnPage.php)

[](#10-страница-после-оплаты)

##### 11. [Безопасные поля (Secure fields)](src/Examples/secureFields.php)

[](#11-безопасные-поля-secure-fields)

2. [Создание сессии](src/Examples/getSession.php)
3. [Оплата одноразовым токеном](src/Examples/oneTimeTokenPayment.php)

##### 12. Обработка ошибок

[](#12-обработка-ошибок)

Библиотека выбрасывает один вид исключений: [Ypmn\\PaymentException](/src/PaymentException.php).

Пример перехвата исключения можно посмотреть в примере: [Cамый простой платёж](src/Examples/simpleGetPaymentLink.php)

---

Обновление
----------

[](#обновление)

Обновления библиотеки позволяют быстро исправлять ошибки и получать доступ к новым функциям

```
composer update yourpayments/php-api-client
```

---

Ссылки, поддержка и контакты
----------------------------

[](#ссылки-поддержка-и-контакты)

- [НКО «Твои Платежи»](https://YPMN.ru/?utm_source=php-api-client)
- [Докуметация API](https://ypmn.ru/doc/?utm_source=php-api-client)
- [Тестовые банковские карты](https://ypmn.ru/doc/?utm_source=php-api-client#tag/testing)
- [FAQ, ответы на частые вопросы](https://ypmn.ru/ru/support/?utm_source=php-api-client)
- [Задать вопрос или сообщить о проблеме](https://github.com/yourpayments/php-api-client/issues/new)

---

🟢 [«Твои Платежи»](https://YPMN.ru/ "Платёжная система для сайтов, платформ и приложений") -- финтех для сайтов, платформ и приложений

###  Health Score

51

—

FairBetter than 96% of packages

Maintenance83

Actively maintained with recent releases

Popularity33

Limited adoption so far

Community16

Small or concentrated contributor base

Maturity61

Established project with proven stability

 Bus Factor1

Top contributor holds 55.1% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~23 days

Recently: every ~54 days

Total

44

Last Release

88d ago

Major Versions

v0.4 → v1.02023-06-07

PHP version history (2 changes)v0.1PHP >=8.1.0

v1.0PHP >=7.4.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/bab56f1924a991121972ddfa6868efceb7b1134bf0e0ea74279b5be46127c318?d=identicon)[ypmn](/maintainers/ypmn)

![](https://www.gravatar.com/avatar/5d363f5cbe44b64f04e67c782e58c771ec8cf96d415a19f5575fe955edcbf5f0?d=identicon)[doctorrr](/maintainers/doctorrr)

---

Top Contributors

[![payuru](https://avatars.githubusercontent.com/u/6647627?v=4)](https://github.com/payuru "payuru (108 commits)")[![yourpayments](https://avatars.githubusercontent.com/u/133095074?v=4)](https://github.com/yourpayments "yourpayments (64 commits)")[![Doctorrr](https://avatars.githubusercontent.com/u/3382350?v=4)](https://github.com/Doctorrr "Doctorrr (14 commits)")[![whoiann](https://avatars.githubusercontent.com/u/62791216?v=4)](https://github.com/whoiann "whoiann (9 commits)")[![roman-zimin-ypmn](https://avatars.githubusercontent.com/u/160482286?v=4)](https://github.com/roman-zimin-ypmn "roman-zimin-ypmn (1 commits)")

---

Tags

ecommercefintechfintech-apiinternet-paymentsonline-paymentonline-paymentspaymentpayment-apipayment-gatewaypayment-integrationpayment-processingpaymentmethodspaymentspayments-platformphpphp-libraryprocessingpayments

### Embed Badge

![Health badge](/badges/yourpayments-php-api-client/health.svg)

```
[![Health](https://phpackages.com/badges/yourpayments-php-api-client/health.svg)](https://phpackages.com/packages/yourpayments-php-api-client)
```

###  Alternatives

[amzn/amazon-pay-sdk-php

Amazon Pay SDK (PHP)

20512.1M3](/packages/amzn-amazon-pay-sdk-php)[unicodeveloper/laravel-paystack

A Laravel Package for Paystack

650975.6k11](/packages/unicodeveloper-laravel-paystack)[ignited/laravel-omnipay

Integrates Omnipay with Laravel and provides an easy configuration.

5211.1M12](/packages/ignited-laravel-omnipay)[recurly/recurly-client

The PHP client library for the Recurly API

1736.3M7](/packages/recurly-recurly-client)[chargebee/chargebee-php

ChargeBee API client implementation for PHP

768.0M9](/packages/chargebee-chargebee-php)[amzn/amazon-pay-api-sdk-php

Amazon Pay API SDK (PHP)

505.1M9](/packages/amzn-amazon-pay-api-sdk-php)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)