Add Payment System sale.paysystem.add

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that 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 adds a payment system.

Method Parameters

Required parameters are marked with *

Name `type`	Description
NAME* `string`	Name of the payment system
DESCRIPTION `string`	Description of the payment system
PERSON_TYPE_ID* `sale_person_type.id`	Identifier of the payer type
BX_REST_HANDLER* `sale_paysystem_handler.CODE`	Code of the REST handler specified when adding the handler using the sale.paysystem.handler.add method
ACTIVE `string`	Indicator of the payment system's activity. Possible values: `Y` — yes `N` — no If not provided, defaults to `N`
SETTINGS `object`	List of handler settings values in the format `{"field_1": "value_1", ... "field_N": "value_N"}`, where `field` is the name of the setting and `value` is an object containing keys TYPE and VALUE (see description below). The structure of settings is defined when adding the payment system handler in the sale.paysystem.handler.add method under the `CODES` key of the `SETTINGS` parameter
ENTITY_REGISTRY_TYPE* `string`	Binding of the payment system: `ORDER` — value for store orders, deals, smart processes `CRM_INVOICE` — value for CRM invoices `CRM_QUOTE` — value for CRM estimates
LOGOTYPE `string`	Logo of the payment system (image in Base64 format)
NEW_WINDOW `string`	Flag for the "Open in new window" setting. Possible values: `Y` — yes `N` — no If not provided, defaults to `N`
XML_ID `string`	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	`ID` — identifier `ACCOUNT_NUMBER` — order number `ORDER_TOPIC` — subject `DATE_INSERT` — order date `DATE_INSERT_DATE` — order date without time `DATE_BILL` — date and time of billing `DATE_BILL_DATE` — billing date `DATE_PAY_BEFORE` — payment deadline `SHOULD_PAY` — invoice amount `CURRENCY` — currency `PRICE` — order cost `PRICE_DELIVERY` — delivery cost `DISCOUNT_VALUE` — discount amount `USER_ID` — buyer code `PAY_SYSTEM_ID` — payment system code `DELIVERY_ID` — delivery service code `TAX_VALUE` — tax `USER_DESCRIPTION` — comment
PAYMENT	`ID` — identifier `ACCOUNT_NUMBER` — payment number `DATE_BILL` — date and time of billing `DATE_BILL_DATE` — billing date without time `SUM` — invoice amount `CURRENCY` — currency `PAID` — paid `DATE_PAID` — payment date `PAY_SYSTEM_ID` — payment system code `PAY_VOUCHER_NUM` — voucher number `PAY_VOUCHER_DATE` — voucher date `DATE_PAY_BEFORE` — pay by `XML_ID` — XML identifier `PAY_SYSTEM_NAME` — name of the payment system `COMPANY_ID` — company code `PAY_RETURN_NUM` — return number `PAY_RETURN_DATE` — return date `PAY_RETURN_COMMENT` — return comment
USER	`ID` — buyer code, `LOGIN` — login `NAME` — first name `SECOND_NAME` — middle name `LAST_NAME` — last name `EMAIL` — EMail `PERSONAL_PROFESSION` — profession `PERSONAL_WWW` — personal website `PERSONAL_ICQ` — ICQ number `PERSONAL_GENDER` — gender `PERSONAL_FAX` — fax number `PERSONAL_MOBILE` — mobile number `PERSONAL_STREET` — address `PERSONAL_MAILBOX` — mailbox `PERSONAL_CITY` — city `PERSONAL_STATE` — state `PERSONAL_ZIP` — zip code `PERSONAL_COUNTRY` — country `WORK_COMPANY` — company `WORK_DEPARTMENT` — department `WORK_POSITION` — position `WORK_WWW` — company website `WORK_PHONE` — work phone `WORK_FAX` — work fax `WORK_STREET` — company address `WORK_MAILBOX` — work mailbox `WORK_CITY` — company city `WORK_STATE` — company state `WORK_ZIP` — company zip code `WORK_COUNTRY` — company country

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 '{"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

try
        {
        	const response = await $b24.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',
        				}
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.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>';

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 `type`	Description
result `integer`	Identifier of the added payment system
time `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 `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 add the payment system	403
`ERROR_CHECK_FAILURE`	Required field value is not specified or one of the field values is incorrect	400
`ERROR_PAY_SYSTEM_ADD`	Other errors. For detailed information about the error, see `error_description`	400
`ERROR_HANDLER_NOT_FOUND`	Handler specified in the `BX_REST_HANDLER` parameter not found	400
`ERROR_PERSON_TYPE_NOT_FOUND`	Payer type specified in the `PERSON_TYPE_ID` parameter 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 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

Delete Payment System REST Handler

Modify Payment System

Add Payment System sale.paysystem.add

Method ParametersMethod Parameters

Possible Values of the TYPE KeyPossible Values of the TYPE Key

Possible Values of the VALUE KeyPossible Values of the VALUE Key

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