# XPayConnect API

**XPayConnect** — платформа для приёма платежей и выплат, поддерживающая множество платёжных методов: банковские карты, СБП, мобильные переводы, криптовалюта.

## Быстрый старт

{% stepper %}
{% step %}

#### Получите API-ключ

Запросите `client-api-key` у администратора системы.
{% endstep %}

{% step %}

#### Настройте авторизацию

Каждый запрос подписывается SHA-256 хешем. Подробнее в разделе [Авторизация](https://docs.xpayconnect.io/concepts/auth).
{% endstep %}

{% step %}

#### Создайте первый ордер

Отправьте POST-запрос на `/merchant/createOrder`. Подробнее в разделе [Создание ордера](https://docs.xpayconnect.io/orders/create).
{% endstep %}
{% endstepper %}

## Базовый URL

```
https://api.xpayconnect.io
```

{% hint style="info" %}
Все запросы выполняются по HTTPS. HTTP-запросы не поддерживаются.
{% endhint %}

## Разделы документации

| Раздел                                                              | Описание                             |
| ------------------------------------------------------------------- | ------------------------------------ |
| [Описание протокола](https://docs.xpayconnect.io/concepts/protocol) | Формат запросов и ответов            |
| [Авторизация](https://docs.xpayconnect.io/concepts/auth)            | Подпись запросов через SHA-256       |
| [Вебхуки](https://docs.xpayconnect.io/concepts/webhooks)            | Получение уведомлений о статусах     |
| [Создание ордера](https://docs.xpayconnect.io/orders/create)        | Приём платежей (PAYIN)               |
| [Создание выплаты](https://docs.xpayconnect.io/orders/payout)       | Выплаты клиентам (PAYOUT)            |
| [Информация об ордере](https://docs.xpayconnect.io/orders/info)     | Получение статуса ордера             |
| [Список ордеров](https://docs.xpayconnect.io/orders/list)           | Фильтрация и пагинация               |
| [Пул реквизитов](https://docs.xpayconnect.io/orders/requisite-pool) | Предварительное получение реквизитов |
| [Баланс](https://docs.xpayconnect.io/finance/balance)               | Текущий баланс мерчанта              |
| [Ошибки](https://docs.xpayconnect.io/errors/error-codes)            | Коды ошибок и их описания            |