sale.paysystem.handler.update — метод REST API Битрикс24

Описание

Метод обновляет REST-обработчик платежной системы.

Параметры

ID sale_paysystem_handler.ID обязательный

Идентификатор REST-обработчика

FIELDS object обязательный

Набор значений для обновления (подробное описание приведено ниже)

Параметр FIELDS

NAME string необязательный

Название обработчика

CODE string необязательный

Уникальный код обработчика в системе

SETTINGS object необязательный

Настройки обработчика. Формат аналогичен формату в sale.paysystem.handler.add

SORT integer необязательный

Сортировка

Примеры запроса

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ID":3,"FIELDS":{"CODE":"newresthandlercode","NAME":"Новое название обработчика","SORT":200,"SETTINGS":{"CURRENCY":["RUB","BYN"],"FORM_DATA":{"ACTION_URI":"http://example.com/payment_form.php","METHOD":"POST","PARAMS":{"serviceid":"REST_SERVICE_ID_2","invoiceNumber":"PAYMENT_ID_2","Sum":"PAYMENT_SHOULD_PAY_2","customer":"PAYMENT_BUYER_ID_2"},"CODES":{"REST_SERVICE_ID_2":{"NAME":"Номер магазина","DESCRIPTION":"Номер магазина","SORT":"100"},"REST_SERVICE_KEY_2":{"NAME":"Секретный ключ","DESCRIPTION":"Секретный ключ","SORT":"300"},"PAYMENT_ID_2":{"NAME":"Номер оплаты","SORT":"400","GROUP":"PAYMENT","DEFAULT":{"PROVIDER_KEY":"PAYMENT","PROVIDER_VALUE":"ACCOUNT_NUMBER"}},"PAYMENT_SHOULD_PAY_2":{"NAME":"Сумма оплаты","SORT":"600","GROUP":"PAYMENT","DEFAULT":{"PROVIDER_KEY":"PAYMENT","PROVIDER_VALUE":"SUM"}},"PS_CHANGE_STATUS_PAY_2":{"NAME":"Автоматическая смена статуса оплаты","SORT":"700","INPUT":{"TYPE":"Y/N"}},"PAYMENT_BUYER_ID_2":{"NAME":"Код покупателя","SORT":"1000","GROUP":"PAYMENT","DEFAULT":{"PROVIDER_KEY":"ORDER","PROVIDER_VALUE":"USER_ID"}}}}}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.paysystem.handler.update

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ID":3,"FIELDS":{"CODE":"newresthandlercode","NAME":"Новое название обработчика","SORT":200,"SETTINGS":{"CURRENCY":["RUB","BYN"],"FORM_DATA":{"ACTION_URI":"http://example.com/payment_form.php","METHOD":"POST","PARAMS":{"serviceid":"REST_SERVICE_ID_2","invoiceNumber":"PAYMENT_ID_2","Sum":"PAYMENT_SHOULD_PAY_2","customer":"PAYMENT_BUYER_ID_2"},"CODES":{"REST_SERVICE_ID_2":{"NAME":"Номер магазина","DESCRIPTION":"Номер магазина","SORT":"100"},"REST_SERVICE_KEY_2":{"NAME":"Секретный ключ","DESCRIPTION":"Секретный ключ","SORT":"300"},"PAYMENT_ID_2":{"NAME":"Номер оплаты","SORT":"400","GROUP":"PAYMENT","DEFAULT":{"PROVIDER_KEY":"PAYMENT","PROVIDER_VALUE":"ACCOUNT_NUMBER"}},"PAYMENT_SHOULD_PAY_2":{"NAME":"Сумма оплаты","SORT":"600","GROUP":"PAYMENT","DEFAULT":{"PROVIDER_KEY":"PAYMENT","PROVIDER_VALUE":"SUM"}},"PS_CHANGE_STATUS_PAY_2":{"NAME":"Автоматическая смена статуса оплаты","SORT":"700","INPUT":{"TYPE":"Y/N"}},"PAYMENT_BUYER_ID_2":{"NAME":"Код покупателя","SORT":"1000","GROUP":"PAYMENT","DEFAULT":{"PROVIDER_KEY":"ORDER","PROVIDER_VALUE":"USER_ID"}}}}},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.paysystem.handler.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 } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

