# 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)            | Коды ошибок и их описания            |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.xpayconnect.io/readme.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.