Get Payment Information crm.item.payment.get

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: crm

Who can execute the method: requires access permission to modify the payment order

Retrieves brief information about the payment.

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
sale_order_payment.id

Payment identifier

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":1036}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.item.payment.get
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":1036,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.item.payment.get
        
// 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, ISODate } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type PaymentGetResult = {
          id: number
          accountNumber: string
          paid: 'Y' | 'N'
          datePaid: ISODate | null
          empPaidId: number
          paySystemId: number
          sum: number
          currency: string
          paySystemName: string
        }
        
        try {
          const response = await $b24.actions.v2.call.make<PaymentGetResult>({
            method: 'crm.item.payment.get',
            params: {
              id: 1036,
            },
            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(result.id, result.accountNumber, result.paid, result.sum, result.currency)
          }
        } 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 getPayment() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'crm.item.payment.get',
                params: {
                  id: 1036,
                },
                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(result.id, result.accountNumber, result.paid, result.sum, result.currency)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getPayment)
        </script>
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.item.payment.get',
                    [
                        'id' => 1036,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting payment item: ' . $e->getMessage();
        }
        

Example

from b24pysdk.client import BaseClient
        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        client: BaseClient
        
        try:
            bitrix_response = client.crm.item.payment.get(
                bitrix_id=1036,
            ).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}")
        
BX24.callMethod(
            'crm.item.payment.get', {
                id: 1036,
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.log(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.item.payment.get',
            [
                'id' => 1036
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

Response on Success

HTTP status: 200

{
           "result":{
              "id":1036,
              "accountNumber":"3653\/1",
              "paid": "Y",
              "datePaid":"2024-05-20T12:32:02+03:00",
              "empPaidId":1,
              "paySystemId":6,
              "sum":0,
              "currency":"USD",
              "paySystemName":"Cash"
           },
           "time":{
              "start":1716203536.414886,
              "finish":1716203536.798211,
              "duration":0.38332509994506836,
              "processing":0.052394866943359375,
              "date_start":"2024-05-20T14:12:16+03:00",
              "date_finish":"2024-05-20T14:12:16+03:00"
           }
        }
        

Returned Data

Name
type

Description

result
sale_order_payment_crm_simple

Object containing brief information about the payment

time
time

Information about the request execution time

Key Result.

Object of type sale_order_payment_crm_simple
#|
|| Name
type | Description ||
|| id
sale_order_payment.id | Payment identifier ||
|| accountNumber
string | System payment number ||
|| paid
string | Payment status

Possible values:

  • Y – Paid
  • N – Not paid ||
    || datePaid
    datetime | Payment date ||
    || empPaidId
    user.id| User who made the payment ||
    || paySystemId
    sale_paysystem.id | Payment system identifier ||
    || sum
    double | Payment amount ||
    || currency
    string | Payment currency ||
    || paySystemName
    string | Name of the payment system ||
    |#

Error Handling

HTTP status: 400

{
           "error":0,
           "error_description":"Insufficient permissions"
        }
        

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

0

Payment not found or access denied

100

Parameter id not specified

0

Other errors (e.g., fatal errors)

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