## Получить оплату

`GET /v1/payments/:id`

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

## Параметры

| Параметр | Тип | Обяз. | Описание |
|----------|-----|:-----:|---------|
| `id` (path) | number | да | Идентификатор оплаты |

## Примеры

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

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

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

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

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

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

const { success, data } = await res.json()
console.log('Оплата:', data.sum, data.currency, '—', data.paySystemName)
```

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

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

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

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

| Поле | Тип | Описание |
|------|-----|---------|
| `id` | number | Идентификатор оплаты |
| `accountNumber` | string | Порядковый номер оплаты на портале |
| `orderId` | number | Идентификатор заказа |
| `paySystemId` | number | Идентификатор платёжной системы |
| `paySystemName` | string | Название платёжной системы |
| `paySystemIsCash` | boolean | Принимает ли платёжная система наличные (только чтение) |
| `paySystemXmlId` | string | Внешний идентификатор платёжной системы (только чтение) |
| `sum` | number | Сумма оплаты |
| `currency` | string | Валюта оплаты |
| `paid` | boolean | Помечена ли оплата как поступившая |
| `datePaid` | datetime \| null | Дата отметки оплаты. `null`, если оплата не отмечена |
| `dateBill` | datetime | Дата выставления счёта |
| `datePayBefore` | datetime \| null | Срок оплаты — только дата. Время в ответе всегда полночь по времени портала, отдельного значения не имеет. `null`, если не задан |
| `dateMarked` | datetime \| null | Дата пометки оплаты как проблемной (только чтение). `null`, если пометки нет |
| `dateResponsibleId` | datetime \| null | Дата назначения ответственного (только чтение). `null`, если ответственный не назначен |
| `responsibleId` | number \| null | Ответственный сотрудник. `null`, если не назначен |
| `comments` | string \| null | Комментарий к оплате. `null`, если не задан |
| `xmlId` | string | Внешний идентификатор |
| `isReturn` | string | Признак возврата: `"N"` обычная оплата, `"Y"` возврат, `"P"` частичный возврат |
| `marked` | boolean | Помечена ли оплата как проблемная |
| `reasonMarked` | string \| null | Причина пометки. `null`, если пометки нет |
| `empPaidId` | number \| null | Сотрудник, отметивший оплату (только чтение) |
| `empResponsibleId` | number \| null | Сотрудник, ответственный за оплату (только чтение) |
| `empMarkedId` | number \| null | Сотрудник, поставивший пометку (только чтение) |
| `empReturnId` | number \| null | Сотрудник, оформивший возврат (только чтение) |
| `psStatus` | string \| null | Статус оплаты по данным платёжной системы. `null`, если оплата не проводилась через платёжную систему |
| `psStatusCode` | string \| null | Код статуса от платёжной системы |
| `psStatusDescription` | string \| null | Описание статуса от платёжной системы |
| `psStatusMessage` | string \| null | Сообщение от платёжной системы |
| `psSum` | number \| null | Сумма оплаты по данным платёжного шлюза |
| `psCurrency` | string \| null | Валюта оплаты по данным платёжного шлюза |
| `psResponseDate` | datetime \| null | Дата ответа платёжного шлюза |
| `psInvoiceId` | string \| null | Идентификатор счёта на стороне платёжного шлюза |
| `payVoucherNum` | string \| null | Номер платёжного поручения. `null`, если поручения нет |
| `payVoucherDate` | datetime \| null | Дата платёжного поручения. `null`, если поручения нет |
| `payReturnNum` | string \| null | Номер документа возврата. `null`, если возврата не было |
| `payReturnDate` | datetime \| null | Дата возврата. `null`, если возврата не было |
| `payReturnComment` | string \| null | Комментарий к возврату. `null`, если возврата не было |
| `priceCod` | number | Сумма наложенного платежа. `0`, если наложенный платёж не задан |
| `companyId` | number \| null | Компания-плательщик из CRM. `null`, если не задана |
| `externalPayment` | boolean | Оплата создана во внешней системе |
| `id1c` | string \| null | Идентификатор оплаты в 1С. `null`, если оплата не синхронизирована с 1С |
| `version1c` | string \| null | Версия оплаты в 1С. `null`, если оплата не синхронизирована с 1С |
| `updated1c` | boolean | Обновлена ли оплата через 1С |

Полный список полей со ссылками на источники идентификаторов — [Поля оплаты](./fields.md).

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

```json
{
  "success": true,
  "data": {
    "id": 17,
    "accountNumber": "19/1",
    "orderId": 19,
    "paySystemId": 11,
    "paySystemName": "Наличные",
    "paySystemIsCash": true,
    "paySystemXmlId": "bx_61372545d32ae",
    "sum": 0,
    "currency": "RUB",
    "paid": false,
    "datePaid": "2020-05-14T20:00:00.000Z",
    "dateBill": "2020-05-14T20:00:00.000Z",
    "datePayBefore": null,
    "dateMarked": null,
    "dateResponsibleId": "2020-05-15T12:08:16.000Z",
    "responsibleId": 1,
    "empPaidId": null,
    "empResponsibleId": 1,
    "empMarkedId": null,
    "empReturnId": null,
    "comments": null,
    "reasonMarked": null,
    "xmlId": "bx_5ebe943aacfa0",
    "id1c": null,
    "version1c": null,
    "updated1c": false,
    "externalPayment": false,
    "isReturn": "N",
    "marked": false,
    "priceCod": 0,
    "companyId": null,
    "payReturnNum": null,
    "payReturnDate": null,
    "payReturnComment": null,
    "payVoucherNum": null,
    "payVoucherDate": null,
    "psStatus": null,
    "psStatusCode": null,
    "psStatusDescription": null,
    "psStatusMessage": null,
    "psSum": null,
    "psCurrency": null,
    "psInvoiceId": null,
    "psResponseDate": null
  }
}
```

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

422 — оплата не найдена:

```json
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "payment is not exists"
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 422 | `BITRIX_ERROR` | Оплата с таким ID не найдена |
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `sale` |
| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |

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

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

- [Поля оплаты](./fields.md)
- [Обновить оплату](./update.md)
- [Удалить оплату](./delete.md)
- [Список оплат](./list.md)
- [Заказ](../orders/get.md)
- [Лимиты и оптимизация](/docs/optimization)