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

GET /v1/payments/:id

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

#Параметры

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

#Примеры

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

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

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

Terminal 
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 Название платёжной системы
sum number Сумма оплаты
currency string Валюта оплаты
paid boolean Помечена ли оплата как поступившая
datePaid datetime | null Дата отметки оплаты. null, если оплата не отмечена
dateBill datetime Дата выставления счёта
datePayBefore datetime | null Срок оплаты. null, если не задан
responsibleId number | null Ответственный сотрудник. null, если не назначен
comments string | null Комментарий к оплате. null, если не задан
xmlId string Внешний идентификатор
isReturn string Признак возврата: "N", "Y", "P"
marked boolean Помечена ли оплата как проблемная
priceCod number Стоимость наложенного платежа
companyId number | null Идентификатор компании-получателя. null, если не задана
psStatus string | null Статус от платёжной системы. null, если оплата не проводилась через платёжную систему
payVoucherNum string | null Номер платёжного документа. null, если документа нет
payVoucherDate datetime | null Дата платёжного документа. null, если документа нет

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

JSON 
{
  "success": true,
  "data": {
    "id": 17,
    "accountNumber": "19/1",
    "orderId": 19,
    "paySystemId": 11,
    "paySystemName": "Наличные",
    "paySystemIsCash": "Y",
    "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-15T15:08:16+03:00",
    "responsibleId": 1,
    "empPaidId": null,
    "empResponsibleId": 1,
    "empMarkedId": null,
    "empReturnId": null,
    "comments": "",
    "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 — Ошибки.

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