Получить информацию об оплате crm.item.payment.get
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
crmКто может выполнять метод: пользователь с правом на чтение заказа, к которому относится оплата
Метод crm.item.payment.get возвращает статус, сумму и платежную систему оплаты по ее идентификатору.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
Идентификатор оплаты. Получить идентификаторы оплат объекта CRM можно методом crm.item.payment.list |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":1036}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.item.payment.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":1036,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.item.payment.get
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type PaymentGetResult = {
id: number
accountNumber: string
paid: 'Y' | 'N'
datePaid: ISODate | null
empPaidId: number
paySystemId: number
sum: number
currency: string
paySystemName: string
}
try {
const response = await $b24.actions.v2.call.make<PaymentGetResult>({
method: 'crm.item.payment.get',
params: {
id: 1036,
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info(result.id, result.accountNumber, result.paid, result.sum, result.currency)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function getPayment() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.item.payment.get',
params: {
id: 1036,
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info(result.id, result.accountNumber, result.paid, result.sum, result.currency)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getPayment)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.item.payment.get(
bitrix_id=1036,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$response = $b24Service
->core
->call(
'crm.item.payment.get',
[
'id' => 1036,
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting payment item: ' . $e->getMessage();
}
BX24.callMethod(
'crm.item.payment.get', {
id: 1036,
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'crm.item.payment.get',
[
'id' => 1036
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.item.payment.get", b24.Params{
"id": 1036,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.item.payment.get: %w", err)
}
var item struct {
ID b24.ID `json:"id"`
AccountNumber string `json:"accountNumber"`
Paid string `json:"paid"`
DatePaid string `json:"datePaid"`
EmpPaidID b24.ID `json:"empPaidId"`
PaySystemID b24.ID `json:"paySystemId"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.AccountNumber)
Обработка ответа
HTTP-статус: 200
{
"result": {
"id": 1036,
"accountNumber": "1049/1",
"paid": "Y",
"datePaid": "2026-10-28T18:59:33+03:00",
"empPaidId": 1,
"paySystemId": 11,
"sum": 3000,
"currency": "RUB",
"paySystemName": "Наличные"
},
"time": {
"start": 1793203175,
"finish": 1793203175.965445,
"duration": 0.9654450416564941,
"processing": 0,
"date_start": "2026-10-28T18:59:35+03:00",
"date_finish": "2026-10-28T18:59:35+03:00",
"operating_reset_at": 1793203740,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
Данные оплаты (подробное описание) |
|
|
time |
Информация о времени выполнения запроса |
sale_order_payment_crm_simple
|
Название |
Описание |
|
Идентификатор оплаты |
|
|
accountNumber |
Номер оплаты в формате |
|
paid |
Статус оплаты:
|
|
datePaid |
Дата и время, когда оплату последний раз отметили оплаченной. После crm.item.payment.unpay значение сохраняется |
|
empPaidId |
Идентификатор пользователя, который последним отметил оплату оплаченной. После crm.item.payment.unpay значение сохраняется |
|
paySystemId |
Идентификатор платежной системы |
|
sum |
Сумма оплаты. Пересчитывается автоматически, когда в оплату добавляют или из нее удаляют товары и доставку |
|
currency |
Валюта оплаты |
|
paySystemName |
Название платежной системы |
Обработка ошибок
HTTP-статус: 400
{
"error": "0",
"error_description": "Payment has not been found"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
|
Payment has not been found |
Оплата с переданным |
|
|
|
Access denied |
Нет права на чтение заказа, к которому относится оплата |
|
|
|
Could not find value for parameter |
Не передан обязательный параметр |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Оплаты в универсальных объектах CRM: обзор методов
- Товарные позиции в оплате: обзор методов
- Доставки в оплатах: обзор методов
- Изменить поля оплаты crm.item.payment.update
- Удалить оплату crm.item.payment.delete
- Получить список оплат crm.item.payment.list
- Изменить статус оплаты на «Оплачено» crm.item.payment.pay
- Изменить статус оплаты на «Не оплачено» crm.item.payment.unpay
- Добавить оплату crm.item.payment.add