# Zetplat API

> API для приёма платежей и проведения выплат: банковские карты, СБП, виджеты, рекуррентные платежи, возвраты.

Документация по интеграции с платёжным API Zetplat. Содержит руководства по началу работы, правилам работы с API, проведению выплат и платежей, подключению виджетов, работе с отчётами, а также полную спецификацию API: объекты, методы, вебхуки и ошибки.

- [Документация](https://docs.zetplat.com/): Главная страница портала с навигацией по разделам.

## Начало работы

- [Быстрый старт](https://docs.zetplat.com/starting): Начало работы: получение ключей, тестовые транзакции, запуск в продакшн.

## Правила работы с API

- [Как подписать запрос](https://docs.zetplat.com/api-rules/signature): Формирование RSA-подписи с алгоритмом SHA-256 для аутентификации запросов и проверка входящих вебхуков.
- [Как послать запрос](https://docs.zetplat.com/api-rules/request): Формат запросов и ответов API, URL для тестовой и реальной среды, обработка ошибок.
- [Как тестировать](https://docs.zetplat.com/api-rules/testing): Проведение тестовых транзакций с тестовыми картами и сценариями.
- [Идемпотентность](https://docs.zetplat.com/api-rules/idempotency): Обеспечение идемпотентности запросов для безопасных повторных отправок.

## Выплаты

- [Обзор выплат](https://docs.zetplat.com/transfers/payouts-intro): Как проводить выплаты физическим лицам на карты Visa/MasterCard и через СБП.
- [Выплаты на карту](https://docs.zetplat.com/transfers/payout-pcidss): Выплаты с самостоятельным сбором данных карты (требуется PCI DSS).
- [Выплаты на карту с виджетом](https://docs.zetplat.com/transfers/payout-widget): Выплаты через встраиваемый виджет, минимальные требования PCI DSS.
- [Выплаты на карту по токену](https://docs.zetplat.com/transfers/payout-tokenized-card): Выплаты по существующему токену карты.
- [Выплаты через СБП](https://docs.zetplat.com/transfers/payout-sbp): Выплаты через Систему быстрых платежей.
- [Возвраты выплат](https://docs.zetplat.com/transfers/payout-refunds): Возврат успешных выплат.

## Платежи

- [Обзор платежей](https://docs.zetplat.com/checkouts/payment-intro): Как принимать платежи банковскими картами и через СБП.
- [Платежи с холдированием](https://docs.zetplat.com/checkouts/payment-hold): Двухстадийные платежи: холдирование и последующее списание.
- [Платежи банковской картой](https://docs.zetplat.com/checkouts/payment-cards): Платежи с самостоятельным сбором данных карты.
- [Платежи через виджет](https://docs.zetplat.com/checkouts/payment-with-form): Платежи через встраиваемую форму оплаты.
- [Рекуррентные платежи](https://docs.zetplat.com/checkouts/payment-recurring): Автоматические регулярные списания по токену карты.
- [Платежи через СБП](https://docs.zetplat.com/checkouts/fps): Платежи через Систему быстрых платежей.
- [Рекуррентные платежи через СБП](https://docs.zetplat.com/checkouts/recurring-fps): Регулярные списания через СБП.
- [Возвраты платежей](https://docs.zetplat.com/checkouts/payment-refund): Возврат денег по успешным платежам.

## Виджеты

- [Виджет платежной формы](https://docs.zetplat.com/iframe/payment-widget): Встраиваемая JS-форма для приёма платежей с настройкой внешнего вида и текстов.
- [Виджет токенизации карты](https://docs.zetplat.com/iframe/tokenize-widget): Виджет для безопасной токенизации данных карты.

## Отчёты

- [Ежедневный реестр выплат](https://docs.zetplat.com/logs/daily-payout-report): CSV-реестр всех выплат за сутки, описание полей.
- [Ежедневный реестр платежей](https://docs.zetplat.com/logs/daily-payment-report): CSV-реестр всех платежей за сутки.

## API

- [Объекты](https://docs.zetplat.com/spec/objects): Все модели данных API: платежи, выплаты, сессии, токены, ошибки.
- [Методы](https://docs.zetplat.com/spec/methods): Полное описание всех эндпоинтов API.
- [Вебхуки](https://docs.zetplat.com/spec/webhooks): Уведомления о событиях: статусы платежей, выплат, возвратов.
- [Ошибки](https://docs.zetplat.com/spec/errors): Коды и описания ошибок API.