Get Payment System Settings for a Specific Invoice sale.paysystem.settings.invoice.get
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so the assistant can utilize the official REST documentation.
Scope:
pay_systemWho can execute the method: a user with permissions to create and edit CRM invoices (legacy version)
This method returns the payment system settings for a specific invoice (legacy version).
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
INVOICE_ID* |
Identifier of the legacy invoice. The service crm.invoice.* is used to retrieve information about invoices. |
|
PAY_SYSTEM_ID |
Identifier of the payment system |
|
BX_REST_HANDLER |
Symbolic identifier of the payment system handler |
You must provide either the PAY_SYSTEM_ID parameter or the BX_REST_HANDLER parameter:
- When providing
PAY_SYSTEM_ID, the payment system with the specified identifier is used. - When providing
BX_REST_HANDLER, the first found payment system with the specified handler is used.
If both parameters are provided, the PAY_SYSTEM_ID parameter takes precedence.
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"INVOICE_ID":10,"PAY_SYSTEM_ID":11}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.paysystem.settings.invoice.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"INVOICE_ID":10,"PAY_SYSTEM_ID":11,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.paysystem.settings.invoice.get
try
{
const response = await $b24.callMethod(
'sale.paysystem.settings.invoice.get',
{
"INVOICE_ID": 10,
"PAY_SYSTEM_ID": 11
}
);
const result = response.getData().result;
console.dir(result);
}
catch( error )
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'sale.paysystem.settings.invoice.get',
[
'INVOICE_ID' => 10,
'PAY_SYSTEM_ID' => 11,
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
} else {
echo 'Data: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting invoice settings: ' . $e->getMessage();
}
BX24.callMethod('sale.paysystem.settings.invoice.get', {
"INVOICE_ID": 10,
"PAY_SYSTEM_ID": 11
},
function(result)
{
if(result.error())
{
console.error(result.error());
}
else
{
console.dir(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'sale.paysystem.settings.invoice.get',
[
'INVOICE_ID' => 10,
'PAY_SYSTEM_ID' => 11
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP Status: 200
{
"result": {
"REST_SERVICE_ID_IFRAME": "snum",
"REST_SERVICE_KEY_IFRAME": "skey",
"PS_WORK_MODE_IFRAME": "REGULAR"
},
"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 |
Root element of the response. The keys of the object are the parameter codes specified when adding the handler via sale.paysystem.handler.add in the The values of the object are the parameter values:
|
|
time |
Information about the execution time of the request |
Error Handling
HTTP Status: 400, 403
{
"error": "ERROR_CHECK_FAILURE",
"error_description": "Pay system 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 |
|
|
Insufficient permissions to retrieve settings |
403 |
|
|
One of the required fields is not specified or the payment system with the specified |
400 |
|
|
The specified invoice was not found |
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 permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary 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 portal administrator has restricted access to this application to specific users only |
|
|
|
The public part of the site is closed. To open the public part of the site 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 |