Update REST Handler for Payment System sale.paysystem.handler.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:
pay_systemWho can execute the method: CRM administrator (permission "Allow to modify settings")
This method updates the REST handler for the payment system.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
Identifier of the REST handler |
|
|
FIELDS* |
Set of values for updating (detailed description provided below) |
FIELDS Parameter
|
Name |
Description |
|
NAME |
Name of the handler |
|
CODE |
Unique code of the handler in the system |
|
SETTINGS |
Handler settings. The format is similar to that in sale.paysystem.handler.add |
|
SORT |
Sorting |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ID":3,"FIELDS":{"CODE":"newresthandlercode","NAME":"New Handler Name","SORT":200,"SETTINGS":{"CURRENCY":["EUR","CHF"],"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":"Buyer Code","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":"New Handler Name","SORT":200,"SETTINGS":{"CURRENCY":["EUR","CHF"],"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":"Buyer Code","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: ['USD', '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: ['USD', '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": [
"EUR",
"CHF",
],
"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 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.paysystem.handler.update',
[
'ID' => 3,
'FIELDS' => [
'CODE' => 'newresthandlercode',
'NAME' => 'New Handler Name',
'SORT' => 200,
'SETTINGS' => [
'CURRENCY' => ['EUR', 'CHF'],
'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' => 'Buyer Code',
'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': 'New Handler Name',
'SORT': 200,
'SETTINGS': {
"CURRENCY": [
"EUR", "CHF"
],
"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": "Buyer Code",
"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' => 'New Handler Name',
'SORT' => 200,
'SETTINGS' => [
'CURRENCY' => ['EUR', 'CHF'],
'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' => 'Buyer Code',
'SORT' => '1000',
'GROUP' => 'PAYMENT',
'DEFAULT' => [
'PROVIDER_KEY' => 'ORDER',
'PROVIDER_VALUE' => 'USER_ID'
]
]
]
]
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP Status: 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
}
}
Returned Data
|
Name |
Description |
|
result |
Result of updating the REST handler |
|
time |
Information about the execution time of the request |
Error Handling
HTTP Status: 400, 403
{
"error": "ERROR_HANDLER_NOT_FOUND",
"error_description": "Handler not found"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
Status |
|
|
Access denied. The application is trying to modify a handler added by another application, or insufficient rights to update the handler |
403 |
|
|
The value of the |
400 |
|
|
Handler with the specified |
400 |
|
|
Other errors. For detailed information about the error, see |
400 |
|
|
Unexpected server response. One possible reason is attempting to specify a non-unique |
400 |
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 |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
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 |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
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 — |
|
|
|
No active webhook with the specified user identifier and secret code was 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 |
|
|
|
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 |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
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
- Add REST Handler for Payment System sale.paysystem.handler.add
- Get a List of REST Handlers for the Payment System sale.paysystem.handler.list
- Delete the REST handler for the payment system sale.paysystem.handler.delete
- Add Payment System sale.paysystem.add
- Update Payment System sale.paysystem.update
- Get a List of Payment Systems sale.paysystem.list
- Get Payment System Settings sale.paysystem.settings.get
- Update Payment System Settings sale.paysystem.settings.update
- Delete Payment System sale.paysystem.delete
- Pay for an Order via a Specific Payment System sale.paysystem.pay.payment
- Get Payment System Settings for a Specific Payment sale.paysystem.settings.payment.get