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

# Основные сведения

**Термины**

1. Пользователь — лицо, которое использует действующую систему для выполнения конкретной функции.
2. Мерчант — сайт Пользователя, добавленный в разделе [Мерчанты](https://cryptomo.bar/cabinet/resource/merchant-resource/merchant-index-page).
3. Инвойс — созданный Пользователем запрос на отслеживание платежа в блокчейне в рамках конкретного Мерчанта.
4. Пользователь API — лицо, которое использует API действующей системы для выполнения конкретной функции.
5. Плательщик — лицо, которое должно оплатить созданный для него Инвойс.

**Запрос**

Базовый URL: `https://cryptomo.bar/api/v1`

Тело ответа:

* `success` - флаг, в зависимости от успешности запроса - содержит true/false
* `data` - содержит результат выполнения запроса. При неудачном запросе - возвращает информацию об ошибке

Успешный запрос:

```json
{
    "success": true,
    "data": {
        "property": "value",
        "second_property": "second_value"
    }
}
```

Запросы с ошибкой:

```json
{
    "success": false,
    "data": {
        "name": "Unauthorized",
        "message" : "Your request was made with invalid credentials",
        "code": 0,
        "status": 401
    }
}
```

Данный ответ включает перечень ошибок в свойстве `errors`:

```json
{
    "success": false,
    "data": {
        "message": "Invalid request data",
        "errors": {
            "amount": [
                "Amount cannot be blank."
            ],
            "client_reference_id": [
                "Client Reference Id cannot be blank."
            ]
        }
    }
}
```

*\* Параметр `message` может быть не задан*