Get Payment System Settings sale.paysystem.settings.get

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the MCP server so the assistant can utilize the official REST documentation.

Scope: pay_system

Who can execute the method: CRM administrator (permission "Allow to modify settings")

This method returns the settings of the payment system. The structure of the settings is defined when adding the payment system handler in the method sale.paysystem.handler.add under the CODES key of the SETTINGS parameter.

Method Parameters

Required parameters are marked with *

Name `type`	Description
ID* `sale_paysystem.ID`	Identifier of the payment system for which settings are to be retrieved
PERSON_TYPE_ID* `sale_person_type.id`	Identifier of the payer type for which settings are to be retrieved. To get default settings, pass `0`

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"ID":11,"PERSON_TYPE_ID":1}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.paysystem.settings.get

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"ID":11,"PERSON_TYPE_ID":1,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sale.paysystem.settings.get

try
        {
            const response = await $b24.callMethod(
                'sale.paysystem.settings.get',
                {
                    'ID': 11,
                    'PERSON_TYPE_ID': 1,
                }
            );
            
            const result = response.getData().result;
            console.dir(result);
        }
        catch( error )
        {
            console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'sale.paysystem.settings.get',
                    [
                        'ID'            => 11,
                        'PERSON_TYPE_ID' => 1,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Your logic for processing data
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting payment system settings: ' . $e->getMessage();
        }

BX24.callMethod('sale.paysystem.settings.get', {
            'ID': 11,
            'PERSON_TYPE_ID': 1,
        }, 
            function(result) 
            { 
                if(result.error()) 
                    console.error(result.error()); 
                else 
                { 
                    console.dir(result.data()); 
                } 
            } 
        );

require_once('crest.php');
        
        $result = CRest::call(
            'sale.paysystem.settings.get',
            [
                'ID' => 11,
                'PERSON_TYPE_ID' => 1
            ]
        );
        
        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
type

Description

result
object

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 CODES parameter.

The values of the object are the parameter values:

either filled in manually by the user when creating the payment system
or specified when adding the payment system via sale.paysystem.add
or specified when executing the method sale.paysystem.settings.update

time
time

Information about the request execution time

Error Handling

HTTP Status: 400, 403

{
            "error": "ERROR_CHECK_FAILURE",
            "error_description": "Pay system not found"
        }

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `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`	Insufficient permissions to read settings	403
`ERROR_CHECK_FAILURE`	One of the required fields is not specified or the specified payment system is not found (details in the error description)	400

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not permitted for calls using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The HTTPS protocol is required for method calls
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is only available on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user associated with the access token or webhook used to call the method lacks the necessary permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	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
`500`	`PORTAL_DELETED` Portal was deleted	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

Continue Learning

Get List of Payment Systems

Update Payment System Settings

Get Payment System Settings sale.paysystem.settings.get

Method ParametersMethod Parameters

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