Получить информацию об оплате crm.item.payment.get

Scope: crm

Кто может выполнять метод: требуется право на изменение заказа оплаты

Метод получает краткую информацию об оплате.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

id*
sale_order_payment.id

Идентификатор оплаты

Примеры кода

Как использовать примеры в документации

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
        
try
        {
        	const response = await $b24.callMethod(
        		'crm.item.payment.get', {
        			id: 1036,
        		}
        	);
        	
        	const result = response.getData().result;
        	console.log(result);
        }
        catch( error )
        {
        	console.error(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>';

Ответ в случае успеха

HTTP-статус: 200

{
           "result":{
              "id":1036,
              "accountNumber":"3653\/1",
              "paid": "Y",
              "datePaid":"2024-05-20T12:32:02+03:00",
              "empPaidId":1,
              "paySystemId":6,
              "sum":0,
              "currency":"RUB",
              "paySystemName":"Наличные"
           },
           "time":{
              "start":1716203536.414886,
              "finish":1716203536.798211,
              "duration":0.38332509994506836,
              "processing":0.052394866943359375,
              "date_start":"2024-05-20T14:12:16+03:00",
              "date_finish":"2024-05-20T14:12:16+03:00"
           }
        }

Возвращаемые данные

Название
тип

Описание

result
sale_order_payment_crm_simple

Объект, содержащий краткую информацию об оплате

time
time

Информация о времени выполнения запроса

Ключ result. Объект типа sale_order_payment_crm_simple

Название
тип

Описание

id
sale_order_payment.id

Идентификатор оплаты

accountNumber
string

Системный номер оплаты

paid
string

Статус оплаты

Возможные значения:

  • Y – Оплачена
  • N – Не оплачена

datePaid
datetime

Дата оплаты

empPaidId
user.id

Пользователь, который внес оплату

paySystemId
sale_paysystem.id

Идентификатор платежной системы

sum
double

Сумма оплаты

currency
string

Валюта оплаты

paySystemName
string

Наименование платежной системы

Обработка ошибок

HTTP-статус: 400

{
           "error":0,
           "error_description":"Недостаточно прав"
        }

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код

Описание

0

Оплата не найдена или доступ запрещен

100

Не указан параметр id

0

Другие ошибки (например, фатальные ошибки)

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Предыдущая
Изменить оплату
Следующая
Получить список оплат