Add Payment System sale.paysystem.add
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
pay_systemWho can execute the method: CRM administrator (permission "Allow to modify settings")
This method adds a payment system.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
NAME* |
Name of the payment system |
|
DESCRIPTION |
Description of the payment system |
|
PERSON_TYPE_ID* |
Identifier of the payer type |
|
BX_REST_HANDLER* |
Code of the REST handler specified when adding the handler using the sale.paysystem.handler.add method |
|
ACTIVE |
Indicator of the payment system's activity. Possible values:
If not provided, defaults to |
|
SETTINGS |
List of handler settings values in the format The structure of settings is defined when adding the payment system handler in the sale.paysystem.handler.add method under the |
|
ENTITY_REGISTRY_TYPE |
Binding of the payment system:
If not provided, defaults to The payer type |
|
LOGOTYPE |
Logo of the payment system (image in Base64 format) |
|
NEW_WINDOW |
Flag for the "Open in new window" setting. Possible values:
If not provided, defaults to |
|
XML_ID |
External identifier of the payment system. Can be used as an additional parameter for filtering in sale.paysystem.list |
Possible Values of the TYPE Key
|
Name |
Description |
|
ORDER |
Parameters |
|
PROPERTY |
Invoice properties |
|
PAYMENT |
Payment |
|
USER |
User |
|
VALUE |
Arbitrary string value |
|
Y\N |
Checkbox |
Possible Values of the VALUE Key
|
Name |
Description |
|
ORDER |
|
|
PAYMENT |
|
|
USER |
|
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"NAME":"Card Payment","DESCRIPTION":"Easily pay for purchases with a card.","XML_ID":"my_ps_id","PERSON_TYPE_ID":1,"BX_REST_HANDLER":"resthandlercode","ACTIVE":"Y","ENTITY_REGISTRY_TYPE":"ORDER","LOGOTYPE":"/* base64 image */","NEW_WINDOW":"N","SETTINGS":{"REST_SERVICE_ID":{"TYPE":"VALUE","VALUE":"SERVICE ID VALUE"},"REST_SERVICE_KEY":{"TYPE":"VALUE","VALUE":"KEY ID VALUE"},"PAYMENT_ID":{"TYPE":"PAYMENT","VALUE":"ACCOUNT_NUMBER"}}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.paysystem.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"NAME":"Card Payment","DESCRIPTION":"Easily pay for purchases with a card.","XML_ID":"my_ps_id","PERSON_TYPE_ID":1,"BX_REST_HANDLER":"resthandlercode","ACTIVE":"Y","ENTITY_REGISTRY_TYPE":"ORDER","LOGOTYPE":"/* base64 image */","NEW_WINDOW":"N","SETTINGS":{"REST_SERVICE_ID":{"TYPE":"VALUE","VALUE":"SERVICE ID VALUE"},"REST_SERVICE_KEY":{"TYPE":"VALUE","VALUE":"KEY ID VALUE"},"PAYMENT_ID":{"TYPE":"PAYMENT","VALUE":"ACCOUNT_NUMBER"}},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.paysystem.add
// 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
try {
const response = await $b24.actions.v2.call.make<number>({
method: 'sale.paysystem.add',
params: {
NAME: 'Card payment',
DESCRIPTION: 'Pay for your purchases easily by card.',
XML_ID: 'my_ps_id',
PERSON_TYPE_ID: 1,
BX_REST_HANDLER: 'resthandlercode',
ACTIVE: 'Y',
ENTITY_REGISTRY_TYPE: 'ORDER',
LOGOTYPE: '/* base64 image */',
NEW_WINDOW: 'N',
SETTINGS: {
REST_SERVICE_ID: {
TYPE: 'VALUE',
VALUE: 'SERVICE ID VALUE',
},
REST_SERVICE_KEY: {
TYPE: 'VALUE',
VALUE: 'KEY ID VALUE',
},
PAYMENT_ID: {
TYPE: 'PAYMENT',
VALUE: 'ACCOUNT_NUMBER',
},
},
},
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('Added payment system ID:', result)
}
} 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 addPaySystem() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'sale.paysystem.add',
params: {
NAME: 'Card payment',
DESCRIPTION: 'Pay for your purchases easily by card.',
XML_ID: 'my_ps_id',
PERSON_TYPE_ID: 1,
BX_REST_HANDLER: 'resthandlercode',
ACTIVE: 'Y',
ENTITY_REGISTRY_TYPE: 'ORDER',
LOGOTYPE: '/* base64 image */',
NEW_WINDOW: 'N',
SETTINGS: {
REST_SERVICE_ID: {
TYPE: 'VALUE',
VALUE: 'SERVICE ID VALUE',
},
REST_SERVICE_KEY: {
TYPE: 'VALUE',
VALUE: 'KEY ID VALUE',
},
PAYMENT_ID: {
TYPE: 'PAYMENT',
VALUE: 'ACCOUNT_NUMBER',
},
},
},
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('Added payment system ID:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addPaySystem)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
settings = {
"REST_SERVICE_ID": {
"TYPE": "VALUE",
"VALUE": "SERVICE ID VALUE",
},
"REST_SERVICE_KEY": {
"TYPE": "VALUE",
"VALUE": "KEY ID VALUE",
},
"PAYMENT_ID": {
"TYPE": "PAYMENT",
"VALUE": "ACCOUNT_NUMBER",
},
}
try:
bitrix_response = client.sale.paysystem.add(
name="Card payment",
description="Pay for your purchases easily by card.",
xml_id="my_ps_id",
person_type_id=1,
bx_rest_handler="resthandlercode",
active=True,
entity_registry_type="ORDER",
logotype="/* base64 image */",
new_window=False,
settings=settings,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Bitrix API error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
try {
$response = $b24Service
->core
->call(
'sale.paysystem.add',
[
'NAME' => 'Card Payment',
'DESCRIPTION' => 'Easily pay for purchases with a card.',
'XML_ID' => 'my_ps_id',
'PERSON_TYPE_ID' => 1,
'BX_REST_HANDLER' => 'resthandlercode',
'ACTIVE' => 'Y',
'ENTITY_REGISTRY_TYPE' => 'ORDER',
'LOGOTYPE' => '/* base64 image */',
'NEW_WINDOW' => 'N',
'SETTINGS' => [
'REST_SERVICE_ID' => [
'TYPE' => 'VALUE',
'VALUE' => 'SERVICE ID VALUE',
],
'REST_SERVICE_KEY' => [
'TYPE' => 'VALUE',
'VALUE' => 'KEY ID VALUE',
],
'PAYMENT_ID' => [
'TYPE' => 'PAYMENT',
'VALUE' => 'ACCOUNT_NUMBER',
],
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error adding payment system: ' . $e->getMessage();
}
BX24.callMethod(
"sale.paysystem.add",
{
'NAME' : 'Card Payment',
'DESCRIPTION': 'Easily pay for purchases with a card.',
'XML_ID': 'my_ps_id',
'PERSON_TYPE_ID' : 1,
'BX_REST_HANDLER' : 'resthandlercode',
'ACTIVE' : 'Y',
'ENTITY_REGISTRY_TYPE': 'ORDER',
'LOGOTYPE': '/* base64 image */',
'NEW_WINDOW': 'N',
'SETTINGS' : {
'REST_SERVICE_ID' : {
'TYPE' : 'VALUE',
'VALUE' : 'SERVICE ID VALUE'
},
'REST_SERVICE_KEY' : {
'TYPE' : 'VALUE',
'VALUE' : 'KEY ID VALUE'
},
'PAYMENT_ID': {
'TYPE': 'PAYMENT',
'VALUE': 'ACCOUNT_NUMBER',
}
}
},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'sale.paysystem.add',
[
'NAME' => 'Card Payment',
'DESCRIPTION' => 'Easily pay for purchases with a card.',
'XML_ID' => 'my_ps_id',
'PERSON_TYPE_ID' => 1,
'BX_REST_HANDLER' => 'resthandlercode',
'ACTIVE' => 'Y',
'ENTITY_REGISTRY_TYPE' => 'ORDER',
'LOGOTYPE' => '/* base64 image */',
'NEW_WINDOW' => 'N',
'SETTINGS' => [
'REST_SERVICE_ID' => [
'TYPE' => 'VALUE',
'VALUE' => 'SERVICE ID VALUE'
],
'REST_SERVICE_KEY' => [
'TYPE' => 'VALUE',
'VALUE' => 'KEY ID VALUE'
],
'PAYMENT_ID' => [
'TYPE' => 'PAYMENT',
'VALUE' => 'ACCOUNT_NUMBER',
]
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "sale.paysystem.add", b24.Params{
"NAME": "Card Payment",
"DESCRIPTION": "Easily pay for purchases with a card.",
"XML_ID": "my_ps_id",
"PERSON_TYPE_ID": 1,
"BX_REST_HANDLER": "resthandlercode",
"ACTIVE": "Y",
"ENTITY_REGISTRY_TYPE": "ORDER",
"LOGOTYPE": "/* base64 image */",
"NEW_WINDOW": "N",
"SETTINGS": b24.Params{
"REST_SERVICE_ID": b24.Params{
"TYPE": "VALUE",
"VALUE": "SERVICE ID VALUE",
},
"REST_SERVICE_KEY": b24.Params{
"TYPE": "VALUE",
"VALUE": "KEY ID VALUE",
},
"PAYMENT_ID": b24.Params{
"TYPE": "PAYMENT",
"VALUE": "ACCOUNT_NUMBER",
},
},
})
if err != nil {
return fmt.Errorf("sale.paysystem.add: %w", err)
}
var newID b24.ID
if err := json.Unmarshal(res.Result, &newID); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println("id:", newID)
Response Handling
HTTP Status: 200
{
"result": 1,
"time": {
"start": 1712132792.910734,
"finish": 1712132793.530359,
"duration": 0.6196250915527344,
"processing": 0.032338857650756836,
"date_start": "2024-04-03T10:26:32+02:00",
"date_finish": "2024-04-03T10:26:33+02:00",
"operating_reset_at": 1705765533,
"operating": 3.3076241016387939
}
}
Returned Data
|
Name |
Description |
|
result |
Identifier of the added payment system |
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 400, 403
{
"error": "ERROR_CHECK_FAILURE",
"error_description": "Parameter NAME is not defined"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
Status |
|
|
Insufficient permissions to add the payment system |
403 |
|
|
Required field value is not specified or one of the field values is incorrect |
400 |
|
|
Other errors. For detailed information about the error, see |
400 |
|
|
Handler specified in the |
400 |
|
|
Payer type specified in the |
400 |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it 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
- 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 via a Specific Payment System sale.paysystem.pay.payment
- Get Payment System Settings for a Specific Payment sale.paysystem.settings.payment.get