Update REST handler for payment system sale.paysystem.handler.update
Scope:
pay_systemWho can execute the method: CRM administrator (permission "Allow changing 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 the format 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":["USD","EUR"],"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":["USD","EUR"],"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
try
{
const response = await $b24.callMethod(
"sale.paysystem.handler.update",
{
'ID': 3,
'FIELDS': {
'CODE': 'newresthandlercode',
'NAME': 'New handler name',
'SORT': 200,
'SETTINGS': {
"CURRENCY": [
"USD", "EUR"
],
"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"
}
}
}
}
}
}
);
const result = response.getData().result;
console.info(result);
}
catch( error )
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'sale.paysystem.handler.update',
[
'ID' => 3,
'FIELDS' => [
'CODE' => 'newresthandlercode',
'NAME' => 'New handler name',
'SORT' => 200,
'SETTINGS' => [
'CURRENCY' => ['USD', 'EUR'],
'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": [
"USD", "EUR"
],
"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' => ['USD', 'EUR'],
'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 request execution time |
Error Handling
HTTP status: 400, 403
{
"error": "ERROR_HANDLER_NOT_FOUND",
"error_description": "Handler not found"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
error_description |
Textual description of the error. The description is not intended to be shown to the end user in its raw form |
Possible Error Codes
|
Code |
Description |
Status |
|
|
Access denied. The application is trying to modify a handler added by another application, or lacks permissions to update the handler |
403 |
|
|
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: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not allowed to be called using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The methods must be called using the HTTPS protocol |
|
|
|
The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans |
|
|
|
The user whose access token or webhook was used to call the method lacks permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users |
|
|
|
The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". 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 REST handler for 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 through a specific payment system sale.paysystem.pay.payment
- Pay an invoice through a specific payment system sale.paysystem.pay.invoice
- Get Payment System Settings for Specific Payment sale.paysystem.settings.payment.get
- Get payment system settings for a specific invoice sale.paysystem.settings.invoice.get