Get a List of Payment Systems sale.paysystem.list

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_system

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

This method returns a list of payment systems.

Method Parameters

Name
type

Description

SELECT
array

An array containing the list of fields to select (see fields of the sale_paysystem object).

If the array is not provided or an empty array is passed, all available fields of the payment systems will be selected.

FILTER
object

An object for filtering the selected payment systems in the format {"field_1": "value_1", ... "field_N": "value_N"}.

Possible values for field correspond to the fields of the sale_paysystem object.

An additional prefix can be specified for the key to clarify the filter behavior. Possible prefix values:

  • >= — greater than or equal to
  • > — greater than
  • <= — less than or equal to
  • < — less than
  • @ — IN, an array is passed as the value
  • !@ — NOT IN, an array is passed as the value
  • % — LIKE, substring search. The % character does not need to be passed in the filter value. The search looks for the substring in any position of the string.
  • =% — LIKE, substring search. The % character needs to be passed in the value. Examples:
    • "mol%" — searches for values starting with "mol"
    • "%mol" — searches for values ending with "mol"
    • "%mol%" — searches for values where "mol" can be in any position
  • %= — LIKE (similar to =%)
  • !% — NOT LIKE, substring search. The % character does not need to be passed in the filter value. The search goes from both sides.
  • !=% — NOT LIKE, substring search. The % character needs to be passed in the value. Examples:
    • "mol%" — searches for values not starting with "mol"
    • "%mol" — searches for values not ending with "mol"
    • "%mol%" — searches for values where the substring "mol" is not present in any position
  • !%= — NOT LIKE (similar to !=%)
  • = — equal, exact match (used by default)
  • != — not equal
  • ! — not equal

ORDER
object

An object for sorting the selected payment systems in the format {"field_1": "order_1", ... "field_N": "order_N"}.

Possible values for field correspond to the fields of the sale_paysystem object.

