метод REST
scope: crm
crm.item.payment.get
Получить информацию об оплате
Описание
Метод получает краткую информацию об оплате.
Параметры
id
sale_order_payment.id
обязательный
Идентификатор оплаты
Примеры запроса
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>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
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",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
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();
}
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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.item.payment.get", b24.Params{
"id": 1036,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.item.payment.get: %w", err)
}
var item struct {
ID b24.ID `json:"id"`
AccountNumber string `json:"accountNumber"`
Paid string `json:"paid"`
DatePaid string `json:"datePaid"`
EmpPaidID b24.ID `json:"empPaidId"`
PaySystemID b24.ID `json:"paySystemId"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.AccountNumber)
Ответ
HTTP-статус: 200
{
"result":{
"id":1036,
"accountNumber":"3653\/1",
"paid": "Y",
"datePaid":"2024-05-20T12:32:02+03:00",
"empPaidId":1,
"paySystemId":6,
"sum":0,
"currency":"RUB",
"paySystemName":"Наличные"
},
"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"
}
}
Возвращаемые данные
result
sale_order_payment_crm_simple
Объект, содержащий краткую информацию об оплате
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error":0,
"error_description":"Недостаточно прав"
}
| Код | Описание | Значение |
|---|---|---|
0 |
Оплата не найдена или доступ запрещен | |
100 |
Не указан параметр id | |
0 |
Другие ошибки (например, фатальные ошибки) |

