> For the complete documentation index, see [llms.txt](https://docs.xpayconnect.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.xpayconnect.io/documentation/eng/readme.md).

# XPayConnect API

**XPayConnect** — a platform for accepting payments and payouts, supporting a wide range of payment methods: bank cards, SBP (Fast Payment System), mobile transfers, cryptocurrency.

## Quick Start

{% stepper %}
{% step %}

### Get an API Key

Request a `client-api-key` from your system administrator.
{% endstep %}

{% step %}

### Set Up Authorization

Every request is signed with a SHA-256 hash. See the [Authorization](/documentation/eng/concepts/auth.md) section for details.
{% endstep %}

{% step %}

### Create Your First Order

Send a POST request to `/merchant/createOrder`. See the [Creating an Order](/documentation/eng/orders/create.md) section for details.
{% endstep %}
{% endstepper %}

## Base URL

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

{% hint style="info" %}
All requests are made over HTTPS. HTTP requests are not supported.
{% endhint %}

## Documentation Sections

| Section                                                       | Description                        |
| ------------------------------------------------------------- | ---------------------------------- |
| [Protocol Overview](/documentation/eng/concepts/protocol.md)  | Request and response format        |
| [Authorization](/documentation/eng/concepts/auth.md)          | Request signing via SHA-256        |
| [Webhooks](/documentation/eng/concepts/webhooks.md)           | Receiving status notifications     |
| [Creating an Order](/documentation/eng/orders/create.md)      | Accepting payments (PAYIN)         |
| [Creating a Payout](/documentation/eng/orders/payout.md)      | Payouts to clients (PAYOUT)        |
| [Order Information](/documentation/eng/orders/info.md)        | Retrieving order status            |
| [Order List](/documentation/eng/orders/list.md)               | Filtering and pagination           |
| [Requisite Pool](/documentation/eng/orders/requisite-pool.md) | Pre-fetching payment requisites    |
| [Balance](/documentation/eng/finance/balance.md)              | Current merchant balance           |
| [Errors](/documentation/eng/reference/error-codes.md)         | Error codes and their descriptions |