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_systemWho can execute the method: CRM administrator (permission "Allow to modify settings")
This method returns a list of payment systems.
Method Parameters
|
Name |
Description |
|
SELECT |
An array containing the list of fields to select (see fields of the If the array is not provided or an empty array is passed, all available fields of the payment systems will be selected. |
|
FILTER |
An object for filtering the selected payment systems in the format Possible values for An additional prefix can be specified for the key to clarify the filter behavior. Possible prefix values:
|
|
ORDER |
An object for sorting the selected payment systems in the format Possible values for Possible values for
|
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
// 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
// Shape of each PaySystemItem returned in result[]
type PaySystemItem = {
ID: number
PERSON_TYPE_ID: number
NAME: string
PSA_NAME: string
SORT: number
DESCRIPTION: string
ACTION_FILE: string
RESULT_FILE: string | null
NEW_WINDOW: string
TARIFF: string | null
PS_MODE: string | null
HAVE_PAYMENT: string
HAVE_ACTION: string
HAVE_RESULT: string
HAVE_PREPAY: string
HAVE_PRICE: string
HAVE_RESULT_RECEIVE: string
ENCODING: string | null
ACTIVE: string
ALLOW_EDIT_PAYMENT: string
IS_CASH: string
AUTO_CHANGE_1C: string
CAN_PRINT_CHECK: string
ENTITY_REGISTRY_TYPE: string
XML_ID: string
}
try {
// sale.paysystem.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make<PaySystemItem[]>({
method: 'sale.paysystem.list',
params: {
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',
},
start: 0,
},
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('Pay systems fetched:', result.length, result[0]?.NAME)
}
} 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 fetchPaySystemList() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// sale.paysystem.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make({
method: 'sale.paysystem.list',
params: {
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',
},
start: 0,
},
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('Pay systems fetched:', result.length, result[0]?.NAME)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', fetchPaySystemList)
</script>
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 |
Description |
|
result |
An array of objects containing information about the selected payment systems |
|
time |
Information about the execution time of the request |
Error Handling
HTTP Status: 400, 403
{
"error":"ACCESS_DENIED",
"error_description":"Access denied!"
}
|
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 |
|
|
Validation error of incoming parameters (details see in the error description) |
400 |
|
|
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 |
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 |
Continue Learning
- Add REST Handler for Payment System sale.paysystem.handler.add
- Update REST Handler for Payment System sale.paysystem.handler.update
- 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 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