Pay Invoice Through a Specific Payment System sale.paysystem.pay.invoice

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: a user with permissions to create and edit CRM invoices (legacy version)

This method is used to pay an invoice (legacy version) through a specific payment system. It is called after processing the response from the payment system.

Method Parameters

Required parameters are marked with *

Name
type

Description

INVOICE_ID*
integer

Identifier of the legacy invoice. The service crm.invoice.* is used to retrieve invoice information.

PAY_SYSTEM_ID
sale_paysystem.ID

Identifier of the payment system

BX_REST_HANDLER
string

Symbolic identifier of the REST handler for the payment system.

You must provide either the PAY_SYSTEM_ID parameter or the BX_REST_HANDLER:

  • When providing PAY_SYSTEM_ID, the payment system with the specified identifier is used.
  • When providing BX_REST_HANDLER, the first found payment system with the specified handler is used.

If both parameters are provided, the PAY_SYSTEM_ID parameter takes precedence.

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"INVOICE_ID":2,"PAY_SYSTEM_ID":31}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.paysystem.pay.invoice
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"INVOICE_ID":2,"PAY_SYSTEM_ID":31,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sale.paysystem.pay.invoice
        
// 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<boolean>({
            method: 'sale.paysystem.pay.invoice',
            params: {
              INVOICE_ID: 2,
              PAY_SYSTEM_ID: 31,
            },
            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('Invoice paid successfully:', 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 payInvoice() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'sale.paysystem.pay.invoice',
                params: {
                  INVOICE_ID: 2,
                  PAY_SYSTEM_ID: 31,
                },
                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('Invoice paid successfully:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', payInvoice)
        </script>
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'sale.paysystem.pay.invoice',
                    [
                        'INVOICE_ID'    => 2,
                        'PAY_SYSTEM_ID' => 31,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Your logic for processing data
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error paying invoice: ' . $e->getMessage();
        }
        
BX24.callMethod('sale.paysystem.pay.invoice', {
            "INVOICE_ID": 2,
            "PAY_SYSTEM_ID": 31,
        }, 
        function(result) 
        { 
            if (result.error()) 
            {
                console.error(result.error()); 
            }
            else 
            { 
                console.dir(result.data()); 
            } 
        } 
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'sale.paysystem.pay.invoice',
            [
                'INVOICE_ID' => 2,
                'PAY_SYSTEM_ID' => 31
            ]
        );
        
        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.pay.invoice", b24.Params{
        	"INVOICE_ID":    2,
        	"PAY_SYSTEM_ID": 31,
        })
        if err != nil {
        	return fmt.Errorf("sale.paysystem.pay.invoice: %w", err)
        }
        
        var ok bool
        if err := json.Unmarshal(res.Result, &ok); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println("done:", ok)
        

Response Handling

HTTP Status: 200

{
            "result": true,
            "time": {
                "start": 1712135335.026931,
                "finish": 1712135335.407762,
                "duration": 0.3808310031890869,
                "processing": 0.0336611270904541,
                "date_start": "2024-04-03T11:08:55+02:00",
                "date_finish": "2024-04-03T11:08:55+02:00",
                "operating_reset_at": 1705765533,
                "operating": 3.3076241016387939
            }
        }
        

Returned Data

Name
type

Description

result
boolean

Result of the invoice payment

time
time

Information about the execution time of the request

Error Handling

HTTP Status: 400

{
            "error": "ERROR_CHECK_FAILURE",
            "error_description": "Pay system not found"
        }
        

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 pay the invoice

403

ERROR_CHECK_FAILURE

One of the required fields is missing, the payment system with the specified REST handler was not found, or the invoice with the specified ID was not found (details can be found in the error description)

400

ERROR_PAY_INVOICE_NOT_SUPPORTED

Invoice payments are not supported on the account

400

ERROR_INTERNAL_INVOICE_NOT_FOUND

Invoice with the specified ID was not found

400

ERROR_PROCESS_REQUEST_RESULT

Payment system with the specified ID was not found or an error occurred while processing the request by the payment system (details can be found in the error description)

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