Pay an invoice through a specific payment system sale.paysystem.pay.invoice

Scope: pay_system

Who can execute the method: a user with permissions to create and edit CRM invoices (old version)

This method is used to pay an invoice (old 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 old version invoice. To retrieve information about invoices, use the service crm.invoice.*
PAY_SYSTEM_ID `sale_paysystem.ID`	Identifier of the payment system
BX_REST_HANDLER `string`	Symbolic identifier of the payment system's REST handler. You must pass either the `PAY_SYSTEM_ID` parameter or the `BX_REST_HANDLER`: when passing `PAY_SYSTEM_ID`, the payment system with the specified identifier is used when passing `BX_REST_HANDLER`, the first found payment system with the specified handler is used If both parameters are passed, the `PAY_SYSTEM_ID` parameter takes precedence.

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

try
        {
        	const response = await $b24.callMethod(
        		'sale.paysystem.pay.invoice',
        		{
        			"INVOICE_ID": 2,
        			"PAY_SYSTEM_ID": 31,
        		}
        	);
        	
        	const result = response.getData().result;
        	console.dir(result);
        }
        catch( error )
        {
        	console.error(error);
        }

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>';

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 request execution time

Error Handling

HTTP status: 400

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

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 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: 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 allowed to be called 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 methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks 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 account administrator has allowed access to this application only for specific users
`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 option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Pay for Order via Specific Payment System

Get Settings for Payment System for Specific Payment

Pay an invoice through a specific payment system sale.paysystem.pay.invoice

Method ParametersMethod Parameters

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