yourpayments/php-api-client

Your Payments - powerful payment gateway PHP integration

v1.7.8 2025-08-05 07:51 UTC

Requires

• php: >=7.4.0
• ext-curl: *
• ext-json: *
• ext-mbstring: *

mit

• YPMN Team

• payments
• processing

README

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

Оглавление

• Описание
• Требования
• Установка
  • Запуск встроенного сервера
  • Запуск в контейнере docker
• Примеры использования
  • Начало работы: настройка интеграции
  • Приём платежей
  • Подписки (рекуррентные платежи)
  • Токенизация (запомнить данные плательщика, чтобы не запрашивать и не вводить их повторно)
  • Отчёты и статусы платежей
  • Возврат средств плательщику (refunds, рефанды)
  • Выплаты (отправка денег по номеру карты или телефона)
  • Подключение продавцов
  • Обработка вебхуков
  • Страница после оплаты
  • Безопасные поля (отдельный вид интеграции карточной формы)
  • Обработка ошибок
• Обновление библиотеки
• Поддержка и контакты

Описание

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

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

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

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

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

• Сам клиент API
• Простой встроенный сервер с примерами
• Описание контейнера для запуска в Docker

Требования

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

Установка

Установка с пакета composer -- самый простой и рекомендуемый способ:

composer require yourpayments/php-api-client

Если на вашем проекте нет Composer, склонируйте или скачайте, а затем подключите файлы этого репозитория, (пример)

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

php -S localhost:8081 index.php

После запуска по адресу http://localhost:8081 будут доступны интерактивные примеры в следующем виде:

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

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

docker compose up

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

docker compose up --detach

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

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

1. Начало работы: настройка интеграции

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

1. Cамый простой платёж
2. Подробный платёж
3. Платёж со сплитом (разделением платежа для нескольких получателей)
4. Платёж через СБП (Систему Быстрых Платежей)
5. Списание средств (только для двустадийной оплаты)
6. Встраивание QR-кода без страницы оплаты

3. Подписки

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

1. Создание подписки СБП
2. Оплата по подписке СБП
3. Создание подписки SberPay, T-Pay, Картой не РФ
4. Оплата по подписке SberPay, T-Pay, Картой не РФ

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

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

1. Создание платёжного токена
2. Оплата токеном

5. Отчёты

1. Проверка статуса платежа
2. Запрос детального отчета по заказу
3. Запрос быстрого отчёта по заказам для сверки
4. Запрос отчёта по заказам
5. Запрос отчёта в виде графика

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

1. Возврат средств
2. Возврат средств со сплитом (разделением платежа)

7. Выплаты

1. Выплаты на банковские карты
2. Запрос баланса для выплаты

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

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

1. Подключение продавца-юридического лица (отправка анкеты)
2. Подключение продавца-ИП (отправка анкеты)
3. Получение статуса анкеты
4. Печать анкеты
5. Список анкет

9. Обработка вебхуков

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

10. Страница после оплаты

11. Безопасные поля (Secure fields)

1. Создание сессии
2. Оплата одноразовым токеном

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

Библиотека выбрасывает один вид исключений: Ypmn\PaymentException.

Пример перехвата исключения можно посмотреть в примере: Cамый простой платёж

Обновление

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

composer update yourpayments/php-api-client

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

• НКО «Твои Платежи»
• Докуметация API
• Тестовые банковские карты
• FAQ, ответы на частые вопросы
• Задать вопрос или сообщить о проблеме

🟢 «Твои Платежи» -- финтех для сайтов, платформ и приложений