
## Поставить оплате CRM отметку «оплачена»

`POST /v1/crm-payments/:id/pay`

Ставит оплате CRM отметку «оплачена» и записывает время отметки и сотрудника, который её поставил. Отметка не переводит деньги, но может запустить автоматизации, письмо или онлайн-чек.

## Параметры

| Параметр | Тип | Обяз. | Описание |
|----------|-----|:-----:|---------|
| `id` (path) | number | да | ID оплаты. Список оплат объекта: [`GET /v1/crm-payments`](/docs/entities/crm-payments/list) |

Тело запроса не передаётся либо передаётся `{}`.

## Примеры

### curl — личный ключ

```bash
curl -X POST "https://vibecode.bitrix24.tech/v1/crm-payments/565/pay" \
  -H "X-Api-Key: YOUR_API_KEY"
```

### curl — OAuth-приложение

```bash
curl -X POST "https://vibecode.bitrix24.tech/v1/crm-payments/565/pay" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
```

### JavaScript — личный ключ

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/crm-payments/565/pay', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { data } = await res.json()
console.log(`Оплата ${data.accountNumber} отмечена: ${data.datePaid}`)
```

### JavaScript — OAuth-приложение

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/crm-payments/565/pay', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { data } = await res.json()
```

## Поля ответа

Возвращается оплата после отметки.

| Поле | Тип | Описание |
|------|-----|---------|
| `success` | boolean | `true` при успехе |
| `data.id` | number | ID оплаты |
| `data.accountNumber` | string | Номер оплаты: номер связанного заказа и порядковый номер оплаты через `/` |
| `data.paid` | string | `Y` — оплата отмечена |
| `data.datePaid` | string | Время последней отметки «оплачена», ISO 8601 со смещением часового пояса |
| `data.empPaidId` | number | ID сотрудника, который поставил отметку, — пользователь ключа. Повторный вызов для оплаты с отметкой значение не меняет. Список: [`GET /v1/users`](/docs/entities/users/list) |
| `data.paySystemId` | number | ID платёжной системы. Список: [`GET /v1/pay-systems`](/docs/entities/pay-systems/list) |
| `data.sum` | number | Сумма оплаты |
| `data.currency` | string | Код валюты. Список: [`GET /v1/currencies`](/docs/entities/currencies/list) |
| `data.paySystemName` | string | Название платёжной системы |
| `meta.readbackUnavailable` | boolean | Приходит только со значением `true`, когда отметка поставлена, а перечитать оплату не удалось. Тогда `data` содержит только `id`. Повторять запрос не нужно — получите оплату по этому `id` |

## Пример ответа

```json
{
  "success": true,
  "data": {
    "id": 565,
    "accountNumber": "1029/2",
    "paid": "Y",
    "datePaid": "2026-10-05T09:29:34+03:00",
    "empPaidId": 1317,
    "paySystemId": 3,
    "sum": 0,
    "currency": "RUB",
    "paySystemName": "Банковский перевод (Контакты)"
  }
}
```

## Пример ответа при ошибке

404 — оплаты с таким ID нет:

```json
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Payment has not been found"
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 404 | `ENTITY_NOT_FOUND` | Оплаты с таким `id` нет |
| 400 | `READONLY_FIELD` | Тело запроса непустое |
| 400 | `FST_ERR_CTP_EMPTY_JSON_BODY` | Передан заголовок `Content-Type: application/json`, а тело пустое. Передайте тело `{}` либо уберите заголовок |
| 400 | `INVALID_ID` | `id` не положительное целое число |
| 422 | `BITRIX_NO_EFFECT` | Битрикс24 не подтвердил отметку |
| 422 | `BITRIX_ERROR` | Битрикс24 отклонил запрос, причина — в `error.message` |
| 403 | `BITRIX_ACCESS_DENIED` | У пользователя ключа нет доступа к объекту CRM или оплате в Битрикс24 |
| 403 | `WRITE_BLOCKED_READONLY_KEY` | Ключу запрещена запись |
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `crm` |
| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |
| 401 | `MISSING_API_KEY` | Не передан `X-Api-Key` |

Полный список общих ошибок API — [Ошибки](/docs/errors).

## Известные особенности

**Повторная отметка не меняет оплату.** Вызов для оплаты, у которой отметка уже стоит, отвечает `200` с прежними `datePaid` и `empPaidId`.

**Оплату с отметкой «оплачена» нельзя удалить.** Перед [удалением](/docs/entities/crm-payments/delete) снимите отметку через [`POST /v1/crm-payments/:id/unpay`](/docs/entities/crm-payments/unpay).

## Смотрите также

- [Снять отметку «оплачена»](/docs/entities/crm-payments/unpay)
- [Обновить оплату CRM](/docs/entities/crm-payments/update)
- [Получить оплату CRM](/docs/entities/crm-payments/get)
- [Оплаты CRM](/docs/entities/crm-payments)
