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_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

If not provided, defaults to CRM_INVOICE.

The payer type PERSON_TYPE_ID must belong to the same binding type

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 -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
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 consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

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: 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
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

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

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

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 — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not 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

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

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 provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

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