try {
  const response = await $b24.actions.v2.call.make<boolean>({
    method: 'sale.paysystem.handler.update',
    params: {
      ID: 3,
      FIELDS: {
        CODE: 'newresthandlercode',
        NAME: 'New handler name',
        SORT: 200,
        SETTINGS: {
          CURRENCY: ['RUB', 'BYN'],
          FORM_DATA: {
            ACTION_URI: 'http://example.com/payment_form.php',
            METHOD: 'POST',
            PARAMS: {
              serviceid: 'REST_SERVICE_ID_2',
              invoiceNumber: 'PAYMENT_ID_2',
              Sum: 'PAYMENT_SHOULD_PAY_2',
              customer: 'PAYMENT_BUYER_ID_2',
            },
          },
          CODES: {
            REST_SERVICE_ID_2: {
              NAME: 'Store number',
              DESCRIPTION: 'Store number',
              SORT: '100',
            },
            REST_SERVICE_KEY_2: {
              NAME: 'Secret key',
              DESCRIPTION: 'Secret key',
              SORT: '300',
            },
            PAYMENT_ID_2: {
              NAME: 'Payment number',
              SORT: '400',
              GROUP: 'PAYMENT',
              DEFAULT: {
                PROVIDER_KEY: 'PAYMENT',
                PROVIDER_VALUE: 'ACCOUNT_NUMBER',
              },
            },
            PAYMENT_SHOULD_PAY_2: {
              NAME: 'Payment amount',
              SORT: '600',
              GROUP: 'PAYMENT',
              DEFAULT: {
                PROVIDER_KEY: 'PAYMENT',
                PROVIDER_VALUE: 'SUM',
              },
            },
            PS_CHANGE_STATUS_PAY_2: {
              NAME: 'Automatic payment status change',
              SORT: '700',
              INPUT: {
                TYPE: 'Y/N',
              },
            },
            PAYMENT_BUYER_ID_2: {
              NAME: 'Customer code',
              SORT: '1000',
              GROUP: 'PAYMENT',
              DEFAULT: {
                PROVIDER_KEY: 'ORDER',
                PROVIDER_VALUE: 'USER_ID',
              },
            },
          },
        },
      },
    },
    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('Handler updated:', result)
  }
} 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 updatePaySystemHandler() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'sale.paysystem.handler.update',
        params: {
          ID: 3,
          FIELDS: {
            CODE: 'newresthandlercode',
            NAME: 'New handler name',
            SORT: 200,
            SETTINGS: {
              CURRENCY: ['RUB', 'BYN'],
              FORM_DATA: {
                ACTION_URI: 'http://example.com/payment_form.php',
                METHOD: 'POST',
                PARAMS: {
                  serviceid: 'REST_SERVICE_ID_2',
                  invoiceNumber: 'PAYMENT_ID_2',
                  Sum: 'PAYMENT_SHOULD_PAY_2',
                  customer: 'PAYMENT_BUYER_ID_2',
                },
              },
              CODES: {
                REST_SERVICE_ID_2: {
                  NAME: 'Store number',
                  DESCRIPTION: 'Store number',
                  SORT: '100',
                },
                REST_SERVICE_KEY_2: {
                  NAME: 'Secret key',
                  DESCRIPTION: 'Secret key',
                  SORT: '300',
                },
                PAYMENT_ID_2: {
                  NAME: 'Payment number',
                  SORT: '400',
                  GROUP: 'PAYMENT',
                  DEFAULT: {
                    PROVIDER_KEY: 'PAYMENT',
                    PROVIDER_VALUE: 'ACCOUNT_NUMBER',
                  },
                },
                PAYMENT_SHOULD_PAY_2: {
                  NAME: 'Payment amount',
                  SORT: '600',
                  GROUP: 'PAYMENT',
                  DEFAULT: {
                    PROVIDER_KEY: 'PAYMENT',
                    PROVIDER_VALUE: 'SUM',
                  },
                },
                PS_CHANGE_STATUS_PAY_2: {
                  NAME: 'Automatic payment status change',
                  SORT: '700',
                  INPUT: {
                    TYPE: 'Y/N',
                  },
                },
                PAYMENT_BUYER_ID_2: {
                  NAME: 'Customer code',
                  SORT: '1000',
                  GROUP: 'PAYMENT',
                  DEFAULT: {
                    PROVIDER_KEY: 'ORDER',
                    PROVIDER_VALUE: 'USER_ID',
                  },
                },
              },
            },
          },
        },
        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('Handler updated:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', updatePaySystemHandler)
</script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

fields = {
    "CODE": "newresthandlercode",
    "NAME": "New handler name",
    "SORT": 200,
    "SETTINGS": {
        "CURRENCY": [
            "RUB",
            "BYN",
        ],
        "FORM_DATA": {
            "ACTION_URI": "http://example.com/payment_form.php",
            "METHOD": "POST",
            "PARAMS": {
                "serviceid": "REST_SERVICE_ID_2",
                "invoiceNumber": "PAYMENT_ID_2",
                "Sum": "PAYMENT_SHOULD_PAY_2",
                "customer": "PAYMENT_BUYER_ID_2",
            },
        },
        "CODES": {
            "REST_SERVICE_ID_2": {
                "NAME": "Store number",
                "DESCRIPTION": "Store number",
                "SORT": "100",
            },
            "REST_SERVICE_KEY_2": {
                "NAME": "Secret key",
                "DESCRIPTION": "Secret key",
                "SORT": "300",
            },
            "PAYMENT_ID_2": {
                "NAME": "Payment number",
                "SORT": "400",
                "GROUP": "PAYMENT",
                "DEFAULT": {
                    "PROVIDER_KEY": "PAYMENT",
                    "PROVIDER_VALUE": "ACCOUNT_NUMBER",
                },
            },
            "PAYMENT_SHOULD_PAY_2": {
                "NAME": "Payment amount",
                "SORT": "600",
                "GROUP": "PAYMENT",
                "DEFAULT": {
                    "PROVIDER_KEY": "PAYMENT",
                    "PROVIDER_VALUE": "SUM",
                },
            },
            "PS_CHANGE_STATUS_PAY_2": {
                "NAME": "Automatic payment status change",
                "SORT": "700",
                "INPUT": {
                    "TYPE": "Y/N",
                },
            },
            "PAYMENT_BUYER_ID_2": {
                "NAME": "Customer code",
                "SORT": "1000",
                "GROUP": "PAYMENT",
                "DEFAULT": {
                    "PROVIDER_KEY": "ORDER",
                    "PROVIDER_VALUE": "USER_ID",
                },
            },
        },
    },
}

try:
    bitrix_response = client.sale.paysystem.handler.update(
        bitrix_id=3,
        fields=fields,
    ).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(
            'sale.paysystem.handler.update',
            [
                'ID'     => 3,
                'FIELDS' => [
                    'CODE'     => 'newresthandlercode',
                    'NAME'     => 'Новое название обработчика',
                    'SORT'     => 200,
                    'SETTINGS' => [
                        'CURRENCY'  => ['RUB', 'BYN'],
                        'FORM_DATA' => [
                            'ACTION_URI' => 'http://example.com/payment_form.php',
                            'METHOD'     => 'POST',
                            'PARAMS'     => [
                                'serviceid'    => 'REST_SERVICE_ID_2',
                                'invoiceNumber' => 'PAYMENT_ID_2',
                                'Sum'          => 'PAYMENT_SHOULD_PAY_2',
                                'customer'     => 'PAYMENT_BUYER_ID_2',
                            ],
                        ],
                        'CODES'    => [
                            'REST_SERVICE_ID_2' => [
                                'NAME'        => 'Номер магазина',
                                'DESCRIPTION' => 'Номер магазина',
                                'SORT'        => '100',
                            ],
                            'REST_SERVICE_KEY_2' => [
                                'NAME'        => 'Секретный ключ',
                                'DESCRIPTION' => 'Секретный ключ',
                                'SORT'        => '300',
                            ],
                            'PAYMENT_ID_2' => [
                                'NAME'   => 'Номер оплаты',
                                'SORT'   => '400',
                                'GROUP'  => 'PAYMENT',
                                'DEFAULT' => [
                                    'PROVIDER_KEY'  => 'PAYMENT',
                                    'PROVIDER_VALUE' => 'ACCOUNT_NUMBER',
                                ],
                            ],
                            'PAYMENT_SHOULD_PAY_2' => [
                                'NAME'   => 'Сумма оплаты',
                                'SORT'   => '600',
                                'GROUP'  => 'PAYMENT',
                                'DEFAULT' => [
                                    'PROVIDER_KEY'  => 'PAYMENT',
                                    'PROVIDER_VALUE' => 'SUM',
                                ],
                            ],
                            'PS_CHANGE_STATUS_PAY_2' => [
                                'NAME'  => 'Автоматическая смена статуса оплаты',
                                'SORT'  => '700',
                                'INPUT' => [
                                    'TYPE' => 'Y/N',
                                ],
                            ],
                            'PAYMENT_BUYER_ID_2' => [
                                'NAME'   => 'Код покупателя',
                                'SORT'   => '1000',
                                'GROUP'  => 'PAYMENT',
                                'DEFAULT' => [
                                    'PROVIDER_KEY'  => 'ORDER',
                                    'PROVIDER_VALUE' => 'USER_ID',
                                ],
                            ],
                        ],
                    ],
                ],
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result, true);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error updating payment system handler: ' . $e->getMessage();
}

BX24.callMethod(
    "sale.paysystem.handler.update",
    {
        'ID': 3,
        'FIELDS': {
            'CODE': 'newresthandlercode',
            'NAME': 'Новое название обработчика',
            'SORT': 200,
            'SETTINGS': {
                "CURRENCY": [
                    "RUB", "BYN"
                ],
                "FORM_DATA": {
                    "ACTION_URI": "http://example.com/payment_form.php",
                    "METHOD": "POST",
                    "PARAMS": {
                        "serviceid": "REST_SERVICE_ID_2",
                        "invoiceNumber": "PAYMENT_ID_2",
                        "Sum": "PAYMENT_SHOULD_PAY_2",
                        "customer": "PAYMENT_BUYER_ID_2"
                    }
                },
                "CODES": {
                    "REST_SERVICE_ID_2": {
                        "NAME": "Номер магазина",
                        "DESCRIPTION": "Номер магазина",
                        "SORT": "100"
                    },
                    "REST_SERVICE_KEY_2": {
                        "NAME": "Секретный ключ",
                        "DESCRIPTION": "Секретный ключ",
                        "SORT": "300"
                    },
                    "PAYMENT_ID_2": {
                        "NAME": "Номер оплаты",
                        "SORT": "400",
                        "GROUP": "PAYMENT",
                        "DEFAULT": {
                            "PROVIDER_KEY": "PAYMENT",
                            "PROVIDER_VALUE": "ACCOUNT_NUMBER"
                        }
                    },
                    "PAYMENT_SHOULD_PAY_2": {
                        "NAME": "Сумма оплаты",
                        "SORT": "600",
                        "GROUP": "PAYMENT",
                        "DEFAULT": {
                            "PROVIDER_KEY": "PAYMENT",
                            "PROVIDER_VALUE": "SUM"
                        }
                    },
                    "PS_CHANGE_STATUS_PAY_2": {
                        "NAME": "Автоматическая смена статуса оплаты",
                        "SORT": "700",
                        "INPUT": {
                            "TYPE": "Y/N"
                        }
                    },
                    "PAYMENT_BUYER_ID_2": {
                        "NAME": "Код покупателя",
                        "SORT": "1000",
                        "GROUP": "PAYMENT",
                        "DEFAULT": {
                            "PROVIDER_KEY": "ORDER",
                            "PROVIDER_VALUE": "USER_ID"
                        }
                    }
                }
            }
        }
    }
    ,
    function (result) {
        if (result.error()) {
            console.error(result.error());
        }
        else {
            console.info(result.data());
        }
    }
);

require_once('crest.php');

$result = CRest::call(
    'sale.paysystem.handler.update',
    [
        'ID' => 3,
        'FIELDS' => [
            'CODE' => 'newresthandlercode',
            'NAME' => 'Новое название обработчика',
            'SORT' => 200,
            'SETTINGS' => [
                'CURRENCY' => ['RUB', 'BYN'],
                'FORM_DATA' => [
                    'ACTION_URI' => 'http://example.com/payment_form.php',
                    'METHOD' => 'POST',
                    'PARAMS' => [
                        'serviceid' => 'REST_SERVICE_ID_2',
                        'invoiceNumber' => 'PAYMENT_ID_2',
                        'Sum' => 'PAYMENT_SHOULD_PAY_2',
                        'customer' => 'PAYMENT_BUYER_ID_2'
                    ]
                ],
                'CODES' => [
                    'REST_SERVICE_ID_2' => [
                        'NAME' => 'Номер магазина',
                        'DESCRIPTION' => 'Номер магазина',
                        'SORT' => '100'
                    ],
                    'REST_SERVICE_KEY_2' => [
                        'NAME' => 'Секретный ключ',
                        'DESCRIPTION' => 'Секретный ключ',
                        'SORT' => '300'
                    ],
                    'PAYMENT_ID_2' => [
                        'NAME' => 'Номер оплаты',
                        'SORT' => '400',
                        'GROUP' => 'PAYMENT',
                        'DEFAULT' => [
                            'PROVIDER_KEY' => 'PAYMENT',
                            'PROVIDER_VALUE' => 'ACCOUNT_NUMBER'
                        ]
                    ],
                    'PAYMENT_SHOULD_PAY_2' => [
                        'NAME' => 'Сумма оплаты',
                        'SORT' => '600',
                        'GROUP' => 'PAYMENT',
                        'DEFAULT' => [
                            'PROVIDER_KEY' => 'PAYMENT',
                            'PROVIDER_VALUE' => 'SUM'
                        ]
                    ],
                    'PS_CHANGE_STATUS_PAY_2' => [
                        'NAME' => 'Автоматическая смена статуса оплаты',
                        'SORT' => '700',
                        'INPUT' => [
                            'TYPE' => 'Y/N'
                        ]
                    ],
                    'PAYMENT_BUYER_ID_2' => [
                        'NAME' => 'Код покупателя',
                        'SORT' => '1000',
                        'GROUP' => 'PAYMENT',
                        'DEFAULT' => [
                            'PROVIDER_KEY' => 'ORDER',
                            'PROVIDER_VALUE' => 'USER_ID'
                        ]
                    ]
                ]
            ]
        ]
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

Ответ

HTTP-статус: 200

{
    "result": true,
    "time": {
        "start": 1712135335.026931,
        "finish": 1712135335.407762,
        "duration": 0.3808310031890869,
        "processing": 0.0336611270904541,
        "date_start": "2024-04-03T11:08:55+02:00",
        "date_finish": "2024-04-03T11:08:55+02:00",
        "operating_reset_at": 1705765533,
        "operating": 3.3076241016387939
    }
}

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

result boolean

Результат обновления REST-обработчика

time time

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

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

HTTP-статус: 400

{
    "error": "ERROR_HANDLER_NOT_FOUND",
    "error_description": "Handler not found"
}

Код	Описание	Значение
`ACCESS_DENIED`	Доступ запрещен. Приложение пытается изменить обработчик, добавленный другим приложением, либо недостаточно прав для обновления обработчика	403
`ERROR_CHECK_FAILURE`	Не указано значение поля `ID` либо `FIELDS`	400
`ERROR_HANDLER_NOT_FOUND`	Обработчик с указанным `ID` не найден	400
`ERROR_HANDLER_UPDATE`	Прочие ошибки. Подробную информацию об ошибке смотрите в `error_description`	400
`ERROR_UNEXPECTED_ANSWER`	Неожиданный ответ сервера. Одна из возможных причин — попытка указать обработчику неуникальный параметр `CODE`, уже существующий у другого обработчика	400