Update Payment sale.payment.update

Choose a tool for developing with an AI agent:

use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: sale

Who can execute the method: administrator

The method sale.payment.update is used to update fields of the payment collection item.

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
sale_order_payment.id

Payment identifier

fields*
object

Field values (detailed description provided below) for creating a payment in the form of a structure:

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

Parameter fields

Required parameters are marked with *

Name `type`	Description
paySystemId* `sale_paysystem.id`	Payment system identifier
paid `string`	Payment status: `Y` — yes `N` — no Defaults to `N`
datePaid `datetime`	Payment date
empPaidId `user.id`	Identifier of the user who made the payment
psStatus `string`	Payment system status flag — whether the payment was successful. Options: `Y` — yes `N` — no Defaults to `null`
psStatusCode `string`	Payment system status code
psStatusDescription `string`	Description of the payment system's operation result
psStatusMessage `string`	Message from the payment system
psSum `double`	Payment system amount
psCurrency `string`	Payment system currency
psResponseDate `datetime`	Payment system response date
payVoucherNum `string`	Payment document number
payVoucherDate `datetime`	Payment document date
datePayBefore `datetime`	Deprecated. Date by which the invoice must be paid
dateBill `datetime`	Invoice date
xmlId `string`	External identifier
sum `double`	Payment amount
companyId `integer`	Identifier of the company that will receive the payment Currently not used
payReturnNum `string`	Return document number
priceCod `double`	Relevant only for on-premise version Cost of payment upon delivery. Used for cash on delivery
payReturnDate `date`	Return document date
empReturnId `user.id`	Identifier of the user who processed the return
payReturnComment `string`	Comment on the return
responsibleId `user.id`	Identifier of the user responsible for the payment
empResponsibleId `user.id`	Identifier of the user who assigned the responsible person
isReturn `string`	Was the return processed: `Y` — yes `N` — no Defaults to N
comments `string`	Comments on the payment
updated1c `string`	Payment updated via QuickBooks and other similar platforms: `Y` — yes `N` — no Defaults to N
id1c `string`	Identifier in QuickBooks and other similar platforms
version1c `string`	Payment document version from QuickBooks and other similar platforms
externalPayment `string`	Relevant only for on-premise version Whether it is an external payment. Used for import from QuickBooks and other similar platforms via XML `Y` — yes `F` — yes, loaded with the order `N` — no Defaults to `N`
psInvoiceId `string`	Payment identifier in the payment system
marked `string`	Marking flag. Indicates whether the payment is marked as problematic: `Y` — yes `N` — no Defaults to `N`
reasonMarked `string`	Reason for marking
empMarkedId `user.id`	Identifier of the user who marked the payment

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

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":"USD","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":"USD","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: 'USD',
                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: 'USD',
                    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>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        fields = {
            "paySystemId": 1,
            "paid": "Y",
            "datePaid": "2024-04-10T10:00:00",
            "empPaidId": 1,
            "psStatus": "Y",
            "psSum": 100,
            "psCurrency": "USD",
            "psResponseDate": "2024-04-10T10:00:00",
            "sum": 100,
            "companyId": 1,
            "responsibleId": 1,
            "empResponsibleId": 1,
            "isReturn": "N",
            "externalPayment": "N",
            "psInvoiceId": 1,
            "marked": "N",
        }
        
        try:
            bitrix_response = client.sale.payment.update(
                bitrix_id=144,
                fields=fields,
            ).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")

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'           => 'USD',
                            '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: 'USD',
                    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' => 'USD',
                    '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>';

// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "sale.payment.update", b24.Params{
        	"id": 144,
        	"fields": b24.Params{
        		"paySystemId":      1,
        		"paid":             "Y",
        		"datePaid":         "2024-04-10T10:00:00",
        		"empPaidId":        1,
        		"psStatus":         "Y",
        		"psSum":            100,
        		"psCurrency":       "EUR",
        		"psResponseDate":   "2024-04-10T10:00:00",
        		"sum":              100,
        		"companyId":        1,
        		"responsibleId":    1,
        		"empResponsibleId": 1,
        		"isReturn":         "N",
        		"externalPayment":  "N",
        		"psInvoiceId":      1,
        		"marked":           "N",
        	},
        })
        if err != nil {
        	return fmt.Errorf("sale.payment.update: %w", err)
        }
        
        // The method wraps the response in an object with the "payment" key.
        raw, ok := b24.Unwrap(res.Result, "payment")
        if !ok {
        	return fmt.Errorf("no payment key in the response")
        }
        
        var item struct {
        	AccountNumber string `json:"accountNumber"`
        	Comments      string `json:"comments"`
        	CompanyID     b24.ID `json:"companyId"`
        	Currency      string `json:"currency"`
        	DateBill      string `json:"dateBill"`
        	DateMarked    string `json:"dateMarked"`
        }
        if err := json.Unmarshal(raw, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.AccountNumber, item.Comments)

Response Handling

HTTP status: 200

{
            "result": {
                "payment": {
                    "accountNumber": "356\/1",
                    "comments": "",
                    "companyId": 1,
                    "currency": "USD",
                    "dateBill": "2024-04-10T09:00:00+02:00",
                    "dateMarked": "2024-04-16T16:32:49+02:00",
                    "datePaid": "2024-04-10T09:00:00+02:00",
                    "datePayBefore": "2024-04-10T09:00:00+02:00",
                    "dateResponsibleId": "2024-04-16T16:32:49+02: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+02:00",
                    "payReturnNum": "",
                    "paySystemId": 1,
                    "paySystemIsCash": "N",
                    "paySystemName": "Bank Transfer (Company)",
                    "paySystemXmlId": "",
                    "payVoucherDate": "2024-04-10T09:00:00+02:00",
                    "payVoucherNum": "",
                    "priceCod": "100",
                    "psCurrency": "USD",
                    "psInvoiceId": 1,
                    "psResponseDate": "2024-04-10T09:00:00+02: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+02:00",
                "date_finish": "2024-04-18T18:39:38+02:00"
            }
        }

Returned Data

Name `type`	Description
result `object`	Root element of the response
payment `sale_order_payment`	Object with information about the updated payment
time `time`	Information about the request processing time

Error Handling

HTTP status: 400

{
            "error":200640400001,
            "error_description":"payment does not exist"
        }

Name `type`	Description
error `string`	String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only `error_description` shows the reason
error_description `string`	Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Code	Description
`200640400001`	The payment being updated was not found
`200040300020`	Insufficient permissions to update the payment
`100`	Parameter `id` not specified
`100`	Parameter `fields` not specified or empty
`0`	Other errors (e.g., fatal errors)

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit
`401`	`NO_AUTH_FOUND` Wrong authorization data	The request contains no authorization data: neither an access token nor a webhook code was passed
`401`	`INVALID_REQUEST` Https required	Methods are called over the HTTPS protocol only
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support
`401`	`ACCESS_DENIED` REST is available only on commercial plans	REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	No active webhook with the specified user identifier and secret code was found
`404`	`ERROR_METHOD_NOT_FOUND` Method not found!	No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with `provided by the access token`
`401`	`expired_token` The access token provided has expired	The access token has expired
`401`	`user_access_error` The user does not have access to the application	The application is installed, but the Bitrix24 administrator has granted access to it only to specific users
`403`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Was the article helpful?

Add Payment

Get Payment by Id

Update Payment sale.payment.update

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning