Изменить оплату sale.payment.update

Выберите инструмент для разработки с AI-агентом:

используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: sale

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

Метод sale.payment.update служит для обновления полей элемента коллекции оплат.

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

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

Название
тип

Описание

id*
sale_order_payment.id

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

fields*
object

Значения полей (подробное описание приведено ниже) для создания оплаты в виде структуры:

fields: {
            paySystemId: "значение",
            paid: "значение",
            datePaid: "значение",
            empPaidId: "значение",
            psStatus: "значение",
            psStatusCode: "значение",
            psStatusDescription: "значение",
            psStatusMessage: "значение",
            psSum: "значение",
            psCurrency: "значение",
            psResponseDate: "значение",
            payVoucherNum: "значение",
            payVoucherDate: "значение",
            datePayBefore: "значение",
            dateBill: "значение",
            xmlId: "значение",
            sum: "значение",
            companyId: "значение",
            payReturnNum: "значение",
            priceCod: "значение",
            payReturnDate: "значение",
            empReturnId: "значение",
            payReturnComment: "значение",
            responsibleId: "значение",
            empResponsibleId: "значение",
            isReturn: "значение",
            comments: "значение",
            updated1c: "значение",
            id1c: "значение",
            version1c: "значение",
            externalPayment: "значение",
            psInvoiceId: "значение",
            marked: "значение",
            reasonMarked: "значение",
            empMarkedId: "значение",
        }

Параметр fields

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

Название `тип`	Описание
paySystemId* `sale_paysystem.id`	Идентификатор платежной системы
paid `string`	Оплата оплачена: `Y` — да `N` — нет По умолчанию устанавливается `N`
datePaid `datetime`	Дата оплаты
empPaidId `user.id`	Идентификатор пользователя, который оплатил оплату
psStatus `string`	Флаг статуса платежной системы — успешно ли оплачена оплата. Варианты: `Y` — да `N` — нет По умолчанию устанавливается `null`
psStatusCode `string`	Код статуса платёжной системы
psStatusDescription `string`	Описание результата работы платежной системы
psStatusMessage `string`	Сообщение от платежной системы
psSum `double`	Сумма платежной системы
psCurrency `string`	Валюта платежной системы
psResponseDate `datetime`	Дата ответа платежной системы
payVoucherNum `string`	Номер платежного документа
payVoucherDate `datetime`	Дата платежного документа
datePayBefore `datetime`	Устаревший. Дата, по которой необходимо оплатить счет
dateBill `datetime`	Дата выставления счета
xmlId `string`	Внешний идентификатор
sum `double`	Сумма оплаты
companyId `integer`	Идентификатор компании, которая будет принимать оплату В настоящий момент не используется
payReturnNum `string`	Номер документа возврата
priceCod `double`	Актуально только для коробочной версии Стоимость оплаты при доставке. Используется для наложенного платежа
payReturnDate `date`	Дата документа возврата
empReturnId `user.id`	Идентификатор пользователя, который выполнял возврат
payReturnComment `string`	Комментарий к возврату
responsibleId `user.id`	Идентификатор пользователя, ответственного за оплату
empResponsibleId `user.id`	Идентификатор пользователя, назначившего ответственного
isReturn `string`	Выполнялся ли возврат: `Y` — да `N` — нет По умолчанию устанавливается N
comments `string`	Комментарии к оплате
updated1c `string`	Оплата обновлена через 1С: `Y` — да `N` — нет По умолчанию устанавливается N
id1c `string`	Идентификатор в 1С
version1c `string`	Версия документа оплаты от 1С
externalPayment `string`	Актуально только для коробочной версии Внешняя оплата или нет. Используется для импорта из 1С через XML `Y` — да `F` — да, загружена вместе с заказом `N` — нет По умолчанию устанавливается `N`
psInvoiceId `string`	Идентификатор оплаты в платежной системе
marked `string`	Флаг маркировки. Признак того, является ли оплата отмеченной как проблемная: `Y` — да `N` — нет По умолчанию устанавливается `N`
reasonMarked `string`	Причина маркировки
empMarkedId `user.id`	Идентификатор пользователя, промаркировавшего оплату

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":144,"fields":{"paySystemId":1,"paid":"Y","datePaid":"2024-04-10T10:00:00","empPaidId":1,"psStatus":"Y","psSum":100,"psCurrency":"RUB","psResponseDate":"2024-04-10T10:00:00","sum":100,"companyId":1,"responsibleId":1,"empResponsibleId":1,"isReturn":"N","externalPayment":"N","psInvoiceId":1,"marked":"N"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.payment.update

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":144,"fields":{"paySystemId":1,"paid":"Y","datePaid":"2024-04-10T10:00:00","empPaidId":1,"psStatus":"Y","psSum":100,"psCurrency":"RUB","psResponseDate":"2024-04-10T10:00:00","sum":100,"companyId":1,"responsibleId":1,"empResponsibleId":1,"isReturn":"N","externalPayment":"N","psInvoiceId":1,"marked":"N"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sale.payment.update

// 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 PaymentUpdateResult = {
          payment: {
            accountNumber: string,
            comments: string,
            companyId: number,
            currency: string,
            dateBill: ISODate | null,
            dateMarked: ISODate | null,
            datePaid: ISODate | null,
            datePayBefore: ISODate | null,
            dateResponsibleId: ISODate | null,
            empMarkedId: number,
            empPaidId: number,
            empResponsibleId: number,
            empReturnId: number,
            externalPayment: string,
            id: number,
            id1c: string,
            isReturn: string,
            marked: string,
            orderId: number,
            paid: string,
            payReturnComment: string,
            payReturnDate: ISODate | null,
            payReturnNum: string,
            paySystemId: number,
            paySystemIsCash: string,
            paySystemName: string,
            paySystemXmlId: string,
            payVoucherDate: ISODate | null,
            payVoucherNum: string,
            priceCod: string,
            psCurrency: string,
            psInvoiceId: number,
            psResponseDate: ISODate | null,
            psStatus: string,
            psStatusCode: string,
            psStatusDescription: string,
            psStatusMessage: string,
            psSum: number,
            reasonMarked: string,
            responsibleId: number,
            sum: number,
            updated1c: string,
            version1c: string,
            xmlId: string,
          },
        }
        
        try {
          const response = await $b24.actions.v2.call.make<PaymentUpdateResult>({
            method: 'sale.payment.update',
            params: {
              id: 144,
              fields: {
                paySystemId: 1,
                paid: 'Y',
                datePaid: '2024-04-10T10:00:00',
                empPaidId: 1,
                psStatus: 'Y',
                psStatusCode: '',
                psStatusDescription: '',
                psStatusMessage: '',
                psSum: 100,
                psCurrency: 'RUB',
                psResponseDate: '2024-04-10T10:00:00',
                payVoucherNum: '',
                payVoucherDate: '2024-04-10T10:00:00',
                datePayBefore: '2024-04-10T10:00:00',
                dateBill: '2024-04-10T10:00:00',
                xmlId: '',
                sum: 100,
                companyId: 1,
                payReturnNum: '',
                priceCod: 100,
                payReturnDate: '2024-04-10T10:00:00',
                empReturnId: 1,
                payReturnComment: '',
                responsibleId: 1,
                empResponsibleId: 1,
                isReturn: 'N',
                comments: '',
                updated1c: 'N',
                id1c: '',
                version1c: '',
                externalPayment: 'N',
                psInvoiceId: 1,
                marked: 'N',
                reasonMarked: '',
                empMarkedId: 1,
              },
            },
            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('Updated payment:', result.payment.id, 'paid:', result.payment.paid)
          }
        } 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 updatePayment() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'sale.payment.update',
                params: {
                  id: 144,
                  fields: {
                    paySystemId: 1,
                    paid: 'Y',
                    datePaid: '2024-04-10T10:00:00',
                    empPaidId: 1,
                    psStatus: 'Y',
                    psStatusCode: '',
                    psStatusDescription: '',
                    psStatusMessage: '',
                    psSum: 100,
                    psCurrency: 'RUB',
                    psResponseDate: '2024-04-10T10:00:00',
                    payVoucherNum: '',
                    payVoucherDate: '2024-04-10T10:00:00',
                    datePayBefore: '2024-04-10T10:00:00',
                    dateBill: '2024-04-10T10:00:00',
                    xmlId: '',
                    sum: 100,
                    companyId: 1,
                    payReturnNum: '',
                    priceCod: 100,
                    payReturnDate: '2024-04-10T10:00:00',
                    empReturnId: 1,
                    payReturnComment: '',
                    responsibleId: 1,
                    empResponsibleId: 1,
                    isReturn: 'N',
                    comments: '',
                    updated1c: 'N',
                    id1c: '',
                    version1c: '',
                    externalPayment: 'N',
                    psInvoiceId: 1,
                    marked: 'N',
                    reasonMarked: '',
                    empMarkedId: 1,
                  },
                },
                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('Updated payment:', result.payment.id, 'paid:', result.payment.paid)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', updatePayment)
        </script>

try {
            $response = $b24Service
                ->core
                ->call(
                    'sale.payment.update',
                    [
                        'id' => 144,
                        'fields' => [
                            'paySystemId'          => 1,
                            'paid'                 => 'Y',
                            'datePaid'             => '2024-04-10T10:00:00',
                            'empPaidId'            => 1,
                            'psStatus'             => 'Y',
                            'psStatusCode'         => '',
                            'psStatusDescription'  => '',
                            'psStatusMessage'      => '',
                            'psSum'                => 100,
                            'psCurrency'           => 'RUB',
                            'psResponseDate'       => '2024-04-10T10:00:00',
                            'payVoucherNum'        => '',
                            'payVoucherDate'       => '2024-04-10T10:00:00',
                            'datePayBefore'        => '2024-04-10T10:00:00',
                            'dateBill'             => '2024-04-10T10:00:00',
                            'xmlId'                => '',
                            'sum'                  => 100,
                            'companyId'            => 1,
                            'payReturnNum'         => '',
                            'priceCod'             => 100,
                            'payReturnDate'        => '2024-04-10T10:00:00',
                            'empReturnId'          => 1,
                            'payReturnComment'     => '',
                            'responsibleId'        => 1,
                            'empResponsibleId'     => 1,
                            'isReturn'             => 'N',
                            'comments'             => '',
                            'updated1c'            => 'N',
                            'id1c'                 => '',
                            'version1c'            => '',
                            'externalPayment'      => 'N',
                            'psInvoiceId'          => 1,
                            'marked'               => 'N',
                            'reasonMarked'         => '',
                            'empMarkedId'          => 1,
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error updating payment: ' . $e->getMessage();
        }

BX24.callMethod(
            'sale.payment.update',
            {
                id: 144,
                fields: {
                    paySystemId: 1,
                    paid: 'Y',
                    datePaid: '2024-04-10T10:00:00',
                    empPaidId: 1,
                    psStatus: 'Y',
                    psStatusCode: '',
                    psStatusDescription: '',
                    psStatusMessage: '',
                    psSum: 100,
                    psCurrency: 'RUB',
                    psResponseDate: '2024-04-10T10:00:00',
                    payVoucherNum: '',
                    payVoucherDate: '2024-04-10T10:00:00',
                    datePayBefore: '2024-04-10T10:00:00',
                    dateBill: '2024-04-10T10:00:00',
                    xmlId: '',
                    sum: 100,
                    companyId: 1,
                    payReturnNum: '',
                    priceCod: 100,
                    payReturnDate: '2024-04-10T10:00:00',
                    empReturnId: 1,
                    payReturnComment: '',
                    responsibleId: 1,
                    empResponsibleId: 1,
                    isReturn: 'N',
                    comments: '',
                    updated1c: 'N',
                    id1c: '',
                    version1c: '',
                    externalPayment: 'N',
                    psInvoiceId: 1,
                    marked: 'N',
                    reasonMarked: '',
                    empMarkedId: 1,
                }
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'sale.payment.update',
            [
                'id' => 144,
                'fields' => [
                    'paySystemId' => 1,
                    'paid' => 'Y',
                    'datePaid' => '2024-04-10T10:00:00',
                    'empPaidId' => 1,
                    'psStatus' => 'Y',
                    'psStatusCode' => '',
                    'psStatusDescription' => '',
                    'psStatusMessage' => '',
                    'psSum' => 100,
                    'psCurrency' => 'RUB',
                    'psResponseDate' => '2024-04-10T10:00:00',
                    'payVoucherNum' => '',
                    'payVoucherDate' => '2024-04-10T10:00:00',
                    'datePayBefore' => '2024-04-10T10:00:00',
                    'dateBill' => '2024-04-10T10:00:00',
                    'xmlId' => '',
                    'sum' => 100,
                    'companyId' => 1,
                    'payReturnNum' => '',
                    'priceCod' => 100,
                    'payReturnDate' => '2024-04-10T10:00:00',
                    'empReturnId' => 1,
                    'payReturnComment' => '',
                    'responsibleId' => 1,
                    'empResponsibleId' => 1,
                    'isReturn' => 'N',
                    'comments' => '',
                    'updated1c' => 'N',
                    'id1c' => '',
                    'version1c' => '',
                    'externalPayment' => 'N',
                    'psInvoiceId' => 1,
                    'marked' => 'N',
                    'reasonMarked' => '',
                    'empMarkedId' => 1,
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Обработка ответа

HTTP-статус: 200

{
            "result": {
                "payment": {
                    "accountNumber": "356\/1",
                    "comments": "",
                    "companyId": 1,
                    "currency": "RUB",
                    "dateBill": "2024-04-10T09:00:00+03:00",
                    "dateMarked": "2024-04-16T16:32:49+03:00",
                    "datePaid": "2024-04-10T09:00:00+03:00",
                    "datePayBefore": "2024-04-10T09:00:00+03:00",
                    "dateResponsibleId": "2024-04-16T16:32:49+03:00",
                    "empMarkedId": 1,
                    "empPaidId": 1,
                    "empResponsibleId": 1,
                    "empReturnId": 1,
                    "externalPayment": "N",
                    "id": 144,
                    "id1c": "",
                    "isReturn": "N",
                    "marked": "N",
                    "orderId": 200,
                    "paid": "Y",
                    "payReturnComment": "",
                    "payReturnDate": "2024-04-10T09:00:00+03:00",
                    "payReturnNum": "",
                    "paySystemId": 1,
                    "paySystemIsCash": "N",
                    "paySystemName": "Банковский перевод (Компании)",
                    "paySystemXmlId": "",
                    "payVoucherDate": "2024-04-10T09:00:00+03:00",
                    "payVoucherNum": "",
                    "priceCod": "100",
                    "psCurrency": "RUB",
                    "psInvoiceId": 1,
                    "psResponseDate": "2024-04-10T09:00:00+03:00",
                    "psStatus": "Y",
                    "psStatusCode": "",
                    "psStatusDescription": "",
                    "psStatusMessage": "",
                    "psSum": 100,
                    "reasonMarked": "",
                    "responsibleId": 1,
                    "sum": 100,
                    "updated1c": "N",
                    "version1c": "",
                    "xmlId": ""
                }
            },
            "time": {
                "start": 1713454774.293692,
                "finish": 1713454778.895877,
                "duration": 4.602184772491455,
                "processing": 4.142766952514648,
                "date_start": "2024-04-18T18:39:34+03:00",
                "date_finish": "2024-04-18T18:39:38+03:00"
            }
        }

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

Название `тип`	Описание
result `object`	Корневой элемент ответа
payment `sale_order_payment`	Объект с информацией об обновленной оплате
time `time`	Информация о времени выполнения запроса

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

HTTP-статус: 400

{
            "error":200640400001,
            "error_description":"payment is not exists"
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код	Описание
`200640400001`	Обновляемая оплата не найдена
`200040300020`	Недостаточно прав для обновления оплаты
`100`	Не указан параметр `id`
`100`	Не указан или пустой параметр `fields`
`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	Превышен лимит на интенсивность запросов
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут
`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	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Добавить оплату

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

Изменить оплату sale.payment.update

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

Параметр fieldsПараметр fields

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

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

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

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

Статусы и коды системных ошибокСтатусы и коды системных ошибок

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