Завершить продажу / Оплата сертификатом
const url = 'https://api-admin.billz.ai/v2/order-payment/example';const options = { method: 'POST', headers: { 'platform-id': '7d4a4c38-dd84-4902-b744-0488b80a4c01', Authorization: 'Bearer <token>', 'Content-Type': 'application/json' }, body: '{"payments":[{"company_payment_type_id":"c6e84d9b-0ef0-4d5a-886d-147c74a9b051","paid_amount":10000,"returned_amount":0},{"company_payment_type_id":"fe95ebe4-ae02-47d2-8d72-3c030a8a1035","paid_amount":100000,"returned_amount":0}],"comment":"test123","with_cashback":0,"without_cashback":false,"skip_ofd":false}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api-admin.billz.ai/v2/order-payment/example \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --header 'platform-id: 7d4a4c38-dd84-4902-b744-0488b80a4c01' \ --data '{ "payments": [ { "company_payment_type_id": "c6e84d9b-0ef0-4d5a-886d-147c74a9b051", "paid_amount": 10000, "returned_amount": 0 }, { "company_payment_type_id": "fe95ebe4-ae02-47d2-8d72-3c030a8a1035", "paid_amount": 100000, "returned_amount": 0 } ], "comment": "test123", "with_cashback": 0, "without_cashback": false, "skip_ofd": false }'Коды ошибок: 400 — ошибка валидации входных данных; 404 — объект не найден; 401, 403, 429, 500 — общие для всех методов. Форматы тела и семантика — Коды ответов и ошибки.
Authorizations
Заголовок раздела «Authorizations»Parameters
Заголовок раздела «Parameters»Path Parameters
Заголовок раздела «Path Parameters»Берётся из пути; значение из тела игнорируется
Header Parameters
Заголовок раздела «Header Parameters»Идентификатор платформы. Для интеграций используется статичное значение.
Request Bodyrequired
Заголовок раздела «Request Bodyrequired»object
Оплаты продажи. Минимально достаточно company_payment_type_id и paid_amount; сумма оплат должна совпадать с суммой продажи, иначе 400. Элементы: id, company_payment_type_id, payment_sub_type_id, payment_sub_type_name, company_payment_type{id,name,payment_type_id}, paid_amount, returned_amount, gift_card_id, is_certificate, is_voucher, is_ingenico, card_type, card_rrn, card_number, qr_payment_*, pptid, document_number, operation_id, stan, approval_code, ref_number, terminal_id, merchant_id и др.
object
Тип оплаты компании
Оплаченная сумма
Возвращённая сумма
Внутренний id подарочной карты
Сумма оплаты бонусами клиента
Не начислять кешбэк
Комментарий к продаже
Не отправлять чек в ОФД
Касса
Дата продажи
Элементы с полями payment_type_id, payment_type_name, amount
object
Идентификатор родительского заказа
Номер заказа
Имя поля именно order_integratons_info, с опечаткой
object
Признак предчека
Идентификатор терминала
Examples
{ "payments": [ { "company_payment_type_id": "c6e84d9b-0ef0-4d5a-886d-147c74a9b051", "paid_amount": 10000, "returned_amount": 0 }, { "company_payment_type_id": "fe95ebe4-ae02-47d2-8d72-3c030a8a1035", "paid_amount": 100000, "returned_amount": 0 } ], "comment": "test123", "with_cashback": 0, "without_cashback": false, "skip_ofd": false}{ "payments": [ { "company_payment_type_id": "429121de-a7ba-4a01-9e3d-d65999778816", "paid_amount": 125000 }, { "company_payment_type_id": "a89c2130-6083-4902-9493-100c31c3b559", "paid_amount": 10000, "gift_card_id": 4405184 } ]}Responses
Заголовок раздела «Responses»Успешный ответ
object
Тип продажи, например SALE
Нужно ли печатать чек
Examplegenerated
{ "order_type": "example", "should_print_cheque": true}