openapi: 3.2.0
info:
title: Raiffeisen Ru Fiscal Controller API
version: '1.1'
contact:
email: ecom@raiffeisen.ru
name: Support e-mail
x-team-id: 47
x-short-team-name: ASMEME
x-logo:
url: images/raifflogo.png
backgroundColor: '#FFFFFF'
altText: Raiff logo
description: 'Operations tagged fiscal-controller across 2 of this provider''s published API definitions: raiffeisen-ru-raif-pay-fiscal-openapi.json, raiffeisen-ru-raif-pay-fiscal-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://pay-test.raif.ru/api
description: Sandbox
- url: https://pay.raif.ru/api
description: Production
tags:
- name: fiscal-controller
x-displayName: Методы API
description: 'Для фискализации чеков через партнёра Райффайзенбанк предоставляет API из следующих запросов:
* Сохранение чека
* Регистрация чека
* Получение статуса чека
Взаимодействие осуществляется по протоколу HTTP с использованием методов POST, PUT, GET.'
paths:
/fiscal/v1/receipts/sell:
post:
tags:
- fiscal-controller
summary: Сохранение чека прихода
operationId: post-fiscal-v1-receipts-sell
description: 'Метод предназначен для создания нового чека прихода с указанным receiptNumber. Также позволяет обновить уже существующий чек прихода при повторном запросе с тем же receiptNumber. Метод возвращает тело чека, а также его тип и статус в дополнительных параметрах ответа.
Отправка чека по ФФД 1.2 не поддерживается для сервисов БИФИТ и Chekonline.
Отправка чека по ФФД 1.05 не поддерживается для сервиса Билайн.
Если Вы хотите перейти с ФФД 1.05 на ФФД 1.2, то отправьте заявку в поддержку ecom@raiffeisen.ru'
parameters:
- schema:
type: string
in: header
name: Authorization
description: '[Bearer secretKey](#tag/authorization)'
required: true
requestBody:
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/receiptWhiteLabel'
examples:
Чек прихода (ФФД 1.05):
value:
receiptNumber: '3000827351831'
orderNumber: order-2024_001
client:
email: customer@test.ru
name: Иванов Иван Иванович
items:
- name: Шоколадные конфеты
price: 1000
quantity: 1.2
amount: 1200
paymentObject: COMMODITY
paymentMode: FULL_PAYMENT
measurementUnit: кг
nomenclatureCode: 00 00 00 01 00 21 FA 41 00 23 05 41 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 12 00 AB 00
vatType: VAT20
total: 1200
Чек прихода по агентской операции (ФФД 1.05):
value:
receiptNumber: '3000827351832'
orderNumber: order-2024_002
client:
email: customer@test.ru
name: Иванов Иван Иванович
items:
- name: Шоколадные конфеты
price: 1000
quantity: 1.2
amount: 1200
paymentObject: COMMODITY
paymentMode: FULL_PAYMENT
measurementUnit: кг
nomenclatureCode: 00 00 00 01 00 21 FA 41 00 23 05 41 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 12 00 AB 00
vatType: VAT20
agentType: ANOTHER
supplierInfo:
phone: '+79991234567'
name: ООО «Ромашка»
inn: '287381373424'
total: 1200
Чек прихода (ФФД 1.2):
value:
receiptNumber: '3000827351833'
orderNumber: order-2024_003
client:
email: customer@test.ru
extra:
name: Иванов Иван Иванович
inn: '516974792202'
items:
- name: Шоколадный торт
price: 1200
quantity: 1
amount: 1200
paymentObject: COMMODITY_MARKING_WITH_CODE
paymentMode: FULL_PAYMENT
measurementUnit: PIECE
vatType: VAT20
agentType: ANOTHER
supplierInfo:
phone: '+79991234567'
name: ООО «Ромашка»
inn: '287381373424'
marking:
quantity:
numerator: 1
denominator: 3
code:
format: GS1M
value: MDEwNDYwNzQyODY3OTA5MDIxNmVKSWpvV0g1NERkVSA5MWZmZDAgOTJzejZrU1BpckFwZk1CZnR2TGJvRTFkbFdDLzU4aEV4UVVxdjdCQmtabWs0PQ==
plannedStatus: 1
total: 1200
responses:
'200':
description: OK
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/response'
examples:
Чек прихода (ФФД 1.05):
value:
receiptNumber: '3000827351831'
orderNumber: order-2024_001
receiptType: SELL
status: NEW
client:
email: customer@test.ru
name: Иванов Иван Иванович
items:
- name: Шоколадные конфеты
price: 1000
quantity: 1.2
amount: 1200
paymentObject: COMMODITY
paymentMode: FULL_PAYMENT
measurementUnit: кг
nomenclatureCode: 00 00 00 01 00 21 FA 41 00 23 05 41 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 12 00 AB 00
vatType: VAT20
total: 1200
Чек прихода по агентской операции (ФФД 1.05):
value:
receiptNumber: '3000827351832'
orderNumber: order-2024_002
receiptType: SELL
status: NEW
client:
email: customer@test.ru
name: Иванов Иван Иванович
items:
- name: Шоколадные конфеты
price: 1000
quantity: 1.2
amount: 1200
paymentObject: COMMODITY
paymentMode: FULL_PAYMENT
measurementUnit: кг
nomenclatureCode: 00 00 00 01 00 21 FA 41 00 23 05 41 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 12 00 AB 00
vatType: VAT20
agentType: ANOTHER
supplierInfo:
phone: '+79991234567'
name: ООО «Ромашка»
inn: '287381373424'
total: 1200
Чек прихода (ФФД 1.2):
value:
receiptNumber: '3000827351833'
orderNumber: order-2024_003
receiptType: SELL
status: NEW
client:
email: customer@test.ru
extra:
name: Иванов Иван Иванович
inn: '516974792202'
items:
- name: Шоколадные конфеты
price: 1200
quantity: 1
amount: 1200
paymentObject: COMMODITY_MARKING_WITH_CODE
paymentMode: FULL_PAYMENT
measurementUnit: PIECE
vatType: VAT20
agentType: ANOTHER
supplierInfo:
phone: '+79991234567'
name: ООО «Ромашка»
inn: '287381373424'
marking:
quantity:
numerator: 1
denominator: 3
code:
format: GS1M
value: MDEwNDYwNzQyODY3OTA5MDIxNmVKSWpvV0g1NERkVSA5MWZmZDAgOTJzejZrU1BpckFwZk1CZnR2TGJvRTFkbFdDLzU4aEV4UVVxdjdCQmtabWs0PQ
plannedStatus: 1
total: 1200
'400':
description: Bad Request
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/error'
examples:
'400':
value:
code: RECEIPT_VALIDATION_FAILED
message: 'Чек не прошел валидацию. Причина: {value}'
'403':
description: Forbidden
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/error'
examples:
'403':
value:
code: MERCHANT_NOT_FOUND
message: Мерчант с publicId = {value} не зарегистрирован в сервисе
'409':
description: Conflict
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/error'
examples:
'409':
value:
code: RECEIPT_STATUS_CONFLICT
message: Чек {value} в статусе {value}, действие невозможно
'415':
description: 'Unsupported Media Type.
Check content type in header parameters'
content:
application/json:
schema:
$ref: '#/components/schemas/415response'
examples:
Example 1:
value:
timestamp: '2023-02-15T06:36:32.418+00:00'
status: 415
error: Unsupported Media Type
path: string
deprecated: false
x-codeSamples:
- lang: cURL
source: "curl --location --request POST 'https://pay-test.raif.ru/api/fiscal/v1/receipts/sell' \\\n--header 'Content-Type: application/json;charset=UTF-8' \\\n--header 'Authorization: Bearer eyJ0eXA***' \\\n--data-raw'\n{\n \"receiptNumber\": \"3000827351831\",\n \"client\": {\n \"email\": \"customer@test.ru\",\n \"name\": \"Иванов Иван Иванович\"\n },\n \"items\": [\n {\n \"name\": \"Шоколадные конфеты\",\n \"price\": 600.00,\n \"quantity\": 2,\n \"amount\": 1200.00,\n \"paymentObject\": \"COMMODITY\",\n \"measurementUnit\": \"кг\",\n \"nomenclatureCode\": \"00 00 00 01 00 21 FA 41 00 23 05 41 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 12 00 AB 00\",\n \"vatType\": \"VAT20\"\n },\n {\n \"name\": \"Вода минеральная 1л\",\n \"price\": 120.00,\n \"quantity\": 20,\n \"amount\": 2400.00,\n \"paymentObject\": \"COMMODITY\",\n \"measurementUnit\": \"шт\",\n \"vatType\": \"VAT20\"\n }\n ],\n \"total\": 3600.00\n}'\n"
servers:
- url: https://pay-test.raif.ru/api
description: Sandbox
- url: https://pay.raif.ru/api
description: Production
/fiscal/v1/receipts/sell/{receiptNumber}:
parameters:
- schema:
type: string
maxLength: 99
in: path
name: receiptNumber
description: Уникальный номер чека
required: true
put:
tags:
- fiscal-controller
summary: Регистрация чека прихода
operationId: put-fiscal-v1-receipts-sell-receiptNumber
description: Метод предназначен для отправки чека прихода на регистрацию в ОФД. Метод возвращает тело чека, а также его тип и статус в дополнительных параметрах ответа. После отправки чека на регистрацию он будет недоступен для редактирования.
parameters:
- schema:
type: string
in: header
name: Authorization
description: '[Bearer secretKey](#tag/authorization)'
required: true
responses:
'200':
description: OK
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/response'
examples:
ФФД 1.05:
value:
receiptNumber: '3000827351831'
receiptType: SELL
status: IN_PROGRESS
client:
email: customer@test.ru
name: Иванов Иван Иванович
items:
- name: Шоколадные конфеты
price: 1200
quantity: 1
amount: 1200
paymentObject: COMMODITY
paymentMode: FULL_PAYMENT
measurementUnit: кг
nomenclatureCode: 00 00 00 01 00 21 FA 41 00 23 05 41 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 12 00 AB 00
vatType: VAT20
agentType: ANOTHER
supplierInfo:
phone: '+79991234567'
name: ООО «Ромашка»
inn: '287381373424'
total: 1200
ФФД 1.2:
value:
receiptNumber: '3000827351833'
receiptType: SELL
status: IN_PROGRESS
client:
email: customer@test.ru
extra:
name: Иванов Иван Иванович
inn: '516974792202'
items:
- name: Шоколадные конфеты
price: 1200
quantity: 1
amount: 1200
paymentObject: COMMODITY_MARKING_WITH_CODE
paymentMode: FULL_PAYMENT
measurementUnit: PIECE
vatType: VAT20
agentType: ANOTHER
supplierInfo:
phone: '+79991234567'
name: ООО «Ромашка»
inn: '287381373424'
marking:
quantity:
numerator: 1
denominator: 3
code:
format: GS1M
value: MDEwNDYwNzQyODY3OTA5MDIxNmVKSWpvV0g1NERkVSA5MWZmZDAgOTJzejZrU1BpckFwZk1CZnR2TGJvRTFkbFdDLzU4aEV4UVVxdjdCQmtabWs0PQ
plannedStatus: 1
total: 1200
'403':
description: Forbidden
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/error'
examples:
'403':
value:
code: MERCHANT_NOT_FOUND
message: Мерчант с publicId = {value} не зарегистрирован в сервисе
'404':
description: Not Found
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/error'
examples:
'404':
value:
code: RECEIPT_NOT_FOUND
message: Чек с id = {value} не найден
'409':
description: Conflict
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/error'
examples:
'409':
value:
code: RECEIPT_STATUS_CONFLICT
message: Чек {value} в статусе {value}, действие невозможно
'500':
description: Internal Server Error
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/error'
examples:
'500':
value:
code: RECEIPT_REGISTRATION_FAILED
message: Не удалось зарегистрировать чек {value}
deprecated: false
x-codeSamples:
- lang: cURL
source: 'curl --location --request PUT ''https://pay-test.raif.ru/api/fiscal/v1/receipts/sell/3000827351831'' \
--header ''Authorization: Bearer eyJ0eXA***''
'
get:
tags:
- fiscal-controller
summary: Получение статуса чека прихода
operationId: get-fiscal-v1-receipts-sell-receiptNumber
description: 'Метод предназначен для получения актуального статуса чека прихода. Чек может принимать один из статусов:
* "NEW" – чек создан и может быть отредактирован перед отправкой на регистрацию,
* "IN_PROGRESS" – чек в процессе регистрации,
* "DONE" – чек успешно зарегистрирован,
* "FAILED" – при регистрации чека возникла ошибка,
* "AWAITING" – чек в ожидании отправки на регистрацию (технический статус).'
parameters:
- schema:
type: string
in: header
name: Authorization
description: '[Bearer secretKey](#tag/authorization)'
required: true
responses:
'200':
description: OK
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/response'
examples:
ФФД 1.05:
value:
receiptNumber: '3000827351831'
orderNumber: order-2024_001
receiptType: SELL
status: DONE
client:
email: customer@test.ru
name: Иванов Иван Иванович
items:
- name: Шоколадные конфеты
price: 1000
quantity: 1.2
amount: 1200
paymentObject: COMMODITY
paymentMode: FULL_PAYMENT
measurementUnit: кг
nomenclatureCode: 00 00 00 01 00 21 FA 41 00 23 05 41 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 12 00 AB 00
vatType: VAT20
agentType: ANOTHER
supplierInfo:
phone: '+79991234567'
name: ООО «Ромашка»
inn: '287381373424'
total: 1200
ofdUrl: https://lk.platformaofd.ru/web/noauth/cheque?fn=7284440500012345&fp=1702712345&i=1234
ofdDocumentNumber: 133
ofdDocumentAttribute: '3449555941'
ofdShiftReceiptNumber: 1
ofdShiftNumber: 1
ФФД 1.2:
value:
receiptNumber: '3000827351833'
orderNumber: order-2024_003
receiptType: SELL
status: DONE
client:
email: customer@test.ru
extra:
name: Иванов Иван Иванович
inn: '516974792202'
items:
- name: Шоколадные конфеты
price: 1200
quantity: 1
amount: 1200
paymentObject: COMMODITY_MARKING_WITH_CODE
paymentMode: FULL_PAYMENT
measurementUnit: PIECE
vatType: VAT20
agentType: ANOTHER
supplierInfo:
phone: '+79991234567'
name: ООО «Ромашка»
inn: '287381373424'
marking:
quantity:
numerator: 1
denominator: 3
code:
format: GS1M
value: MDEwNDYwNzQyODY3OTA5MDIxNmVKSWpvV0g1NERkVSA5MWZmZDAgOTJzejZrU1BpckFwZk1CZnR2TGJvRTFkbFdDLzU4aEV4UVVxdjdCQmtabWs0PQ
plannedStatus: 1
total: 1200
ofdUrl: https://lk.platformaofd.ru/web/noauth/cheque?fn=7284440500012345&fp=1702712345&i=1234
ofdDocumentNumber: 133
ofdDocumentAttribute: '3449555941'
ofdShiftReceiptNumber: 1
ofdShiftNumber: 1
'403':
description: Forbidden
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/error'
examples:
'403':
value:
code: MERCHANT_NOT_FOUND
message: Мерчант с publicId = {value} не зарегистрирован в сервисе
'404':
description: Not Found
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/error'
examples:
'404':
value:
code: RECEIPT_NOT_FOUND
message: Чек с id = {value} не найден
deprecated: false
x-codeSamples:
- lang: cURL
source: 'curl --location --request GET ''https://pay-test.raif.ru/api/fiscal/v1/receipts/sell/3000827351831'' \
--header ''Authorization: Bearer eyJ0eXA***''
'
servers:
- url: https://pay-test.raif.ru/api
description: Sandbox
- url: https://pay.raif.ru/api
description: Production
/fiscal/v1/receipts/refund:
post:
tags:
- fiscal-controller
summary: Сохранение чека возврата
operationId: post-fiscal-v1-receipts-refund
description: 'Метод предназначен для создания нового чека возврата с указанным receiptNumber. Также позволяет обновить уже существующий чек возврата при повторном запросе с тем же receiptNumber. Метод возвращает тело чека, а также его тип и статус в дополнительных параметрах ответа.
Отправка чека по ФФД 1.2 не поддерживается для сервисов БИФИТ, Orange Data и Chekonline.
Отправка чека по ФФД 1.05 не поддерживается для сервиса Билайн.
Если Вы хотите перейти с ФФД 1.05 на ФФД 1.2, то отправьте заявку в поддержку ecom@raiffeisen.ru'
parameters:
- schema:
type: string
in: header
name: Authorization
description: '[Bearer secretKey](#tag/authorization)'
required: true
requestBody:
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/receiptWhiteLabel'
examples:
Чек возврата (ФФД 1.05):
value:
receiptNumber: '3000827351831'
orderNumber: order-2024_001
client:
email: customer@test.ru
name: Иванов Иван Иванович
items:
- name: Шоколадные конфеты
price: 1000
quantity: 1.2
amount: 1200
paymentObject: COMMODITY
paymentMode: FULL_PAYMENT
measurementUnit: кг
nomenclatureCode: 00 00 00 01 00 21 FA 41 00 23 05 41 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 12 00 AB 00
vatType: VAT20
total: 1200
Чек возврата по агентской операции (ФФД 1.05):
value:
receiptNumber: '3000827351832'
orderNumber: order-2024_002
client:
email: customer@test.ru
name: Иванов Иван Иванович
items:
- name: Шоколадные конфеты
price: 1000
quantity: 1.2
amount: 1200
paymentObject: COMMODITY
paymentMode: FULL_PAYMENT
measurementUnit: кг
nomenclatureCode: 00 00 00 01 00 21 FA 41 00 23 05 41 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 12 00 AB 00
vatType: VAT20
agentType: ANOTHER
supplierInfo:
phone: '+79991234567'
name: ООО «Ромашка»
inn: '287381373424'
total: 1200
Чек возврата (ФФД 1.2):
value:
receiptNumber: '3000827351833'
orderNumber: order-2024_003
client:
email: customer@test.ru
extra:
name: Иванов Иван Иванович
inn: '516974792202'
items:
- name: Шоколадный торт
price: 1200
quantity: 1
amount: 1200
paymentObject: COMMODITY_MARKING_WITH_CODE
paymentMode: FULL_PAYMENT
measurementUnit: PIECE
vatType: VAT20
agentType: ANOTHER
supplierInfo:
phone: '+79991234567'
name: ООО «Ромашка»
inn: '287381373424'
marking:
quantity:
numerator: 1
denominator: 3
code:
format: GS1M
value: MDEwNDYwNzQyODY3OTA5MDIxNmVKSWpvV0g1NERkVSA5MWZmZDAgOTJzejZrU1BpckFwZk1CZnR2TGJvRTFkbFdDLzU4aEV4UVVxdjdCQmtabWs0PQ==
plannedStatus: 3
total: 1200
responses:
'200':
description: OK
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/response'
examples:
Чек возврата (ФФД 1.05):
value:
receiptNumber: '3000827351831'
orderNumber: order-2024_001
receiptType: REFUND
status: NEW
client:
email: customer@test.ru
name: Иванов Иван Иванович
items:
- name: Шоколадные конфеты
price: 1000
quantity: 1.2
amount: 1200
paymentObject: COMMODITY
paymentMode: FULL_PAYMENT
measurementUnit: кг
nomenclatureCode: 00 00 00 01 00 21 FA 41 00 23 05 41 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 12 00 AB 00
vatType: VAT20
total: 1200
Чек возврата по агентской операции (ФФД 1.05):
value:
receiptNumber: '3000827351832'
orderNumber: order-2024_002
receiptType: REFUND
status: NEW
client:
email: customer@test.ru
name: Иванов Иван Иванович
items:
- name: Шоколадные конфеты
price: 1000
quantity: 1.2
amount: 1200
paymentObject: COMMODITY
paymentMode: FULL_PAYMENT
measurementUnit: кг
nomenclatureCode: 00 00 00 01 00 21 FA 41 00 23 05 41 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 12 00 AB 00
vatType: VAT20
agentType: ANOTHER
supplierInfo:
phone: '+79991234567'
name: ООО «Ромашка»
inn: '287381373424'
total: 1200
Чек возврата (ФФД 1.2):
value:
receiptNumber: '3000827351833'
orderNumber: order-2024_003
receiptType: REFUND
status: NEW
client:
email: customer@test.ru
extra:
name: Иванов Иван Иванович
inn: '516974792202'
items:
- name: Шоколадные конфеты
price: 1200
quantity: 1
amount: 1200
paymentObject: COMMODITY_MARKING_WITH_CODE
paymentMode: FULL_PAYMENT
measurementUnit: PIECE
vatType: VAT20
agentType: ANOTHER
supplierInfo:
phone: '+79991234567'
name: ООО «Ромашка»
inn: '287381373424'
marking:
quantity:
numerator: 1
denominator: 3
code:
format: GS1M
value: MDEwNDYwNzQyODY3OTA5MDIxNmVKSWpvV0g1NERkVSA5MWZmZDAgOTJzejZrU1BpckFwZk1CZnR2TGJvRTFkbFdDLzU4aEV4UVVxdjdCQmtabWs0PQ
plannedStatus: 3
total: 1200
'400':
description: Bad Request
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/error'
examples:
'400':
value:
code: RECEIPT_VALIDATION_FAILED
message: 'Чек не прошел валидацию. Причина: {value}'
'403':
description: Forbidden
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/error'
examples:
'403':
value:
code: MERCHANT_NOT_FOUND
message: Мерчант с publicId = {value} не зарегистрирован в сервисе
'409':
description: Conflict
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/error'
examples:
'409':
value:
code: RECEIPT_STATUS_CONFLICT
message: Чек {value} в статусе {value}, действие невозможно
'415':
description: 'Unsupported Media Type.
Check content type in header parameters'
content:
application/json:
schema:
$ref: '#/components/schemas/415response'
examples:
Example 1:
value:
timestamp: '2023-02-15T06:36:32.418+00:00'
status: 415
error: Unsupported Media Type
path: string
deprecated: false
x-codeSamples:
- lang: cURL
source: "curl --location --request POST 'https://pay-test.raif.ru/api/fiscal/v1/receipts/refund' \\\n--header 'Content-Type: application/json;charset=UTF-8' \\\n--header 'Authorization: Bearer eyJ0eXA***' \\\n--data-raw'\n{\n \"receiptNumber\": \"3000827351831\",\n \"client\": {\n \"email\": \"customer@test.ru\",\n \"name\": \"Иванов Иван Иванович\"\n },\n \"items\": [\n {\n \"name\": \"Шоколадные конфеты\",\n \"price\": 600.00,\n \"quantity\": 2,\n \"amount\": 1200.00,\n \"paymentObject\": \"COMMODITY\",\n \"measurementUnit\": \"кг\",\n \"nomenclatureCode\": \"00 00 00 01 00 21 FA 41 00 23 05 41 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 12 00 AB 00\",\n \"vatType\": \"VAT20\"\n },\n {\n \"name\": \"Вода минеральная 1л\",\n \"price\": 120.00,\n \"quantity\": 20,\n \"amount\": 2400.00,\n \"paymentObject\": \"COMMODITY\",\n \"measurementUnit\": \"шт\",\n \"vatType\": \"VAT20\"\n }\n ],\n \"total\": 3600.00\n}'\n"
servers:
- url: https://pay-test.raif.ru/api
description: Sandbox
- url: https://pay.raif.ru/api
description: Production
/fiscal/v1/receipts/refund/{receiptNumber}:
parameters:
- schema:
type: string
maxLength: 99
in: path
name: receiptNumber
description: Уникальный номер чека
required: true
put:
tags:
- fiscal-controller
summary: Регистрация чека возврата
operationId: put-fiscal-v1-receipts-refund-receiptNumber
description: Метод предназначен для отправки чека возврата на регистрацию в ОФД. Метод возвращает тело чека, а также его тип и статус в дополнительных параметрах ответа. После отправки чека на регистрацию он будет недоступен для редактирования.
parameters:
- schema:
type: string
in: header
name: Authorization
description: '[Bearer secretKey](#tag/authorization)'
required: true
responses:
'200':
description: OK
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/response'
examples:
ФФД 1.05:
value:
receiptNumber: '3000827351831'
receiptType: REFUND
status: IN_PROGRESS
client:
email: customer@test.ru
name: Иванов Иван Иванович
items:
- name: Шоколадные конфеты
price: 1000
quantity: 1.2
amount: 1200
paymentObject: COMMODITY
paymentMode: FULL_PAYMENT
measurementUnit: кг
nomenclatureCode: 00 00 00 01 00 21 FA 41 00 23 05 41 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 12 00 AB 00
vatType: VAT20
agentType: ANOTHER
supplierInfo:
phone: '+79991234567'
name: ООО «Ромашка»
inn: '287381373424'
total: 1200
ФФД 1.2:
value:
receiptNumber: '3000827351833'
receiptType: REFUND
status: IN_PROGRESS
client:
email: customer@test.ru
extra:
name: Иванов Иван Иванович
inn: '516974792202'
items:
- name: Шоколадные конфеты
price: 1200
quantity: 1
amount: 1200
paymentObject: COMMODITY_MARKING_WITH_CODE
paymentMode: FULL_PAYMENT
measurementUnit: PIECE
vatType: VAT20
agentType: ANOTHER
supplierInfo:
phone: '+79991234567'
name: ООО «Ромашка»
inn: '287381373424'
marking:
quantity:
numerator: 1
denominator: 3
code:
format: GS1M
value: MDEwNDYwNzQyODY3OTA5MDIxNmVKSWpvV0g1NERkVSA5MWZmZDAgOTJzejZrU1BpckFwZk1CZnR2TGJvRTFkbFdDLzU4aEV4UVVxdjdCQmtabWs0PQ
plannedStatus: 3
total: 1200
'403':
description: Forbidden
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/error'
examples:
'403':
value:
code: MERCHANT_NOT_FOUND
message: Мерчант с publicId = {value} не зарегистрирован в сервисе
'404':
description: Not Found
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/error'
examples:
'404':
value:
code: RECEIPT_NOT_FOUND
message: Чек с id = {value} не найден
'409':
description: Conflict
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/error'
examples:
'409':
value:
code: RECEIPT_STATUS_CONFLICT
message: Чек {value} в статусе {value}, действие невозможно
'500':
description: Internal Server Error
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/error'
examples:
'500':
value:
code: RECEIPT_REGISTRATION_FAILED
message: Не удалось зарегистрировать чек {value}
deprecated: false
x-codeSamples:
- lang: cURL
source: 'curl --location --request PUT ''https://pay-test.raif.ru/api/fiscal/v1/receipts/refund/3000827351831'' \
--header ''Authorization: Bearer eyJ0eXA***''
'
get:
tags:
- fiscal-controller
summary: Получение статуса чека возврата
operationId: get-fiscal-v1-receipts-refund-receiptNumber
description: 'Метод предназначен для получения актуального статуса чека возврата. Чек может принимать один из статусов:
* "NEW" – чек создан и может быть отредактирован перед отправкой на регистрацию,
* "IN_PROGRESS" – чек в процессе регистрации,
* "DONE" – чек успешно зарегистрирован,
* "FAILED" – при регистрации чека возникла ошибка,
* "AWAITING" – чек в ожидании отправки на регистрацию (технический статус).'
parameters:
- schema:
type: string
name: Authorization
in: header
description: '[Bearer secretKey](#tag/authorization)'
required: true
responses:
'200':
description: OK
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/response'
examples:
ФФД 1.05:
value:
receiptNumber: '3000827351831'
orderNumber: order-2024_001
receiptType: REFUND
status: DONE
client:
email: customer@test.ru
name: Иванов Иван Иванович
items:
- name: Шоколадные конфеты
price: 1000
quantity: 1.2
amount: 1200
paymentObject: COMMODITY
paymentMode: FULL_PAYMENT
measurementUnit: кг
nomenclatureCode: 00 00 00 01 00 21 FA 41 00 23 05 41 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 12 00 AB 00
vatType: VAT20
agentType: ANOTHER
supplierInfo:
phone: '+79991234567'
name: ООО «Ромашка»
inn: '287381373424'
total: 1200
ofdUrl: https://lk.platformaofd.ru/web/noauth/cheque?fn=7284440500012345&fp=1702712345&i=1234
ofdDocumentNumber: 133
ofdDocumentAttribute: '3449555941'
ofdShiftReceiptNumber: 1
ofdShiftNumber: 1
ФФД 1.2:
value:
receiptNumber: '3000827351833'
orderNumber: order-2024_003
receiptType: REFUND
status: DONE
client:
email: customer@test.ru
extra:
name: Иванов Иван Иванович
inn: '516974792202'
items:
- name: Шоколадные конфеты
price: 1200
quantity: 1
amount: 1200
paymentObject: COMMODITY_MARKING_WITH_CODE
paymentMode: FULL_PAYMENT
measurementUnit: PIECE
vatType: VAT20
agentType: ANOTHER
supplierInfo:
phone: '+79991234567'
name: ООО «Ромашка»
inn: '287381373424'
marking:
quantity:
numerator: 1
denominator: 3
code:
format: GS1M
value: MDEwNDYwNzQyODY3OTA5MDIxNmVKSWpvV0g1NERkVSA5MWZmZDAgOTJzejZrU1BpckFwZk1CZnR2TGJvRTFkbFdDLzU4aEV4UVVxdjdCQmtabWs0PQ
plannedStatus: 3
total: 1200
ofdUrl: https://lk.platformaofd.ru/web/noauth/cheque?fn=7284440500012345&fp=1702712345&i=1234
ofdDocumentNumber: 133
ofdDocumentAttribute: '3449555941'
ofdShiftReceiptNumber: 1
ofdShiftNumber: 1
'403':
description: Forbidden
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/error'
examples:
'403':
value:
code: MERCHANT_NOT_FOUND
message: Мерчант с publicId = {value} не зарегистрирован в сервисе
'404':
description: Not Found
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/error'
examples:
'404':
value:
code: RECEIPT_NOT_FOUND
message: Чек с id = {value} не найден
deprecated: false
x-codeSamples:
- lang: cURL
source: 'curl --location --request GET ''https://pay-test.raif.ru/api/fiscal/v1/receipts/refund/3000827351831'' \
--header ''Authorization: Bearer eyJ0eXA***''
'
servers:
- url: https://pay-test.raif.ru/api
description: Sandbox
- url: https://pay.raif.ru/api
description: Production
components:
schemas:
additionalUserProperty:
type: object
required:
- name
- value
description: '`Тег ФФД — 1084`
Дополнительный реквизит пользователя'
x-description-i18n:
eng: '`The tag FDF — 1084`
Additional user property'
properties:
name:
type: string
description: '`Тег ФФД — 1085`
Наименование дополнительного реквизита пользователя'
x-description-i18n:
eng: '`The tag FDF — 1085`
Additional user property name'
maxLength: 64
value:
type: string
description: '`Тег ФФД — 1086`
Значение дополнительного реквизита пользователя'
x-description-i18n:
eng: '`The tag FDF — 1086`
Additional user property value'
maxLength: 256
receiptWhiteLabel:
title: ФФД 1.05 / ФФД 1.2
type: object
required:
- receiptNumber
- client
- items
- total
properties:
receiptNumber:
type: string
description: Уникальный номер чека
format: A-Za-z0-9_-
maxLength: 99
example: '3000827351831'
orderNumber:
type: string
description: Номер заказа мерчанта в системе Raif Pay, используется для связывания заказа и чека. Возвращается в ответе, если был передан при создании чека.
pattern: ^[A-Za-z0-9_-]{1,200}$
maxLength: 40
example: order-2024_001
timezone:
type: string
description: '`Тег ФФД — 1011`
Часовая зона (+02:00, +03:00... +11:00). Только для ФФД 1.2'
onlinePayment:
type: boolean
description: '`Тег ФФД — 1125`
Признак расчета в Интернете'
client:
type: object
required:
- email
description: Данные о покупателе
properties:
email:
type: string
description: '`Тег ФФД — 1008`
Электронный адрес покупателя для отправки чека. Заполняется по формату E-mail'
maxLength: 64
example: customer@test.ru
name:
type: string
description: '`Тег ФФД — 1227`
ФИО покупателя'
maxLength: 256
example: Иванов Иван Иванович
inn:
type: string
description: '`Тег ФФД — 1228`
ИНН покупателя. Может содержать только 10 или 12 цифр'
pattern: ^(?:[0-9]{10}|[0-9]{12})$
example: '7707083893'
extra:
type: object
description: Дополнительная информация о покупателе
Объект свободного наполнения, передается в ОФД без изменений. Если Вам необходимо передать доп. данные покупателя в extra, то сверьтесь с протоколом Вашего ОФД
items:
type: array
uniqueItems: true
minItems: 1
description: Позиции чека
items:
$ref: '#/components/schemas/receiptItem'
payments:
type: array
uniqueItems: true
minItems: 1
description: Данные об оплате
Объект заполняется только для чеков с зачетом аванса или частичной предоплаты. Если чек содержит только безналичный вид оплаты (без зачета аванса/частичной предоплаты), то объект payments не заполняется.
Если payments не передан, то по умолчанию заполняется безналичным видом оплаты и ее суммой, которая равна сумме чека
x-description-i18n:
eng: Payment types info. Object must be passed only for receipts that include prepaid amount (either advance or partial prepayment receipts)
If null, then value E_PAYMENT is set by default, with the total receipt amount
items:
$ref: '#/components/schemas/payments'
total:
type: number
description: '`Тег ФФД — 1020`
Итоговая сумма чека в рублях. Допустимо 8 символов для целой части и 2 символа для дробной'
example: 1200
additionalUserProperty:
$ref: '#/components/schemas/additionalUserProperty'
415response:
title: 415response
type: object
x-examples:
Example 1:
timestamp: '2023-02-15T06:36:32.418+00:00'
status: 415
error: Unsupported Media Type
path: string
properties:
timestamp:
type: string
description: Время ответа сервиса
x-description-i18n:
eng: Response timestamp
status:
type: integer
description: Код состояния HTTP-запроса
x-description-i18n:
eng: HTTP-code
error:
type: string
description: Описание ошибки
x-description-i18n:
eng: Response description
path:
type: string
description: Путь запроса
x-description-i18n:
eng: Query path
response:
title: ФФД 1.05 | ФФД 1.2
type: object
properties:
receiptNumber:
type: string
description: Уникальный номер чека
maxLength: 99
format: A-Za-z0-9_-
example: '3000827351831'
orderNumber:
type: string
description: Номер заказа мерчанта в системе Raif Pay, используется для связывания заказа и чека. Возвращается в ответе, если был передан при создании чека.
pattern: ^[A-Za-z0-9_-]{1,200}$
maxLength: 40
example: order-2024_001
receiptType:
type: string
description: Тип чека (чек прихода, чек возврата)
enum:
- SELL
- REFUND
example: SELL
status:
type: string
description: Статус регистрации чека
enum:
- NEW
- IN_PROGRESS
- DONE
- FAILED
- AWAITING
example: NEW
timezone:
type: string
description: '`Тег ФФД — 1011`
Часовая зона (+02:00, +03:00... +11:00)'
onlinePayment:
type: boolean
description: '`Тег ФФД — 1125`
Признак расчета в Интернете'
client:
type: object
description: Данные о покупателе
properties:
email:
type: string
description: '`Тег ФФД — 1008`
Электронный адрес покупателя для отправки чека'
maxLength: 64
example: customer@test.ru
name:
type: string
description: '`Тег ФФД — 1227`
ФИО покупателя'
maxLength: 256
example: Иванов Иван Иванович
inn:
type: string
description: '`Тег ФФД — 1228`
ИНН покупателя. Может содержать только 10 или 12 цифр'
pattern: ^(?:[0-9]{10}|[0-9]{12})$
example: '7707083893'
extra:
type: object
description: Дополнительная информация о покупателе
items:
type: array
uniqueItems: true
minItems: 1
description: Позиции чека
items:
$ref: '#/components/schemas/receiptItem'
payments:
type: array
uniqueItems: true
description: Данные об оплате. Объект payments возвращается в ответе, если ранее был передан в запросе
items:
$ref: '#/components/schemas/payments'
total:
type: number
description: '`Тег ФФД — 1020`
Итоговая сумма чека в рублях'
example: 1200
additionalUserProperty:
$ref: '#/components/schemas/additionalUserProperty'
ofdUrl:
type: string
description: Ссылка на чек
Передается в ответе только для чеков в статусе DONE и при условии, что была получена от ОФД при регистрации чека. Список ОФД, которые поддерживают передачу ссылки на чек, необходимо уточнять у поставщика онлайн-кассы
example: https://lk.platformaofd.ru/web/noauth/cheque?fn=7284440500012345&fp=1702712345&i=1234
ofdDocumentNumber:
type: number
description: '`Тег ФФД — 1040`
Фискальный номер документа'
example: 133
ofdDocumentAttribute:
type: string
description: '`Тег ФФД — 1077`
Фискальный признак документа'
example: '3449555941'
ofdShiftReceiptNumber:
type: number
description: '`Тег ФФД — 1042`
Номер чека в смене'
example: 1
ofdShiftNumber:
type: number
description: '`Тег ФФД — 1038`
Номер смены'
example: 1
error:
type: object
properties:
code:
type: string
description: Код ошибки
minLength: 1
example: RECEIPT_VALIDATION_FAILED
message:
type: string
description: Описание ошибки
minLength: 1
example: 'Чек не прошел валидацию. Причина: {value}'
title: error
payments:
type: object
title: платежи
x-title-i18n:
eng: payments
required:
- type
- amount
description: Данные об оплате и ее видах
x-description-i18n:
eng: Info on payment and its types
properties:
type:
type: string
description: Вид оплаты. Возможные значения:
• E_PAYMENT – безналичная оплата
• PREPAID – предварительная оплата (зачет аванса и/или предыдущих платежей)
x-description-i18n:
eng: Payment type. Valid values:
• E_PAYMENT – electronic payment
• PREPAID – prepaid amount (advance payment and/or previous payments)
example: PREPAID
enum:
- E_PAYMENT
- PREPAID
amount:
type: number
description: '`Тег ФФД — 1081. Сумма по чеку безналичными`
`Тег ФФД — 1251. Сумма по чеку предоплатой (зачетом аванса и(или) предыдущих платежей)`
Сумма оплаты
Сумма всех переданных amount должна равняться итоговой сумме чека'
x-description-i18n:
eng: '`The tag FDF — 1081. Receipt amount non-cash payment`
`The tag FDF — 1251. Receipt amount prepayment (advance payment and(or) previous payment)`
Amount paid'
example: 1200
receiptItem:
type: object
title: ФФД 1.05 | ФФД 1.2
properties:
name:
type: string
maxLength: 128
description: '`Тег ФФД — 1030`
Наименование товара, работы, услуги, иного предмета расчета'
x-description-i18n:
eng: '`The tag FDF — 1030`
Name of goods, work, service, other payment objects'
example: Шоколадный торт
price:
type: number
description: '`Тег ФФД — 1079`
Цена за единицу товара, работы, услуги, иного предмета расчета в рублях (8 символов на целую часть, 2 на дробную)'
x-description-i18n:
eng: '`The tag FDF — 1079`
Price per unit of goods, work, services, other payment objects in rubles (8 characters for a whole part, 2 for a fractional part)'
example: 1200
quantity:
type: number
description: '`Тег ФФД — 1023`
Количество/вес (5 символов на целую часть, 3 на дробную)'
x-description-i18n:
eng: '`The tag FDF — 1023`
Quantity / weight (5 characters for a whole part, 3 for a fractional part)'
example: 1
amount:
type: number
description: '`Тег ФФД — 1043`
Сумма в рублях. Должна равняться произведению цены на количество (price * quantity). 8 символов на целую часть, 2 на дробную'
x-description-i18n:
eng: '`The tag FDF — 1023`
Amount in rubles. Must be equal to price * quantity (8 characters for a whole part, 2 for a fractional part)'
example: 1200
paymentObject:
type: string
description: '`Тег ФФД — 1212`
Признак предмета расчёта. Возможные значения:
• COMMODITY – товар, который не является подакцизным и не подлежит маркировке (ФФД 1.05 и ФФД 1.2)
• EXCISE – подакцизный товар, который не подлежит маркировке (ФФД 1.05 и ФФД 1.2)
• JOB – работа (ФФД 1.05 и ФФД 1.2)
• SERVICE – услуга (ФФД 1.05 и ФФД 1.2)
• PAYMENT – платеж (ФФД 1.05 и ФФД 1.2)
• ANOTHER – иной предмет расчета (ФФД 1.05 и ФФД 1.2)
• COMMODITY_MARKING_NO_CODE – товар, который не является подакцизным, подлежит маркировке, но не имеет кода маркировки (ФФД 1.2)
• COMMODITY_MARKING_WITH_CODE – товар, который не является подакцизным, подлежит маркировке и имеет код маркировки (ФФД 1.2)
• EXCISE_MARKING_NO_CODE – подакцизный товар, который подлежит маркировке, но не имеет кода маркировки (ФФД 1.2)
• EXCISE_MARKING_WITH_CODE – подакцизный товар, который подлежит маркировке и имеет код маркировки (ФФД 1.2)
Для авансовых чеков и чеков частичной предоплаты должен заполняться значением PAYMENT. Если параметр не передан, то заполняется значением COMMODITY по умолчанию'
x-description-i18n:
eng: '`The tag FDF — 1212`
Payment object type. Valid values:
• COMMODITY – good (FFD 1.05 and FFD 1.2)
• EXCISE – excisable good (FFD 1.05 and FFD 1.2)
• JOB – job (FFD 1.05 and FFD 1.2)
• SERVICE – service (FFD 1.05 and FFD 1.2)
• PAYMENT – payment (FFD 1.05 and FFD 1.2)
• ANOTHER – another payment object (FFD 1.05 and FFD 1.2)
• COMMODITY_MARKING_NO_CODE – marked good that has no marking code (FFD 1.2)
• COMMODITY_MARKING_WITH_CODE – marked good that has a marking code (FFD 1.2)
• EXCISE_MARKING_NO_CODE – excisable good that has no marking code (FFD 1.2)
• EXCISE_MARKING_WITH_CODE – excisable good that has a marking code (FFD 1.2)
For advance payments and prepayments value PAYMENT must be passed. If null, value COMMODITY will be set by default'
enum:
- COMMODITY
- EXCISE
- JOB
- SERVICE
- PAYMENT
- ANOTHER
- COMMODITY_MARKING_NO_CODE
- COMMODITY_MARKING_WITH_CODE
- EXCISE_MARKING_NO_CODE
- EXCISE_MARKING_WITH_CODE
example: COMMODITY_MARKING_WITH_CODE
paymentMode:
type: string
description: '`Тег ФФД — 1214`
Способ расчета. Возможные значения:
• FULL_PREPAYMENT – 100% предоплата до момента передачи предмета расчета
• FULL_PAYMENT – полная оплата в момент передачи предмета расчета
• ADVANCE – аванс
• PREPAYMENT – частичная предоплата до момента передачи предмета расчета
• CREDIT – Передача в кредит
• CREDIT_PAYMENT – Оплата кредита
Если параметр не передан, по умолчанию устанавливается значение FULL_PREPAYMENT'
x-description-i18n:
eng: '`The tag FDF — 1214`
Payment mode. Valid values:
• FULL_PREPAYMENT – 100% prepayment
• FULL_PAYMENT – full payment
• ADVANCE – advance payment
• PREPAYMENT – partial prepayment
• CREDIT – credit
• CREDIT_PAYMENT – credit payment
If null, the value FULL_PREPAYMENT is set dy default'
enum:
- FULL_PREPAYMENT
- FULL_PAYMENT
- ADVANCE
- PREPAYMENT
- CREDIT
- CREDIT_PAYMENT
example: FULL_PREPAYMENT
measurementUnit:
type: string
description: '`Тег ФФД — 2108`
Единица измерения товара, работы, услуги, иного предмета расчета.
Для ФФД 1.05 передавать строковое значение до 16 символов включительно.
Для ФФД 1.2 передавать значения из списка:
• PIECE – штука/единица/дробный товар
• GRAM – грамм
• KILOGRAM – килограмм
• TON – тонна
• CENTIMETER – сантиметр
• DECIMETER – дециметр
• METER – метр
• SQUARE_CENTIMETER – кв. сантиметр
• SQUARE_DECIMETER – кв. дециметр
• SQUARE_METER – кв. метр
• MILLILITER – миллилитр
• LITER – литр
• CUBIC_METER – куб. метр
• KILOWATT_HOUR – киловатт-час
• GIGACALORIE – гигакалория
• DAY – сутки/день
• HOUR – час
• MINUTE – минута
• SECOND – секунда
• KILOBYTE – килобайт
• MEGABYTE – мегабайт
• GIGABYTE – гигабайт
• TERABYTE – терабайт
• OTHER – иное
Если передано значение не из списка выше, то в ОФД автоматически будет передано OTHER
'
x-description-i18n:
eng: '`The tag FDF — 2108`
Unit of measurement of goods, work, services, other payment objects
If FFD 1.05, string value up to 16 symbols has to be passed.
If FFD 1.2, value from the list is accepted:
• PIECE – a piece
• GRAM – gram
• KILOGRAM – kilogram
• TON – ton
• CENTIMETER – centimeter
• DECIMETER – decimeter
• METER – meter
• SQUARE_CENTIMETER – sq. centimeter
• SQUARE_DECIMETER – sq. decimeter
• SQUARE_METER – sq. meter
• MILLILITER – milliliter
• LITER – liter
• CUBIC_METER – c. meter
• KILOWATT_HOUR – kilowatt-hour
• GIGACALORIE – gigacalorie
• DAY – day or 24 hours
• HOUR – an hour
• MINUTE – a minute
• SECOND – a second
• KILOBYTE – a kilobyte
• MEGABYTE – a megabyte
• GIGABYTE – a gigabyte
• TERABYTE – a terabyte
• OTHER – other
If passed value in off the list, value OTHER will passed automatically to OFD'''
example: PIECE
nomenclatureCode:
type: string
description: '`Тег ФФД — 1162`
Номенклатурный код товара в 16-ричном представлении с пробелами или в формате GS1 DataMatrix. Только для ФФД 1.05.
Примеры: ''''00 00 00 01 00 21 FA 41 00 23 05 41 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 12 00 AB 00'''' или ''''010463003407001221CMK45BrhN0WLf''''
Если вы используете БИФИТ или Чек-Онлайн, номенклатурный код должен быть передан строго в 16-ричном представлении с пробелами. Если LIFE PAY или Эвотор – строго в формате GS1 DataMatrix'
x-description-i18n:
eng: '`The tag FDF — 1162`
Product code in hexadecimal divided by spaces or in GS1 DataMatrix format. For FFD 1.05 only.
For example, "00 00 00 01 00 21 FA 41 00 23 05 41 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 12 00 AB 00" or "010463003407001221CMK45BrhN0WLf"
If you use BIFIT or Chekonline, the nomenclature code must be passed strictly in hexadecimal (hex) notation with spaces.
If you use LIFE PAY or Evotor, the nomenclature code must be passed strictly in GS1 DataMatrix format'
pattern: ^([a-fA-F0-9]{2}$)|(^([a-fA-F0-9]{2}\s){1,31}[a-fA-F0-9]{2}|01(?\d{14})21(?[a-zA-Z0-9!" % &'()*+\/\-.,:;=<>?_]{13})([a-zA-Z0-9!" % &'()*+\/\- .,:;=<>?_]{1,119})?|(?\d{14})(?[a-zA-Z0-9!" %&'()*+\/\-.,:;=<>?_]{11})[a-zA-Z0-9!" %&'()*+\/\-.,:;=<>?_]{4})$
maxLength: 150
example: 00 00 00 01 00 21 FA 41 00 23 05 41 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 12 00 AB 00
vatType:
type: string
description: '`Тег ФФД — 1199`
Ставка НДС на позицию чека. Возможные значения:
• NONE – без НДС
• VAT0 – НДС по ставке 0%
• VAT10 – НДС чека по ставке 10%
• VAT110 – НДС чека по расчетной ставке 10/110
• VAT20 – НДС чека по ставке 20%
• VAT120 – НДС чека по расчетной ставке 20/120
• VAT5 – НДС чека по ставке 5%
• VAT105 – НДС чека по расчетной ставке 5/105
• VAT7 – НДС чека по ставке 7%
• VAT107 – НДС чека по расчетной ставке 7/107
• VAT22 – НДС чека по ставке 22%
• VAT122 – НДС чека по расчетной ставке 22/122'
x-description-i18n:
eng: '`The tag FDF — 1199`
VAT rate on each receipt item. Valid values:
• NONE – no VAT
• VAT0 – 0% VAT
• VAT10 – 10% VAT
• VAT110 – 10/110 VAT
• VAT20 – 20% VAT
• VAT120 – 20/120 VAT
• VAT5 – 5% VAT
• VAT105 – 5/105 VAT
• VAT7 – 7% VAT
• VAT107 – 7/107 VAT
• VAT22 – 22% VAT
• VAT122 – 22/122 VAT'
enum:
- NONE
- VAT0
- VAT10
- VAT110
- VAT20
- VAT120
- VAT5
- VAT105
- VAT7
- VAT107
- VAT22
- VAT122
example: VAT20
agentType:
type: string
description: '`Тег ФФД — 1222`
Признак агента по предмету расчета. Опциональный параметр, который заполняется только для операций через агента. Возможные значения:
• BANK_PAYING_AGENT – банковский платежный агент
• BANK_PAYING_SUBAGENT – банковский платежный субагент
• PAYING_AGENT – платежный агент
• PAYING_SUBAGENT – платежный субагент
• ATTORNEY – поверенный
• COMMISSION_AGENT – комиссионер
• ANOTHER – другой тип агента'
x-description-i18n:
eng: '`The tag FDF — 1222`
Agent type. Optional parameter which is required for agent operations only.
Valid values:
• BANK_PAYING_AGENT – bank paying agent
• BANK_PAYING_SUBAGENT – bank paying subagent
• PAYING_AGENT – paying agent
• PAYING_SUBAGENT – paying subagent
• ATTORNEY – attorney
• COMMISSION_AGENT – commission agent
• «ANOTHER» – another agent type'
enum:
- BANK_PAYING_AGENT
- BANK_PAYING_SUBAGENT
- PAYING_AGENT
- PAYING_SUBAGENT
- ATTORNEY
- COMMISSION_AGENT
- ANOTHER
example: ANOTHER
supplierInfo:
type: object
description: Данные о поставщике. Обязательно к заполнению, если заполнен параметр agentType
x-description-i18n:
eng: Supplier information. Required if agentType is filled in
properties:
phone:
type: string
description: '`Тег ФФД — 1171`
Телефон поставщика. Заполняется по формату "+79991234567", после кода +7 должно быть указано 10 цифр'
x-description-i18n:
eng: '`The tag FDF — 1171`
Supplier phone number. Filled in with Russian country code in format "+79991234567". The country code +7 must be followed by 10 digits'
format: +7XXXXXXXXXX
example: '+79991234567'
name:
type: string
description: '`Тег ФФД — 1225`
Наименование поставщика'
x-description-i18n:
eng: '`The tag FDF — 1225`
Supplier name'
example: ООО «Ромашка»
inn:
type: string
description: '`Тег ФФД — 1226`
ИНН поставщика. Может содержать только цифры в количестве 10 или 12 символов'
x-description-i18n:
eng: '`The tag FDF — 1226`
Supplier tax code of 10 or 12 digits'
maxLength: 12
example: '287381373424'
required:
- inn
marking:
type: object
description: 'Данные маркировки. Только для ФФД 1.2
Обязательно к заполнению, если предметом расчета является маркированный товар, который имеет код маркировки''
'
x-description-i18n:
eng: 'Marking data. Relevant for FFD 1.2 only
Must be passed for marked goods that have marking codes
'
properties:
quantity:
type: object
description: '`Тег ФФД — 1291`
Дробное количество маркированного товара
Обязательно к заполнению, если предметом расчета является дробный маркированный товар, который имеет код маркировки.
В таком случае параметр measurementUnit должен иметь значение PIECE
'
x-description-i18n:
eng: '`The tag FDF — 1291`
Fractional amount of marking goods
Must be passed for marked goods that have marking codes. If so, value PIECE must be passed in measurementUnit
'
properties:
numerator:
type: integer
description: '`Тег ФФД — 1293`
Числитель дробной части'
x-description-i18n:
eng: '`The tag FDF — 1293`
Fraction numerator'
example: 1
denominator:
type: integer
description: '`Тег ФФД — 1294`
Знаменатель дробной части'
x-description-i18n:
eng: '`The tag FDF — 1294`
Fraction denominator'
example: 3
required:
- numerator
- denominator
code:
type: object
description: Код маркировки
x-description-i18n:
eng: Marking code data
required:
- format
- value
properties:
format:
type: string
description: Формат кода маркировки
x-description-i18n:
eng: Marking code format
enum:
- UNKNOWN
- EAN8
- EAN13
- ITF14
- GS1M
- SHORT
- FUR
- EGAIS20
- EGAIS30
example: GS1M
value:
type: string
description: '`Тег ФФД — 1300. Нераспознанный код товара`
`Тег ФФД — 1301. КТ EAN-8`
`Тег ФФД — 1302. КТ EAN-13`
`Тег ФФД — 1303. КТ ITF-14`
`Тег ФФД — 1305. КТ GS1.М`
`Тег ФФД — 1306. КТ КМК, (SHORT)`
`Тег ФФД — 1307. КТ Меховые изделия, (FUR)`
`Тег ФФД — 1308. КТ ЕГАИС-3.0, (EGAIS20)`
`Тег ФФД — 1309. КТ ЕГАИС-3.0, (EGAIS30)`
Код маркировки. Должен соответствовать формату, переданному в параметре format'
x-description-i18n:
eng: '`The tag FDF — 1300. Undefined item code`
`The tag FDF — 1301. Item code EAN-8`
`The tag FDF — 1302. Item code EAN-13`
`The tag FDF — 1303. Item code ITF-14`
`The tag FDF — 1305. Item code GS1.М`
`The tag FDF — 1306. Item code SHORT`
`The tag FDF — 1307. Item code FUR`
`The tag FDF — 1308. Item code EGAIS20`
`The tag FDF — 1309. Item code EGAIS30`
Marking code. Value must match the format'
example: MDEwNDYwNzQyODY3OTA5MDIxNmVKSWpvV0g1NERkVSA5MWZmZDAgOTJzejZrU1BpckFwZk1CZnR2TGJvRTFkbFdDLzU4aEV4UVVxdjdCQmtabWs0PQ==
plannedStatus:
type: integer
minimum: 1
maximum: 6
description: '`Тег 2003 — планируемый статус маркированного торвара`
Только маркировок вида GS1M и SHORT
1 - Штучный товар, подлежащий обязательной маркировке
средством идентификации, реализован
2 - Мерный товар, подлежащий обязательной маркировке
средством идентификации, в стадии реализации
3 - Штучный товар, подлежащий обязательной маркировке
средством идентификации, возвращен
4 - Часть товара, подлежащего обязательной маркировке
средством идентификации, возвращена
5 - Штучный товар, подлежащий обязательной маркировке
средством идентификации, в стадии реализации
6 - Мерный товар, подлежащий обязательной маркировке
средством идентификации, реализован
'
required:
- code
sectoralProperties:
type: array
minItems: 1
maxItems: 5
description: '`Тег ФФД — 1260`
Отраслевые реквизиты предмета расчета. Только для ФФД 1.2
Большинство ОФД поддерживают обработку только 1 элемента в массиве. Если Вам необходимо передавать более 1 элемента в массиве, то сверьтесь с протоколом Вашего ОФД
'
x-description-i18n:
eng: '`The tag FDF — 1260`
Sectoral properties. Relevant for FFD 1.2 only
Most OFD support processing of only 1 element in an array. If you need to transfer more than 1 element in an array, then check with the protocol of your OFD
'
items:
type: object
properties:
federalId:
type: string
description: '`Тег ФФД — 1262`
Идентификатор Федерального органа исполнительной власти. Должно принимать одно из значений справочника в соответствии с [приказом ФНС России](https://www.nalog.gov.ru/rn77/about_fts/docs/10020801/)'
x-description-i18n:
eng: '`The tag FDF — 1262`
Identifier of the Federal Executive Authority. Must take one of the directory values in accordance with [the order of the Federal Tax Service of Russia](https://www.nalog.gov.ru/rn77/about_fts/docs/10020801/)'
example: '030'
documentDate:
type: string
format: date
description: '`Тег ФФД — 1263`
Дата нормативного акта федерального органа исполнительной власти, регламентирующего порядок заполнения поля «значение отраслевого реквизита»'
x-description-i18n:
eng: '`The tag FDF — 1263`
Date of the normative act of the federal executive body regulating the procedure for filling in the field "value of the sectoral property"'
example: '2023-11-21'
documentNumber:
type: string
description: '`Тег ФФД — 1264`
Номер нормативного акта федерального органа исполнительной власти, регламентирующего порядок заполнения поля «значение отраслевого реквизита»'
x-description-i18n:
eng: '`The tag FDF — 1264`
Number of the normative act of the federal executive body, regulating the procedure for filling in the field "value of the sectoral property"'
example: '1944'
value:
type: string
description: '`Тег ФФД — 1265`
Значение отраслевого реквизита. Заполнение регламентируется нормативным актом федерального органа исполнительной власти'
x-description-i18n:
eng: '`The tag FDF — 1265`
The value of the sectoral property. Filling is regulated by the normative act of the federal executive authority'
example: UUID=2ce10bdb-6515-4d37-be04-dd475b98c728&Time=1692691702067
required:
- federalId
- documentDate
- documentNumber
- value
required:
- name
- price
- quantity
- amount
- vatType
x-refined-from:
- raiffeisen-ru-raif-pay-fiscal-openapi.json
- raiffeisen-ru-raif-pay-fiscal-openapi.yml