Possible values for order:

  • ASC — in ascending order
  • DESC — in descending order

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"SELECT":["ID","PERSON_TYPE_ID","NAME","PSA_NAME","SORT","DESCRIPTION","ACTION_FILE","RESULT_FILE","NEW_WINDOW","TARIF","PS_MODE","HAVE_PAYMENT","HAVE_ACTION","HAVE_RESULT","HAVE_PREPAY","HAVE_PRICE","HAVE_RESULT_RECEIVE","ENCODING","ACTIVE","ALLOW_EDIT_PAYMENT","IS_CASH","AUTO_CHANGE_1C","CAN_PRINT_CHECK","ENTITY_REGISTRY_TYPE","XML_ID"],"FILTER":{"@ID":[117,118]},"ORDER":{"SORT":"ASC","ID":"DESC"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.paysystem.list
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"SELECT":["ID","PERSON_TYPE_ID","NAME","PSA_NAME","SORT","DESCRIPTION","ACTION_FILE","RESULT_FILE","NEW_WINDOW","TARIF","PS_MODE","HAVE_PAYMENT","HAVE_ACTION","HAVE_RESULT","HAVE_PREPAY","HAVE_PRICE","HAVE_RESULT_RECEIVE","ENCODING","ACTIVE","ALLOW_EDIT_PAYMENT","IS_CASH","AUTO_CHANGE_1C","CAN_PRINT_CHECK","ENTITY_REGISTRY_TYPE","XML_ID"],"FILTER":{"@ID":[117,118]},"ORDER":{"SORT":"ASC","ID":"DESC"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sale.paysystem.list
        
// callListMethod: Retrieves all data at once. Use only for small selections (< 1000 items) due to high memory load.
        
        try {
          const response = await $b24.callListMethod(
            'sale.paysystem.list',
            {
              SELECT: [
                "ID",
                "PERSON_TYPE_ID",
                "NAME",
                "PSA_NAME",
                "SORT",
                "DESCRIPTION",
                "ACTION_FILE",
                "RESULT_FILE",
                "NEW_WINDOW",
                "TARIF",
                "PS_MODE",
                "HAVE_PAYMENT",
                "HAVE_ACTION",
                "HAVE_RESULT",
                "HAVE_PREPAY",
                "HAVE_PRICE",
                "HAVE_RESULT_RECEIVE",
                "ENCODING",
                "ACTIVE",
                "ALLOW_EDIT_PAYMENT",
                "IS_CASH",
                "AUTO_CHANGE_1C",
                "CAN_PRINT_CHECK",
                "ENTITY_REGISTRY_TYPE",
                "XML_ID",
              ],
              FILTER: {
                "@ID": [117, 118],
              },
              ORDER: {
                SORT: "ASC",
                ID: "DESC",
              },
            },
            (progress) => { console.log('Progress:', progress) }
          );
          const items = response.getData() || [];
          for (const entity of items) { console.log('Entity:', entity); }
        } catch (error) {
          console.error('Request failed', error);
        }
        
        // fetchListMethod: Retrieves data in parts using an iterator. Use for large volumes of data for efficient memory consumption.
        
        try {
          const generator = $b24.fetchListMethod('sale.paysystem.list', {
            SELECT: [
              "ID",
              "PERSON_TYPE_ID",
              "NAME",
              "PSA_NAME",
              "SORT",
              "DESCRIPTION",
              "ACTION_FILE",
              "RESULT_FILE",
              "NEW_WINDOW",
              "TARIF",
              "PS_MODE",
              "HAVE_PAYMENT",
              "HAVE_ACTION",
              "HAVE_RESULT",
              "HAVE_PREPAY",
              "HAVE_PRICE",
              "HAVE_RESULT_RECEIVE",
              "ENCODING",
              "ACTIVE",
              "ALLOW_EDIT_PAYMENT",
              "IS_CASH",
              "AUTO_CHANGE_1C",
              "CAN_PRINT_CHECK",
              "ENTITY_REGISTRY_TYPE",
              "XML_ID",
            ],
            FILTER: {
              "@ID": [117, 118],
            },
            ORDER: {
              SORT: "ASC",
              ID: "DESC",
            },
          }, 'ID');
          for await (const page of generator) {
            for (const entity of page) { console.log('Entity:', entity); }
          }
        } catch (error) {
          console.error('Request failed', error);
        }
        
        // callMethod: Manual control of pagination through the start parameter. Use for precise control over request batches. Less efficient for large data than fetchListMethod.
        
        try {
          const response = await $b24.callMethod('sale.paysystem.list', {
            SELECT: [
              "ID",
              "PERSON_TYPE_ID",
              "NAME",
              "PSA_NAME",
              "SORT",
              "DESCRIPTION",
              "ACTION_FILE",
              "RESULT_FILE",
              "NEW_WINDOW",
              "TARIF",
              "PS_MODE",
              "HAVE_PAYMENT",
              "HAVE_ACTION",
              "HAVE_RESULT",
              "HAVE_PREPAY",
              "HAVE_PRICE",
              "HAVE_RESULT_RECEIVE",
              "ENCODING",
              "ACTIVE",
              "ALLOW_EDIT_PAYMENT",
              "IS_CASH",
              "AUTO_CHANGE_1C",
              "CAN_PRINT_CHECK",
              "ENTITY_REGISTRY_TYPE",
              "XML_ID",
            ],
            FILTER: {
              "@ID": [117, 118],
            },
            ORDER: {
              SORT: "ASC",
              ID: "DESC",
            },
          }, 0);
          const result = response.getData().result || [];
          for (const entity of result) { console.log('Entity:', entity); }
        } catch (error) {
          console.error('Request failed', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'sale.paysystem.list',
                    [
                        'SELECT' => [
                            "ID",
                            "PERSON_TYPE_ID",
                            "NAME",
                            "PSA_NAME",
                            "SORT",
                            "DESCRIPTION",
                            "ACTION_FILE",
                            "RESULT_FILE",
                            "NEW_WINDOW",
                            "TARIF",
                            "PS_MODE",
                            "HAVE_PAYMENT",
                            "HAVE_ACTION",
                            "HAVE_RESULT",
                            "HAVE_PREPAY",
                            "HAVE_PRICE",
                            "HAVE_RESULT_RECEIVE",
                            "ENCODING",
                            "ACTIVE",
                            "ALLOW_EDIT_PAYMENT",
                            "IS_CASH",
                            "AUTO_CHANGE_1C",
                            "CAN_PRINT_CHECK",
                            "ENTITY_REGISTRY_TYPE",
                            "XML_ID",
                        ],
                        'FILTER' => [
                            "@ID" => [117, 118],
                        ],
                        'ORDER' => [
                            'SORT' => "ASC",
                            'ID'   => "DESC",
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching payment system list: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'sale.paysystem.list', {
                SELECT: [
                    "ID",
                    "PERSON_TYPE_ID",
                    "NAME",
                    "PSA_NAME",
                    "SORT",
                    "DESCRIPTION",
                    "ACTION_FILE",
                    "RESULT_FILE",
                    "NEW_WINDOW",
                    "TARIF",
                    "PS_MODE",
                    "HAVE_PAYMENT",
                    "HAVE_ACTION",
                    "HAVE_RESULT",
                    "HAVE_PREPAY",
                    "HAVE_PRICE",
                    "HAVE_RESULT_RECEIVE",
                    "ENCODING",
                    "ACTIVE",
                    "ALLOW_EDIT_PAYMENT",
                    "IS_CASH",
                    "AUTO_CHANGE_1C",
                    "CAN_PRINT_CHECK",
                    "ENTITY_REGISTRY_TYPE",
                    "XML_ID",
                ],
                FILTER: {
                    "@ID": [117, 118],
                },
                ORDER: {
                    SORT: "ASC",
                    ID: "DESC",
                },
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'sale.paysystem.list',
            [
                'SELECT' => [
                    "ID",
                    "PERSON_TYPE_ID",
                    "NAME",
                    "PSA_NAME",
                    "SORT",
                    "DESCRIPTION",
                    "ACTION_FILE",
                    "RESULT_FILE",
                    "NEW_WINDOW",
                    "TARIF",
                    "PS_MODE",
                    "HAVE_PAYMENT",
                    "HAVE_ACTION",
                    "HAVE_RESULT",
                    "HAVE_PREPAY",
                    "HAVE_PRICE",
                    "HAVE_RESULT_RECEIVE",
                    "ENCODING",
                    "ACTIVE",
                    "ALLOW_EDIT_PAYMENT",
                    "IS_CASH",
                    "AUTO_CHANGE_1C",
                    "CAN_PRINT_CHECK",
                    "ENTITY_REGISTRY_TYPE",
                    "XML_ID",
                ],
                'FILTER' => [
                    "@ID" => [117, 118],
                ],
                'ORDER' => [
                    "SORT" => "ASC",
                    "ID" => "DESC",
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
            "result":[
                {
                    "NAME":"New Card Payment",
                    "PSA_NAME":"New Card Payment",
                    "DESCRIPTION":"Easily pay for purchases with a card.",
                    "ACTION_FILE":"resthandlerform",
                    "RESULT_FILE":null,
                    "NEW_WINDOW":"N",
                    "PS_MODE":null,
                    "HAVE_PAYMENT":"N",
                    "HAVE_ACTION":"N",
                    "HAVE_RESULT":"N",
                    "HAVE_PREPAY":"N",
                    "HAVE_PRICE":"N",
                    "HAVE_RESULT_RECEIVE":"Y",
                    "ENCODING":null,
                    "ACTIVE":"Y",
                    "ALLOW_EDIT_PAYMENT":"Y",
                    "IS_CASH":"N",
                    "AUTO_CHANGE_1C":"N",
                    "CAN_PRINT_CHECK":"N",
                    "ENTITY_REGISTRY_TYPE":"ORDER",
                    "XML_ID":"my_ps_id",
                    "ID":118,
                    "PERSON_TYPE_ID":3,
                    "SORT":100,
                    "TARIFF":null
                },
                {
                    "NAME":"Card Payment",
                    "PSA_NAME":"Card Payment",
                    "DESCRIPTION":"Easily pay for purchases with a card.",
                    "ACTION_FILE":"resthandlerform",
                    "RESULT_FILE":null,
                    "NEW_WINDOW":"Y",
                    "PS_MODE":"",
                    "HAVE_PAYMENT":"N",
                    "HAVE_ACTION":"N",
                    "HAVE_RESULT":"N",
                    "HAVE_PREPAY":"N",
                    "HAVE_PRICE":"N",
                    "HAVE_RESULT_RECEIVE":"Y",
                    "ENCODING":"windows-1251",
                    "ACTIVE":"Y",
                    "ALLOW_EDIT_PAYMENT":"Y",
                    "IS_CASH":"N",
                    "AUTO_CHANGE_1C":"N",
                    "CAN_PRINT_CHECK":"N",
                    "ENTITY_REGISTRY_TYPE":"ORDER",
                    "XML_ID":"my_ps_id",
                    "ID":117,
                    "PERSON_TYPE_ID":3,
                    "SORT":100,
                    "TARIFF":null
                }
            ],
            "time":{
                "start":1714993577.419989,
                "finish":1714993577.621777,
                "duration":0.20178794860839844,
                "processing":0.027898073196411133,
                "date_start":"2024-05-06T14:06:17+02:00",
                "date_finish":"2024-05-06T14:06:17+02:00"
            }
        }

Returned Data

Name
type

Description

result
sale_paysystem[]

An array of objects containing information about the selected payment systems

time
time

Information about the execution time of the request

Error Handling

HTTP Status: 400, 403

{
            "error":"ACCESS_DENIED",
            "error_description":"Access denied!"
        }

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

ERROR_CHECK_FAILURE

Validation error of incoming parameters (details see in the error description)

400

ACCESS_DENIED

Insufficient rights to retrieve the list of payment systems

403

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

Previous
Modify Payment System
Next
Get Payment System Settings