openapi: 3.2.0 info: title: Raiffeisen Ru Order API x-refined-note: - x-logo differs across the merged source definitions and was not carried version: '1.0' description: 'Operations tagged Order across 4 of this provider''s published API definitions: raiffeisen-ru-agency-factoring-openapi.yml, raiffeisen-ru-raif-pay-sbp-b2b-openapi.json, raiffeisen-ru-agency-factoring-openapi.yml, raiffeisen-ru-raif-pay-sbp-b2b-openapi.yml. Each path carries the servers of the definition it was published in.' servers: - url: https://api.raiffeisen.ru/payables-financing - url: https://pay-test.raif.ru description: Sandbox - url: https://pay.raif.ru description: Production tags: - description: Поручение name: Order paths: /v1/orders/search: post: description: Метод получение списка поручений по фильтрам operationId: getOrders requestBody: content: application/json: examples: full: summary: Запрос на получение списка поручений по фильтрам value: creditorNameOrInn: рОмаШкА packetIds: - bf1d1868-a98e-4ae5-976f-0c4e21e0d510 - bf1d1868-a98e-4ae5-976f-0c4e21e0d512 sorting: - orderBy: DESC sortBy: MATURITY_DATE - orderBy: DESC sortBy: MATURITY_DATE dateTo: '2021-07-10' statuses: - AWAITING_FUNDING - FINANCED paging: offset: 1 limit: 10 packetNumbers: - 03032020-1 - 03032020-2 agreementNumber: АФ-1 dateFrom: '2021-07-10' schema: $ref: '#/components/schemas/GetOrderRequest' required: true responses: '200': content: application/json: examples: simple: summary: Несколько поручений value: orders: - orderType: COMMON cqrsVersion: -1628796591 executionDate: '2025-01-01' creditorRequisites: ogrn: '123456789012345' inn: '1234567890' kpp: '123456789' fullNameRus: АО Ромашка packet: number: 2025-04-01-111 ordersCount: 2 financedSum: '100.11' cqrsVersion: -1628796591 packetSum: 100.11 id: bf1d1868-a98e-4ae5-976f-0c4e21e0d510 state: statusDate: '2021-07-10T06:53:37.433111Z' errors: [] status: ACCEPTED_BY_BANK packetDate: '2025-01-01' referenceId: '32121313213' financedDate: '2025-01-01' orderSum: 1111.11 referenceId: 1111-2222-3333 maturityDate: '2025-01-01' paymentRequisites: purpose: Оплата по контракту 111111 от 31.12.2021 correspondentAccount: '30101810200000000700' recipientBankName: АО «Райффайзенбанк» bic: '044525700' account: '40702810200001430012' creditor: ogrn: '123456789012345' cqrsVersion: -1628796591 inn: '1234567890' kpp: '123456789' id: bf1d1868-a98e-4ae5-976f-0c4e21e0d510 state: statusDate: '2021-07-10T06:53:37.433111Z' errors: [] status: REJECTED fullNameRus: АО Ромашка payment: date: '2025-04-01' number: 125 id: bf1d1868-a98e-4ae5-976f-0c4e21e0d510 debtSum: 55.55 state: statusDate: '2021-07-10T06:53:37.433111Z' errors: - code: ERR_1002 message: Creditor not valid - code: ERR_1006 message: Exceed maximum limit status: REJECTED orderDate: '2025-01-01' currencyCode: RUB - orderType: TAX cqrsVersion: -1628796591 executionDate: '2025-01-01' creditorRequisites: ogrn: '123456789012345' inn: '1234567890' kpp: '123456789' fullNameRus: АО Ромашка packet: number: 2025-04-01-111 ordersCount: 2 financedSum: '100.11' cqrsVersion: -1628796591 packetSum: 100.11 id: bf1d1868-a98e-4ae5-976f-0c4e21e0d510 state: statusDate: '2021-07-10T06:53:37.433111Z' errors: [] status: ACCEPTED_BY_BANK packetDate: '2025-01-01' referenceId: '132131323' financedDate: '2025-01-01' orderSum: 1111.11 referenceId: 1111-2222-3333 maturityDate: '2025-01-01' paymentRequisites: purpose: Оплата по контракту 111111 от 31.12.2021 correspondentAccount: '30101810200000000700' recipientBankName: АО «Райффайзенбанк» bic: '044525700' account: '40702810200001430012' creditor: ogrn: '123456789012345' cqrsVersion: -1628796591 inn: '1234567890' kpp: '123456789' id: bf1d1868-a98e-4ae5-976f-0c4e21e0d510 state: statusDate: '2021-07-10T06:53:37.433111Z' errors: [] status: APPROVED fullNameRus: АО Ромашка payment: date: '2025-04-01' number: 125 id: bf1d1868-a98e-4ae5-976f-0c4e21e0d510 debtSum: 55.55 state: statusDate: '2021-07-10T06:53:37.433111Z' errors: [] status: FINANCED taxRequisites: kppPayer: '770801001' docNumberPaymentReason: '0' taxPayerStatus: '01' oktmo: '63701000' paymentReason: '0' taxPeriod: '0' cbc: '18200000000000000000' docDatePaymentReason: '0' receiverName: Казначейство России (ФНС России) uin: '1820996623340000000000000' orderDate: '2025-01-01' currencyCode: RUB totalCount: 10 offset: 1 limit: 10 schema: $ref: '#/components/schemas/OrderPageResponse' description: OK '400': content: application/json: examples: simple: value: - code: REST_ERR_5001 message: General service error traceId: 29bda8ca-4d33-11ec-81d3-0242ac130000 schema: $ref: '#/components/schemas/ErrorResponse' description: BAD_REQUEST '401': $ref: '#/components/responses/Unauthorized' '500': $ref: '#/components/responses/InternalError' summary: Получение списка поручений по фильтрам tags: - Order parameters: - $ref: '#/components/parameters/AuthorizationHeader' - $ref: '#/components/parameters/IdTokenHeader' servers: - url: https://api.raiffeisen.ru/payables-financing /v1/orders/{id}: get: description: Метод получения поручения по идентификатору operationId: getOrderById parameters: - description: Идентификатор поручения in: path name: id required: true schema: example: 76b44414-8259-4a09-b4dd-dbe33e0a1729 format: uuid type: string - $ref: '#/components/parameters/IdTokenHeader' - $ref: '#/components/parameters/AuthorizationHeader' responses: '200': content: application/json: examples: common: summary: Поручение контрагенту value: orderType: COMMON cqrsVersion: -1628796591 executionDate: '2025-01-01' creditorRequisites: ogrn: '123456789012345' inn: '1234567890' kpp: '123456789' fullNameRus: АО Ромашка packet: number: 2025-04-01-111 ordersCount: 2 financedSum: '100.11' cqrsVersion: -1628796591 packetSum: 100.11 id: bf1d1868-a98e-4ae5-976f-0c4e21e0d510 state: statusDate: '2021-07-10T06:53:37.433111Z' errors: [] status: ACCEPTED_BY_BANK packetDate: '2025-01-01' referenceId: '123456' financedDate: '2025-01-01' orderSum: 1111.11 referenceId: 1111-2222-3333 maturityDate: '2025-01-01' paymentRequisites: purpose: Оплата по контракту 111111 от 31.12.2021 correspondentAccount: '30101810200000000700' recipientBankName: АО «Райффайзенбанк» bic: '044525700' account: '40702810200001430012' creditor: ogrn: '123456789012345' cqrsVersion: -1628796591 inn: '1234567890' kpp: '123456789' id: bf1d1868-a98e-4ae5-976f-0c4e21e0d510 state: statusDate: '2021-07-10T06:53:37.433111Z' errors: [] status: APPROVED fullNameRus: АО Ромашка payment: date: '2025-04-01' number: 125 id: bf1d1868-a98e-4ae5-976f-0c4e21e0d510 debtSum: 55.55 state: statusDate: '2021-07-10T06:53:37.433111Z' errors: [] status: FINANCED orderDate: '2025-01-01' currencyCode: RUB tax: summary: Поручение в налоговую value: orderType: TAX cqrsVersion: -1628796591 executionDate: '2025-01-01' creditorRequisites: ogrn: '123456789012345' inn: '1234567890' kpp: '123456789' fullNameRus: АО Ромашка packet: number: 2025-04-01-111 ordersCount: 2 financedSum: '100.11' cqrsVersion: -1628796591 packetSum: 100.11 id: bf1d1868-a98e-4ae5-976f-0c4e21e0d510 state: statusDate: '2021-07-10T06:53:37.433111Z' errors: [] status: ACCEPTED_BY_BANK packetDate: '2025-01-01' referenceId: '123456' financedDate: '2025-01-01' orderSum: 1111.11 referenceId: 1111-2222-3333 maturityDate: '2025-01-01' paymentRequisites: purpose: Оплата по контракту 111111 от 31.12.2021 correspondentAccount: '30101810200000000700' recipientBankName: АО «Райффайзенбанк» bic: '044525700' account: '40702810200001430012' creditor: ogrn: '123456789012345' cqrsVersion: -1628796591 inn: '1234567890' kpp: '123456789' id: bf1d1868-a98e-4ae5-976f-0c4e21e0d510 state: statusDate: '2021-07-10T06:53:37.433111Z' errors: [] status: APPROVED fullNameRus: АО Ромашка payment: date: '2025-04-01' number: 125 id: bf1d1868-a98e-4ae5-976f-0c4e21e0d510 debtSum: 55.55 state: statusDate: '2021-07-10T06:53:37.433111Z' errors: [] status: FINANCED taxRequisites: kppPayer: '770801001' docNumberPaymentReason: '0' taxPayerStatus: '01' oktmo: '63701000' paymentReason: '0' taxPeriod: '0' cbc: '18200000000000000000' docDatePaymentReason: '0' receiverName: Казначейство России (ФНС России) uin: '1820996623340000000000000' orderDate: '2025-01-01' currencyCode: RUB schema: $ref: '#/components/schemas/OrderResponse' description: OK '400': content: application/json: examples: simple: value: - code: REST_ERR_5001 message: General service error traceId: 29bda8ca-4d33-11ec-81d3-0242ac130000 schema: $ref: '#/components/schemas/ErrorResponse' description: BAD_REQUEST '401': $ref: '#/components/responses/Unauthorized' '500': $ref: '#/components/responses/InternalError' summary: Получение поручения по идентификатору tags: - Order servers: - url: https://api.raiffeisen.ru/payables-financing /v1/orders/total-debt: get: description: Метод получение общей суммы долга по договору operationId: getTotalDebt parameters: - description: Идентификатор договора in: query name: agreementId required: true schema: example: bf1d1868-a98e-4ae5-976f-0c4e21e0d510 format: uuid type: string - $ref: '#/components/parameters/IdTokenHeader' - $ref: '#/components/parameters/AuthorizationHeader' responses: '200': content: application/json: examples: simple: summary: Долг присутствует value: totalDebt: '100.11' overDebt: '100.11' maturityTodayDebt: '100.11' schema: $ref: '#/components/schemas/OrderTotalDebtResponse' description: OK '400': content: application/json: examples: simple: value: - code: REST_ERR_5001 message: General service error traceId: 29bda8ca-4d33-11ec-81d3-0242ac130000 schema: $ref: '#/components/schemas/ErrorResponse' description: BAD_REQUEST '401': $ref: '#/components/responses/Unauthorized' '500': $ref: '#/components/responses/InternalError' summary: Получение общей суммы долга по договору tags: - Order servers: - url: https://api.raiffeisen.ru/payables-financing /v1/orders/{id}/payment-orders/report: get: description: Метод получения файла с платежным поручением в формате pdf без подписи со стороны банка operationId: getPaymentOrderReport parameters: - description: Идентификатор поручения in: path name: id required: true schema: example: 123e4567-e89b-12d3-a456-426614174000 format: uuid type: string - $ref: '#/components/parameters/IdTokenHeader' - $ref: '#/components/parameters/AuthorizationHeader' responses: '200': content: application/pdf: schema: format: binary type: string description: OK '400': content: application/json: examples: simple: value: - code: REST_ERR_5001 message: General service error traceId: 29bda8ca-4d33-11ec-81d3-0242ac130000 schema: $ref: '#/components/schemas/ErrorResponse' description: BAD_REQUEST '401': $ref: '#/components/responses/Unauthorized' '500': $ref: '#/components/responses/InternalError' summary: Получение файла с платежным поручением в формате pdf tags: - Order head: description: Метод получения размера файла с платежным поручением в формате pdf без подписи со стороны банка operationId: getPaymentOrderReportSize parameters: - description: Идентификатор поручения explode: false in: path name: id required: true schema: example: 123e4567-e89b-12d3-a456-426614174000 format: uuid type: string style: simple - $ref: '#/components/parameters/IdTokenHeader' - $ref: '#/components/parameters/AuthorizationHeader' responses: '200': description: OK headers: Content-Disposition: examples: simple: value: report.pdf schema: example: report.pdf type: string Content-Length: examples: simple: value: 1000000 schema: example: 1000000 type: integer '400': content: application/json: examples: simple: value: - code: REST_ERR_5001 message: General service error traceId: 29bda8ca-4d33-11ec-81d3-0242ac130000 schema: $ref: '#/components/schemas/ErrorResponse' description: BAD_REQUEST '401': $ref: '#/components/responses/Unauthorized' '500': $ref: '#/components/responses/InternalError' summary: Получение размера файла с платежным поручением в формате pdf tags: - Order servers: - url: https://api.raiffeisen.ru/payables-financing /v1/orders/payment-orders/reports: head: description: Method of obtaining the size of the archive with payment orders without a signature from the bank operationId: getPaymentOrdersReportSize requestBody: content: application/json: examples: multiple: summary: Запрос на получение архива с платежными поручениями value: ids: - 29bda8ca-4d33-11ec-81d3-0242ac130000 - bf1d1868-a98e-4ae5-976f-0c4e21e0d510 schema: $ref: '#/components/schemas/GetPaymentOrdersReportArchiveRequest' description: Идентификаторы поручений, которые выбрал клиент required: true responses: '200': description: OK headers: Content-Disposition: examples: simple: value: reports.zip schema: example: reports.zip type: string Content-Length: examples: simple: value: 1000000 schema: example: 1000000 type: integer '400': content: application/json: examples: simple: value: - code: REST_ERR_5001 message: General service error traceId: 29bda8ca-4d33-11ec-81d3-0242ac130000 schema: $ref: '#/components/schemas/ErrorResponse' description: BAD_REQUEST '401': $ref: '#/components/responses/Unauthorized' '500': $ref: '#/components/responses/InternalError' summary: Получение размера архива с платежными поручениями в формате pdf tags: - Order parameters: - $ref: '#/components/parameters/AuthorizationHeader' - $ref: '#/components/parameters/IdTokenHeader' post: description: Метод получения архива с платежными поручениями без подписи со стороны банка operationId: getPaymentOrdersReport requestBody: content: application/json: examples: multiple: summary: Запрос на получение архива с платежным поручением value: ids: - 29bda8ca-4d33-11ec-81d3-0242ac130000 - bf1d1868-a98e-4ae5-976f-0c4e21e0d510 schema: $ref: '#/components/schemas/GetPaymentOrdersReportArchiveRequest' description: Идентификаторы поручений, которые выбрал клиент required: true responses: '200': content: application/zip: schema: format: binary type: string description: OK '400': content: application/json: examples: simple: value: - code: REST_ERR_5001 message: General service error traceId: 29bda8ca-4d33-11ec-81d3-0242ac130000 schema: $ref: '#/components/schemas/ErrorResponse' description: BAD_REQUEST '401': $ref: '#/components/responses/Unauthorized' '500': $ref: '#/components/responses/InternalError' summary: Получение архива с платежными поручениями в формате pdf tags: - Order parameters: - $ref: '#/components/parameters/AuthorizationHeader' - $ref: '#/components/parameters/IdTokenHeader' servers: - url: https://api.raiffeisen.ru/payables-financing /api/b2b/sbp/v1/orders: post: tags: - Order summary: Создание заказа x-raif-api-summary-en: Create Order operationId: createDynamicPaymentLink security: - BearerAuth: [] parameters: [] x-raif-api-service: system requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateOrderRequestDto' examples: count_of_minutes: $ref: '#/components/examples/CreateOrderRequestDtoCountOfMinutes' without_restriction: $ref: '#/components/examples/CreateOrderRequestDtoWithoutRestriction' with_restriction: $ref: '#/components/examples/CreateOrderRequestDtoWithRestriction' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateOrderResponseDto' examples: without_restrictions: $ref: '#/components/examples/CreateOrderResponseDtoWithOutRestrictions' with_restrictions: $ref: '#/components/examples/CreateOrderResponseDtoWithRestrictions' '400': $ref: '#/components/responses/BadRequest' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' servers: - url: https://pay-test.raif.ru description: Sandbox - url: https://pay.raif.ru description: Production /api/b2b/sbp/v1/qrs/{qrId}/image: parameters: - $ref: '#/components/parameters/QrId' get: tags: - Order summary: Генерация изображения платёжной ссылки operationId: getQrImage parameters: - $ref: '#/components/parameters/QrId' - $ref: '#/components/parameters/Format' - $ref: '#/components/parameters/WithLogo' responses: '200': description: OK content: application/xml: schema: type: string format: byte servers: - url: https://pay-test.raif.ru description: Sandbox - url: https://pay.raif.ru description: Production /api/b2b/sbp/v1/orders/{id}: get: tags: - Order summary: Данные заказа operationId: getOrderPaymentLinkInfo security: - BearerAuth: [] parameters: - $ref: '#/components/parameters/OrderIdWithoutGenerating' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/OrderInfoResponseDto' examples: without_restrictions: $ref: '#/components/examples/OrderInfoResponseDtoWithoutRestrictions' active: $ref: '#/components/examples/OrderInfoResponseDtoActive' paid: $ref: '#/components/examples/OrderInfoResponseDtoPaid' expired: $ref: '#/components/examples/OrderInfoResponseDtoExpired' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' delete: tags: - Order summary: Отмена заказа operationId: deleteOrder security: - BearerAuth: [] parameters: - $ref: '#/components/parameters/OrderIdWithoutGenerating' description: Метод позволяет отменить неоплаченный заказ. После отмены оплата заказа с текущим id будет недоступна. Но вы можете переиспользовать этот id для создания нового заказа responses: '204': description: No Content '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' servers: - url: https://pay-test.raif.ru description: Sandbox - url: https://pay.raif.ru description: Production webhooks: IncomingPayment: post: summary: Уведомление о входящем платеже заказа operationId: sendIncomingPaymentCallback tags: - Order responses: '200': description: Вернуть статус 200, чтобы указать, что данные были успешно получены requestBody: content: application/json: schema: $ref: '#/components/schemas/IncomingPaymentCallbackDto' servers: - url: https://pay-test.raif.ru description: Sandbox - url: https://pay.raif.ru description: Production components: schemas: RestErrorCodes: description: '| code | description | |-----------------|--------------------------------------------| | REST_ERR_5001 | General service error | | REST_ERR_5040 | Tax is not available | | REST_ERR_5041 | Incorrect format of taxpayer status | | REST_ERR_5042 | Incorrect format of KPP payer''s | | REST_ERR_5043 | Incorrect format of UIN | | REST_ERR_5044 | Incorrect format of CBC | | REST_ERR_5045 | Incorrect format of OKTMO | | REST_ERR_5046 | Incorrect format of payment reason | | REST_ERR_5047 | Incorrect format of tax period | | REST_ERR_5048 | Incorrect format of the payment reason document number | | REST_ERR_5049 | Incorrect format of the payment reason document date | | REST_ERR_5050 | Incorrect format of receiver name | | REST_ERR_5051 | Incorrect format of purpose | ' enum: - REST_ERR_5001 - REST_ERR_5040 - REST_ERR_5041 - REST_ERR_5042 - REST_ERR_5043 - REST_ERR_5044 - REST_ERR_5045 - REST_ERR_5046 - REST_ERR_5047 - REST_ERR_5048 - REST_ERR_5049 - REST_ERR_5050 - REST_ERR_5051 example: REST_ERR_5001 type: string ErrorMessage: example: code: REST_ERR_5001 message: General service error traceId: 29bda8ca-4d33-11ec-81d3-0242ac130000 properties: code: $ref: '#/components/schemas/RestErrorCodes' message: description: Сообщение example: General service error type: string traceId: description: traceId example: 29bda8ca-4d33-11ec-81d3-0242ac130000 type: string required: - code - message - traceId type: object CreditorStatus: description: Статус кредитора enum: - FETCHED - SENT_TO_CHECK - APPROVED - REJECTED example: APPROVED type: string OrderStatus: description: Статус поручения enum: - AWAITING_FUNDING - REJECTED - FINANCED - REPAID - PARTIALLY_REPAID - FINANCED_OVERDUE - REPAID_OVERDUE - PARTIAL_REPAID_OVERDUE - AWAITING_REPAY - RETURNED example: FINANCED type: string GetOrderRequest: example: agreementNumber: АФ-1 packetIds: - 2c44306f-fc96-4780-9b37-6447273b190e - bf1d1868-a98e-4ae5-976f-0c4e21e0d510 packetNumbers: - 03032020-1 - 03032020-2 statuses: - AWAITING_FUNDING - FINANCED dateFrom: '2025-01-01' dateTo: '2025-01-01' creditorNameOrInn: рОмаШкА paging: offset: 0 limit: 10 sorting: - orderBy: DESC sortBy: MATURITY_DATE properties: agreementNumber: description: Номер договора example: АФ-1 type: string packetIds: description: Идентификаторы реестров example: - 2c44306f-fc96-4780-9b37-6447273b190e - bf1d1868-a98e-4ae5-976f-0c4e21e0d510 items: example: 2c44306f-fc96-4780-9b37-6447273b190e format: uuid type: string type: array packetNumbers: description: Номера реестров example: - 03032020-1 - 03032020-2 items: allOf: - example: 03032020-1 type: string type: array statuses: description: Статусы поручений example: - AWAITING_FUNDING - FINANCED items: $ref: '#/components/schemas/OrderStatus' type: array dateFrom: description: Дата поручения example: '2025-01-01' format: date type: string dateTo: description: Дата поручения example: '2025-01-01' format: date type: string creditorNameOrInn: description: Наименование или ИНН кредитора example: рОмаШкА type: string paging: $ref: '#/components/schemas/PaginationRequest' sorting: description: Сортировки example: - orderBy: DESC sortBy: MATURITY_DATE items: $ref: '#/components/schemas/SortingOrder' type: array type: object PacketResponse: description: Реестр поручений example: id: 2c44306f-fc96-4780-9b37-6447273b190e referenceId: 2c44306f-fc96-4780-9b37-6447273b190e number: 2025-04-01-111 packetDate: '2025-01-01' financedDate: '2025-01-01' packetSum: 100.11 ordersCount: 2 financedSum: '100.11' state: statusDate: '2025-07-10T06:53:37.433211' errors: [] status: ACCEPTED_BY_BANK cqrsVersion: -1628796591 properties: id: description: Идентификатор пакета example: 2c44306f-fc96-4780-9b37-6447273b190e format: uuid type: string referenceId: description: Идентификатор реестра поручений клиента, если реестр загружен через API example: 2c44306f-fc96-4780-9b37-6447273b190e type: string number: description: Номер реестра поручений example: 2025-04-01-111 type: string packetDate: description: Дата реестра поручений example: '2025-01-01' format: date type: string financedDate: description: Максимальный executionDate из исполненных поручений example: '2025-01-01' format: date type: string packetSum: description: Сумма реестра example: 100.11 type: number ordersCount: description: Количество поручений example: 2 type: integer financedSum: description: Сумма финансирования example: '100.11' type: string state: allOf: - $ref: '#/components/schemas/PacketState' description: Состояние пакета example: statusDate: '2025-07-10T06:53:37.433211' errors: [] status: ACCEPTED_BY_BANK type: object cqrsVersion: description: hashCode от state - состояния реестра example: -1628796591 type: integer required: - cqrsVersion - id - number - packetDate - referenceId - state type: object ErrorResponse: description: Список ошибок example: - code: REST_ERR_5001 message: General service error traceId: 29bda8ca-4d33-11ec-81d3-0242ac130000 items: $ref: '#/components/schemas/ErrorMessage' type: array GetPaymentOrdersReportArchiveRequest: example: ids: - 2c44306f-fc96-4780-9b37-6447273b190e - bf1d1868-a98e-4ae5-976f-0c4e21e0d510 properties: ids: description: Индентфиикаторы поручений example: - 2c44306f-fc96-4780-9b37-6447273b190e - bf1d1868-a98e-4ae5-976f-0c4e21e0d510 items: example: 2c44306f-fc96-4780-9b37-6447273b190e format: uuid type: string type: array type: object OrderType: description: Тип поручения. TAX - в налоговую, COMMON - контрагенту enum: - TAX - COMMON example: COMMON type: string Error: example: code: ERR_1001 message: General service error properties: code: $ref: '#/components/schemas/ErrorCodes' message: description: Сообщение example: General service error type: string traceId: description: traceId example: 29bda8ca-4d33-11ec-81d3-0242ac130000 type: string required: - code - message type: object OrderPageResponse: allOf: - properties: orders: description: Поручения items: $ref: '#/components/schemas/OrderResponse' type: array type: object - $ref: '#/components/schemas/PaginationResponse' example: orders: - id: 2c44306f-fc96-4780-9b37-6447273b190e referenceId: 1111-2222-3333 creditorRequisites: ogrn: '123456789012345' inn: '1234567890' kpp: '123456789' fullNameRus: АО Ромашка paymentRequisites: purpose: Оплата по контракту 111111 от 31.12.2021 correspondentAccount: '30101810200000000700' recipientBankName: АО «Райффайзенбанк» bic: '044525700' account: '40702810200001430012' orderType: COMMON orderDate: '2025-01-01' maturityDate: '2025-01-01' executionDate: '2025-01-01' orderSum: 1111.11 debtSum: 55.55 currencyCode: RUB state: statusDate: '2025-07-10T06:53:37.433211' errors: [] status: FINANCED cqrsVersion: -1628796591 offset: 0 limit: 10 totalCount: 100 type: object CreditorRequisites: description: Реквизиты кредитора example: fullNameRus: АО Ромашка inn: '1234567890' ogrn: '123456789012345' kpp: '123456789' properties: fullNameRus: description: Полное наименование кредитора example: АО Ромашка type: string inn: description: ИНН кредитора example: '1234567890' maxLength: 12 minLength: 10 type: string ogrn: description: ОГРН кредитора example: '123456789012345' maxLength: 15 minLength: 13 type: string kpp: description: КПП кредитора example: '123456789' maxLength: 9 minLength: 9 type: string required: - fullNameRus - inn - ogrn type: object PaginationRequest: description: Параметры пагинации example: offset: 0 limit: 10 properties: offset: description: Количество элементов для сдвига example: 1 type: integer limit: description: Ограничение элементов example: 10 type: integer required: - limit - offset type: object TaxRequisites: description: Налоговые реквизиты example: taxPayerStatus: '01' kppPayer: '770801001' uin: '1820996623340000000000000' cbc: '18200000000000000000' oktmo: '63701000' paymentReason: '0' taxPeriod: '0' docNumberPaymentReason: '0' docDatePaymentReason: '0' receiverName: Казначейство России (ФНС России) properties: taxPayerStatus: description: Статус налогоплательщика example: '01' type: string kppPayer: description: КПП плательщика example: '770801001' type: string uin: description: УИН (уникальный идентификатор начислений) example: '1820996623340000000000000' type: string cbc: description: КБК (код бюджетной классификации) example: '18200000000000000000' type: string oktmo: description: ОКТМО (Общероссийский классификатор территорий муниципальных образований) example: '63701000' type: string paymentReason: description: Основание платежа example: '0' type: string taxPeriod: description: Налоговый период example: '0' type: string docNumberPaymentReason: description: Номер документа основания платежа example: '0' type: string docDatePaymentReason: description: Дата документа основания платежа example: '0' type: string receiverName: description: Наименование получателя example: Казначейство России (ФНС России) type: string type: object PaginationResponse: example: offset: 0 limit: 10 totalCount: 100 properties: offset: description: Количество элементов для сдвига example: 1 type: integer limit: description: Итоговое количество элементов example: 10 type: integer totalCount: description: Общее количество элементов example: 100 type: integer required: - limit - offset - totalCount type: object OrderResponse: allOf: - properties: id: description: Идентификатор поручения example: 2c44306f-fc96-4780-9b37-6447273b190e format: uuid type: string referenceId: description: Идентификатор поручения клиента, если поручение загружено через API example: 1111-2222-3333 type: string creditorRequisites: $ref: '#/components/schemas/CreditorRequisites' paymentRequisites: $ref: '#/components/schemas/PaymentRequisites' taxRequisites: $ref: '#/components/schemas/TaxRequisites' creditor: $ref: '#/components/schemas/CreditorResponse' payment: $ref: '#/components/schemas/Payment' packet: $ref: '#/components/schemas/PacketResponse' orderType: $ref: '#/components/schemas/OrderType' orderDate: description: Дата поручения example: '2025-01-01' format: date type: string maturityDate: description: Дата погашения example: '2025-01-01' format: date type: string executionDate: description: Дата исполнения example: '2025-01-01' format: date type: string orderSum: description: Сумма поручения example: 1111.11 type: number debtSum: description: Сумма задолженности по поручению example: 55.55 type: number currencyCode: $ref: '#/components/schemas/CurrencyCode' state: $ref: '#/components/schemas/OrderState' cqrsVersion: $ref: '#/components/schemas/CqrsVersion' required: - cqrsVersion - creditorRequisites - currencyCode - debtSum - id - maturityDate - orderDate - orderSum - orderType - paymentRequisites - referenceId - state type: object example: id: 2c44306f-fc96-4780-9b37-6447273b190e referenceId: 1111-2222-3333 creditorRequisites: ogrn: '123456789012345' inn: '1234567890' kpp: '123456789' fullNameRus: АО Ромашка paymentRequisites: purpose: Оплата по контракту 111111 от 31.12.2021 correspondentAccount: '30101810200000000700' recipientBankName: АО «Райффайзенбанк» bic: '044525700' account: '40702810200001430012' orderType: COMMON orderDate: '2025-01-01' maturityDate: '2025-01-01' executionDate: '2025-01-01' orderSum: 1111.11 debtSum: 55.55 currencyCode: RUB state: statusDate: '2025-07-10T06:53:37.433211' errors: [] status: FINANCED cqrsVersion: -1628796591 Direction: description: Направление сортировки enum: - DESC - ASC example: DESC type: string PacketStatus: description: Статус реестра поручений enum: - SIGN_AWAITING - SIGN_REJECTED - DOCUMENT_IN_PROGRESS - ACCEPTED_BY_BANK example: ACCEPTED_BY_BANK type: string PacketState: allOf: - $ref: '#/components/schemas/State' - properties: status: $ref: '#/components/schemas/PacketStatus' type: object description: Состояние пакета example: statusDate: '2025-07-10T06:53:37.433211' errors: [] status: ACCEPTED_BY_BANK type: object OrderSortFields: description: Поле для сортировки Поручения enum: - MATURITY_DATE - ORDER_DATE - DEBT_SUM example: MATURITY_DATE type: string OrderTotalDebtResponse: example: totalDebt: '100.11' overDebt: '100.11' maturityTodayDebt: '100.11' properties: totalDebt: description: Сумма задолженности на момент запроса example: '100.11' type: string overDebt: description: Сумма просроченной задолженности example: '100.11' type: string maturityTodayDebt: description: Сумма задолженности поручений с плановой датой погашения на сегодня example: '100.11' type: string required: - maturityTodayDebt - overDebt - totalDebt type: object CreditorResponse: allOf: - $ref: '#/components/schemas/CreditorRequisites' - properties: id: description: Идентификатор кредитора example: 2c44306f-fc96-4780-9b37-6447273b190e format: uuid type: string state: $ref: '#/components/schemas/CreditorState' cqrsVersion: $ref: '#/components/schemas/CqrsVersion' required: - cqrsVersion - id - state type: object description: Кредитор example: ogrn: '123456789012345' inn: '1234567890' kpp: '123456789' fullNameRus: АО Ромашка id: 2c44306f-fc96-4780-9b37-6447273b190e state: statusDate: '2025-07-10T06:53:37.433211' errors: [] status: APPROVED cqrsVersion: -1628796591 CreditorState: allOf: - $ref: '#/components/schemas/State' - properties: status: $ref: '#/components/schemas/CreditorStatus' type: object description: Состояние кредитора example: statusDate: '2025-07-10T06:53:37.433211' errors: [] status: APPROVED type: object ErrorCodes: description: '| code | description | |------------|------------------------------------| | ERR_0000 | Unexpected error | | ERR_0001 | Creditor not valid | | ERR_0002 | Error getting okved from DaData | | ERR_0003 | Affiliation check not valid | | ERR_0004 | Affiliation check nof found | | ERR_1001 | Requisites not valid | | ERR_1002 | Creditor not valid | | ERR_1003 | The financing period is longer than the maximum | | ERR_1004 | Exceeded daily limit | | ERR_1005 | Creditor not found | | ERR_1006 | Exceed maximum limit | | ERR_1007 | Date is not found in calendar | | ERR_1008 | Agreement not found | | ERR_1009 | Agreement not valid | | ERR_1010 | Agreement is blocked | | ERR_1011 | Order date invalid | | ERR_1012 | Maturity date invalid | | ERR_1013 | Limit not valid | | ERR_1014 | Due date is unavailable | | ERR_1015 | Tariff plan not found | | ERR_1016 | Order date is not working day | | ERR_1017 | Tariff plan not approved | | ERR_2000 | General service error | | ERR_4001 | Requisites not valid | | ERR_4002 | Payment rejected by operator | | ERR_4003 | Payment rejected by CBR | | ERR_6000 | Entry rejected by CIG | | ERR_9001 | Value date is over | | ERR_9002 | First financing date is over | | ERR_11001 | Minimum Margin check failed | | ERR_12001 | Account is blocked | ' enum: - ERR_0000 - ERR_0001 - ERR_0002 - ERR_0003 - ERR_0004 - ERR_1001 - ERR_1002 - ERR_1003 - ERR_1004 - ERR_1005 - ERR_1006 - ERR_1007 - ERR_1008 - ERR_1009 - ERR_1010 - ERR_1011 - ERR_1012 - ERR_1013 - ERR_1014 - ERR_1015 - ERR_1016 - ERR_1017 - ERR_2000 - ERR_4001 - ERR_4002 - ERR_4003 - ERR_6000 - ERR_9001 - ERR_9002 - ERR_11001 - ERR_12001 example: ERR_2000 type: string PaymentRequisites: description: Платежные реквизиты example: account: '40702810200001430012' correspondentAccount: '30101810200000000700' bic: '044525700' recipientBankName: АО «Райффайзенбанк» purpose: Оплата по контракту 111111 от 31.12.2021 properties: account: description: Расчетный счет получателя example: '40702810200001430012' type: string correspondentAccount: description: Корреспондентский счет получателя example: '30101810200000000700' type: string bic: description: БИК банка получателя example: '044525700' type: string recipientBankName: description: Наименование банка получателя example: АО «Райффайзенбанк» type: string purpose: description: Назначение платежа example: Оплата по контракту 111111 от 31.12.2021 type: string required: - account - bic - correspondentAccount - purpose - recipientBankName type: object SortingOrder: description: Направление сортировки по полю example: sortBy: MATURITY_DATE orderBy: DESC properties: sortBy: $ref: '#/components/schemas/OrderSortFields' orderBy: $ref: '#/components/schemas/Direction' required: - orderBy - sortBy type: object Payment: description: Исходящий платеж example: number: 125 date: '2025-04-01' properties: number: description: Номер исходящего платежа example: 125 type: integer date: description: Дата исходящего платежа example: '2025-04-01' type: string type: object OrderState: allOf: - $ref: '#/components/schemas/State' - properties: status: $ref: '#/components/schemas/OrderStatus' type: object description: Состояние поручения example: statusDate: '2025-07-10T06:53:37.433211' errors: [] status: FINANCED type: object CqrsVersion: description: hashCode от state - состояния реестра example: -1628796591 type: integer CurrencyCode: description: Валюта платежа enum: - RUB example: RUB type: string State: description: Состояние объекта example: statusDate: '2025-07-10T06:53:37.433211' errors: [] properties: statusDate: description: yyyy-MM-dd'T'HH:mm:ss.SSSSSS format: date-time pattern: ([0-9]{4})-(?:[0-9]{2})-([0-9]{2})T([0-9]{2}):([0-9]{2}):([0-9]{2}).([0-9]{6}) type: string errors: description: Ошибки items: $ref: '#/components/schemas/Error' type: array required: - statusDate type: object ImageUrl: type: string description: URL с изображением зарегистрированного QR-кода в СБП example: https://pay.raif.ru/api/b2b/sbp/v1/qrs/AS1B001K33DNHAKV2KNBJRQK6KHNQKJ5/image Qr: type: object description: Информация о платёжной ссылке по заказу required: - id - name - type - payload - imageUrl properties: id: allOf: - $ref: '#/components/schemas/PaymentLinkId' name: allOf: - $ref: '#/components/schemas/PaymentLinkName' type: allOf: - $ref: '#/components/schemas/QrType' payload: allOf: - $ref: '#/components/schemas/Payload' imageUrl: allOf: - $ref: '#/components/schemas/ImageUrl' PaymentSender: type: object description: Информация о плательщике required: - legalName - inn - account - bank properties: legalName: $ref: '#/components/schemas/LegalName' inn: $ref: '#/components/schemas/Inn' account: allOf: - $ref: '#/components/schemas/Account' description: Банковский счёт ЮЛ или ИП, с которого списаны средства bank: allOf: - $ref: '#/components/schemas/BankInfo' description: Информация о банке плательщика QrType: type: string enum: - DYNAMIC - STATIC description: Тип платёжной ссылки Restrictions: type: object description: Ограничения к заказу properties: senderInn: type: string minLength: 10 maxLength: 12 description: ИНН ЮЛ или ИП, которое может оплатить заказ example: '123456789012' Status: type: string description: 'Статус заказа:
• ACTIVE – активен, можно проводить оплату
• EXPIRED - срок действия истёк, нельзя провести оплату
• PAID - оплачен, есть успешный платеж, новые платежи сделать не получится
• CANCELLED - отменен, нельзя провести оплату ' enum: - ACTIVE - EXPIRED - PAID - CANCELLED example: ACTIVE ExpirationDate: type: string format: date-time description: Срок жизни example: '2024-08-12T20:35:55+03:00' OrderIdNoRestrictions: type: string description: Идентификатор заказа. Если не передан будет сформирован Банком. maxLength: 35 pattern: ^[A-z0-9-_.]+$ example: order-63853012 CreateOrderRequestDto: required: - senderPaymentPurpose - account - amount type: object title: Контракт создания заказа properties: id: allOf: - $ref: '#/components/schemas/OrderId' description: 'Идентификатор заказа, переданный клиентом или сгенерированный банком
Может содержать:
• Символы латиницы (A–Z и a–z)
• Цифры 0-9
• Спецсимволы: `-`, `.`, `_` ' name: allOf: - $ref: '#/components/schemas/PaymentLinkName' account: allOf: - $ref: '#/components/schemas/Account' amount: allOf: - $ref: '#/components/schemas/Amount' totalTaxAmount: allOf: - $ref: '#/components/schemas/TotalTaxAmount' expirationDate: type: string format: yyyy-MM-ddTHH:mm:ss±HH:mm / +nM / +nm description: 'Срок жизни заказа
Может содержать точную дату и время или количество минут. Передача срока в минутах удобна для торговых точек, которые не привязываются к точному времени или часовому поясу
Параметр не может быть меньше текущей даты и времени. Если указывается в минутах, то не может быть меньше 1 минуты. Максимальное значение — 129600 минут (90 суток). Если параметр не передан, то по умолчанию QR будет действителен 4320 минут (3 суток)
После истечения срока действия заказа оплату по нему провести нельзя
При передачи количества минут указываете в таком виде (например, + 60 минут): "expirationDate": "+60m" ' example: '2024-08-12T20:35:55+03:00' receiverPaymentPurpose: allOf: - $ref: '#/components/schemas/ReceiverPaymentPurpose' description: 'Назначение платежа, которое увидит получатель в выписке в поле «Основание операции» вместе с инн плательщика.
Например, "ИНН плательщика: 231150869432. Какое-то ваше назначение"
Если поле не заполнено, то поле «Основание операции» заполнится по шаблону, в который будет передан идентификатор заказа, наименование плательщика и инн плательщика.
Например, «Перевод по идентификатору nM43NFfqiaAh04QdSmCoI5u4S2YrWU2ikHJ. Плательщик: ООО Ромашка, ИНН: 231150869432. Осуществлен через СБП B2В».
Может содержать:
• Символы латиницы (A–Z и a–z)
• Символы кириллицы (А-Я и а-я)
• Цифры 0-9
• Спецсимволы: пробел и `!`, `"`, `#`, `$`, `%`, `''`, `(`, `)`, `*`, `+`, `,`, `-`, `.`, `/`, `:`, `;`, `=`, `>`, `?`, `@`, `[`, `\`, `]`, `^`, `_`, `{`, `|`, `}`, `~`,`№` ' senderPaymentPurpose: allOf: - $ref: '#/components/schemas/SenderPaymentPurpose' description: 'Назначение платежа, которое увидит плательщик при оплате. Поле обязательное.
Может содержать:
• Символы латиницы (A–Z и a–z)
• Символы кириллицы (А-Я и а-я)
• Цифры 0-9
• Спецсимволы: пробел и `!`, `"`, `#`, `$`, `%`, `''`, `(`, `)`, `*`, `+`, `,`, `-`, `.`, `/`, `:`, `;`, `=`, `>`, `?`, `@`, `[`, `\`, `]`, `^`, `_`, `{`, `|`, `}`, `~`,`№` ' redirectUrl: allOf: - $ref: '#/components/schemas/RedirectUrl' extra: allOf: - $ref: '#/components/schemas/Extra' restrictions: allOf: - $ref: '#/components/schemas/Restrictions' PaymentLinkName: type: string description: Наименование платёжной ссылки example: QR на оплату 14.10.2024 в 15:12 BankName: type: string description: Наименование банка example: Райффайзенбанк TotalTaxAmount: type: number format: float maximum: 1000000 description: Сумма НДС в рублях example: 2.41 OrderInfoResponseDto: type: object title: Контракт информации о заказе required: - id - account - amount - creationDate - expirationDate - status - senderPaymentPurpose - qr properties: id: allOf: - $ref: '#/components/schemas/OrderIdNoRestrictions' account: allOf: - $ref: '#/components/schemas/Account' amount: allOf: - $ref: '#/components/schemas/Amount' totalTaxAmount: allOf: - $ref: '#/components/schemas/TotalTaxAmount' creationDate: allOf: - $ref: '#/components/schemas/CreationDate' expirationDate: allOf: - $ref: '#/components/schemas/ExpirationDate' status: allOf: - $ref: '#/components/schemas/Status' receiverPaymentPurpose: allOf: - $ref: '#/components/schemas/ReceiverPaymentPurpose' senderPaymentPurpose: allOf: - $ref: '#/components/schemas/SenderPaymentPurpose' redirectUrl: allOf: - $ref: '#/components/schemas/RedirectUrl' extra: allOf: - $ref: '#/components/schemas/Extra' restrictions: allOf: - $ref: '#/components/schemas/Restrictions' qr: allOf: - $ref: '#/components/schemas/Qr' payment: allOf: - $ref: '#/components/schemas/Payment_2' OrderId: type: string description: Идентификатор заказа, переданный клиентом или сгенерированный банком maxLength: 35 example: '100001' ReceiverPaymentPurpose: type: string maxLength: 150 description: 'Назначение платежа, которое увидит получатель в выписке в поле «Основание операции» вместе с инн плательщика.
Например, "ИНН плательщика: 231150869432. Какое-то ваше назначение"
Если поле не заполнено, то поле «Основание операции» заполнится по шаблону, в который будет передан идентификатор заказа, наименование плательщика и инн плательщика.
Например, «Перевод по идентификатору nM43NFfqiaAh04QdSmCoI5u4S2YrWU2ikHJ. Плательщик: ООО Ромашка, ИНН: 231150869432. Осуществлен через СБП B2В».
Может содержать:
• Символы латиницы (A–Z и a–z)
• Символы кириллицы (А-Я и а-я)
• Цифры 0-9
• Спецсимволы: пробел и `!`, `"`, `#`, `$`, `%`, `''`, `(`, `)`, `*`, `+`, `,`, `-`, `.`, `/`, `:`, `;`, `=`, `>`, `?`, `@`, `[`, `\`, `]`, `^`, `_`, `{`, `|`, `}`, `~`,`№` ' example: Какое-то назначение платежа PaymentId: type: string description: Идентификатор платежа example: '123456789012345678' LegalName: type: string maxLength: 512 description: Сокращённое наименование ЮЛ или ИП Плательщика example: ООО Ромашка Extra: type: object description: Дополнительные поля additionalProperties: type: string example: additionalInfo: testing operation PaymentStatus: type: object description: Статус входящего платежа required: - value - date properties: value: type: string description: Статус платежа, возможен только "SUCCESS" enum: - SUCCESS example: SUCCESS date: type: string format: date-time description: Время проведения платежа example: '2024-06-12T19:36:55+03:00' CreateOrderResponseDto: type: object title: Контракт ответа создания заказа required: - id - account - amount - creationDate - expirationDate - status - senderPaymentPurpose - qr properties: id: allOf: - $ref: '#/components/schemas/OrderId' account: allOf: - $ref: '#/components/schemas/Account' amount: allOf: - $ref: '#/components/schemas/Amount' totalTaxAmount: allOf: - $ref: '#/components/schemas/TotalTaxAmount' creationDate: allOf: - $ref: '#/components/schemas/CreationDate' expirationDate: allOf: - $ref: '#/components/schemas/ExpirationDate' status: allOf: - $ref: '#/components/schemas/Status' receiverPaymentPurpose: allOf: - $ref: '#/components/schemas/ReceiverPaymentPurpose' description: 'Назначение платежа, которое увидит получатель в выписке в поле «Основание операции» вместе с инн плательщика.
Например, "ИНН плательщика: 231150869432. Какое-то ваше назначение"
Если поле не заполнено, то поле «Основание операции» заполнится по шаблону, в который будет передан идентификатор заказа, наименование плательщика и инн плательщика.
Например, «Перевод по идентификатору nM43NFfqiaAh04QdSmCoI5u4S2YrWU2ikHJ. Плательщик: ООО Ромашка, ИНН: 231150869432. Осуществлен через СБП B2В».
Может содержать:
• Символы латиницы (A–Z и a–z)
• Символы кириллицы (А-Я и а-я)
• Цифры 0-9
• Спецсимволы: пробел и `!`, `"`, `#`, `$`, `%`, `''`, `(`, `)`, `*`, `+`, `,`, `-`, `.`, `/`, `:`, `;`, `=`, `>`, `?`, `@`, `[`, `\`, `]`, `^`, `_`, `{`, `|`, `}`, `~`,`№` ' senderPaymentPurpose: allOf: - $ref: '#/components/schemas/SenderPaymentPurpose' description: 'Назначение платежа, которое увидит плательщик при оплате.
Может содержать:
• Символы латиницы (A–Z и a–z)
• Символы кириллицы (А-Я и а-я)
• Цифры 0-9
• Спецсимволы: пробел и `!`, `"`, `#`, `$`, `%`, `''`, `(`, `)`, `*`, `+`, `,`, `-`, `.`, `/`, `:`, `;`, `=`, `>`, `?`, `@`, `[`, `\`, `]`, `^`, `_`, `{`, `|`, `}`, `~`,`№` ' redirectUrl: allOf: - $ref: '#/components/schemas/RedirectUrl' extra: allOf: - $ref: '#/components/schemas/Extra' restrictions: allOf: - $ref: '#/components/schemas/Restrictions' qr: allOf: - $ref: '#/components/schemas/Qr' SenderPaymentPurpose: type: string maxLength: 210 description: 'Назначение платежа, которое увидит плательщик при оплате. Поле обязательное.
Может содержать:
• Символы латиницы (A–Z и a–z)
• Символы кириллицы (А-Я и а-я)
• Цифры 0-9
• Спецсимволы: пробел и `!`, `"`, `#`, `$`, `%`, `''`, `(`, `)`, `*`, `+`, `,`, `-`, `.`, `/`, `:`, `;`, `=`, `>`, `?`, `@`, `[`, `\`, `]`, `^`, `_`, `{`, `|`, `}`, `~`,`№` ' example: Какое-то назначение платежа Payload: type: string maxLength: 999 description: Функциональная ссылка example: https://b2b.cbrpay.ru/AS1B001K33DNHAKV2KNBJRQK6KHNQKJ5 IncomingPaymentCallbackDto: type: object required: - event - data properties: event: type: string description: Тип операции example: B2B_PAYMENT enum: - B2B_PAYMENT data: type: object required: - id - account - amount - createdDate - expirationDate - status - senderPaymentPurpose - payment - qr properties: id: allOf: - $ref: '#/components/schemas/OrderId' account: allOf: - $ref: '#/components/schemas/Account' amount: allOf: - $ref: '#/components/schemas/Amount' totalTaxAmount: allOf: - $ref: '#/components/schemas/TotalTaxAmount' createdDate: allOf: - $ref: '#/components/schemas/CreationDate' expirationDate: allOf: - $ref: '#/components/schemas/ExpirationDate' status: allOf: - $ref: '#/components/schemas/Status' receiverPaymentPurpose: allOf: - $ref: '#/components/schemas/ReceiverPaymentPurpose' description: 'Назначение платежа, которое увидит получатель в выписке в поле «Основание операции» вместе с инн плательщика.
Например, "ИНН плательщика: 231150869432. Какое-то ваше назначение"
Если поле не заполнено, то поле «Основание операции» заполнится по шаблону, в который будет передан идентификатор заказа, наименование плательщика и инн плательщика.
Например, «Перевод по идентификатору nM43NFfqiaAh04QdSmCoI5u4S2YrWU2ikHJ. Плательщик: ООО Ромашка, ИНН: 231150869432. Осуществлен через СБП B2В».
Может содержать:
• Символы латинского алфавита (A–Z и a–z) с десятичными кодами из диапазонов [065-090] и [097-122] в кодировке UTF-8;
• Символы русского алфавита (А-Я и а-я) с десятичными кодами из диапазона [1040-1103] в кодировке UTF-8;
• Цифры 0-9 с десятичными кодами из диапазона [048-057] в кодировке UTF-8;
• Специальные символы с десятичными кодами из диапазонов [032-047], [058-064], [091-096], [123-126] в кодировке UTF-8;
• Символ «№» под номером 8470 в кодировке UTF-8 ' senderPaymentPurpose: allOf: - $ref: '#/components/schemas/SenderPaymentPurpose' redirectUrl: allOf: - $ref: '#/components/schemas/RedirectUrl' extra: allOf: - $ref: '#/components/schemas/Extra' qr: allOf: - $ref: '#/components/schemas/Qr' payment: allOf: - $ref: '#/components/schemas/Payment_2' BankId: type: string description: Идентификатор банка example: '100000000007' Inn: type: string minLength: 10 maxLength: 12 description: ИНН ЮЛ или ИП Плательщика example: '123456789012' PaymentLinkId: type: string maxLength: 32 description: Уникальный идентификатор платёжной ссылки example: AS1B001K33DNHAKV2KNBJRQK6KHNQKJ5 BankInfo: type: object description: Информация о банке required: - id - name - bic properties: id: $ref: '#/components/schemas/BankId' name: $ref: '#/components/schemas/BankName' bic: $ref: '#/components/schemas/BankBic' Account: type: string minLength: 20 maxLength: 20 description: Банковский счёт ЮЛ или ИП для зачисления средств example: '40817810601002630020' ErrorResponseDto: type: object properties: code: type: string description: Код ошибки запроса. message: type: string description: Описание ошибки SbpTransactionId: type: string minLength: 32 maxLength: 32 description: Уникальный идентификатор операции на уровне всей системы СБП example: PMSHT0BYVSYE7LDXMCXJSGIUHJLQWZXY BankBic: type: string description: БИК банка example: '044525700' Amount: type: number format: float maximum: 1000000 description: Сумма операции в рублях example: 8573.79 Payment_2: description: Информация об успешном платеже. Поле заполняется только в случае, если по заказу была проведена успешная оплата type: - object - 'null' required: - id - sbpTransactionId - status - amount - totalTaxAmount - sender properties: id: $ref: '#/components/schemas/PaymentId' sbpTransactionId: $ref: '#/components/schemas/SbpTransactionId' status: $ref: '#/components/schemas/PaymentStatus' amount: $ref: '#/components/schemas/Amount' totalTaxAmount: $ref: '#/components/schemas/TotalTaxAmount' sender: $ref: '#/components/schemas/PaymentSender' CreationDate: type: string format: date-time description: Дата создания example: '2024-06-12T19:35:55+03:00' RedirectUrl: type: string maxLength: 1024 description: Ссылка для автоматического возврата плательщика из приложения банка в приложение или на сайт ТСП example: https://exampletsp.io/qwertyui OrderInfoResponseDto_2: type: object title: Контракт информации о заказе required: - id - account - amount - creationDate - expirationDate - status - senderPaymentPurpose - qr properties: id: allOf: - $ref: '#/components/schemas/OrderIdNoRestrictions' account: allOf: - $ref: '#/components/schemas/Account' amount: allOf: - $ref: '#/components/schemas/Amount' totalTaxAmount: allOf: - $ref: '#/components/schemas/TotalTaxAmount' creationDate: allOf: - $ref: '#/components/schemas/CreationDate' expirationDate: allOf: - $ref: '#/components/schemas/ExpirationDate' status: allOf: - $ref: '#/components/schemas/Status' receiverPaymentPurpose: allOf: - $ref: '#/components/schemas/ReceiverPaymentPurpose' senderPaymentPurpose: allOf: - $ref: '#/components/schemas/SenderPaymentPurpose' redirectUrl: allOf: - $ref: '#/components/schemas/RedirectUrl' extra: allOf: - $ref: '#/components/schemas/Extra' restrictions: allOf: - $ref: '#/components/schemas/Restrictions' qr: allOf: - $ref: '#/components/schemas/Qr' payment: allOf: - $ref: '#/components/schemas/Payment_3' IncomingPaymentCallbackDto_2: type: object required: - event - data properties: event: type: string description: Тип операции example: B2B_PAYMENT enum: - B2B_PAYMENT data: type: object required: - id - account - amount - createdDate - expirationDate - status - senderPaymentPurpose - payment - qr properties: id: allOf: - $ref: '#/components/schemas/OrderId' account: allOf: - $ref: '#/components/schemas/Account' amount: allOf: - $ref: '#/components/schemas/Amount' totalTaxAmount: allOf: - $ref: '#/components/schemas/TotalTaxAmount' createdDate: allOf: - $ref: '#/components/schemas/CreationDate' expirationDate: allOf: - $ref: '#/components/schemas/ExpirationDate' status: allOf: - $ref: '#/components/schemas/Status' receiverPaymentPurpose: allOf: - $ref: '#/components/schemas/ReceiverPaymentPurpose' description: 'Назначение платежа, которое увидит получатель в выписке в поле «Основание операции» вместе с инн плательщика.
Например, "ИНН плательщика: 231150869432. Какое-то ваше назначение"
Если поле не заполнено, то поле «Основание операции» заполнится по шаблону, в который будет передан идентификатор заказа, наименование плательщика и инн плательщика.
Например, «Перевод по идентификатору nM43NFfqiaAh04QdSmCoI5u4S2YrWU2ikHJ. Плательщик: ООО Ромашка, ИНН: 231150869432. Осуществлен через СБП B2В».
Может содержать:
• Символы латинского алфавита (A–Z и a–z) с десятичными кодами из диапазонов [065-090] и [097-122] в кодировке UTF-8;
• Символы русского алфавита (А-Я и а-я) с десятичными кодами из диапазона [1040-1103] в кодировке UTF-8;
• Цифры 0-9 с десятичными кодами из диапазона [048-057] в кодировке UTF-8;
• Специальные символы с десятичными кодами из диапазонов [032-047], [058-064], [091-096], [123-126] в кодировке UTF-8;
• Символ «№» под номером 8470 в кодировке UTF-8 ' senderPaymentPurpose: allOf: - $ref: '#/components/schemas/SenderPaymentPurpose' redirectUrl: allOf: - $ref: '#/components/schemas/RedirectUrl' extra: allOf: - $ref: '#/components/schemas/Extra' qr: allOf: - $ref: '#/components/schemas/Qr' payment: allOf: - $ref: '#/components/schemas/Payment_3' Payment_3: description: Информация об успешном платеже. Поле заполняется только в случае, если по заказу была проведена успешная оплата type: - object - 'null' required: - id - sbpTransactionId - status - amount - totalTaxAmount - sender properties: id: $ref: '#/components/schemas/PaymentId' sbpTransactionId: $ref: '#/components/schemas/SbpTransactionId' status: $ref: '#/components/schemas/PaymentStatus' amount: $ref: '#/components/schemas/Amount' totalTaxAmount: $ref: '#/components/schemas/TotalTaxAmount' sender: $ref: '#/components/schemas/PaymentSender' parameters: AuthorizationHeader: name: Authorization in: header description: Токен доступа required: true schema: type: string format: byte example: Bearer QXV0aG9yaXphdGlvbiBIZWFkZXIgRm9yIFRlc3Rpbmc= IdTokenHeader: name: Id-Token in: header description: Идентификационный токен пользователя required: true schema: type: string format: byte example: SUQgVE9LRU4gRk9SIFRFU1RJTkc= OrderIdWithoutGenerating: in: path description: Идентификатор заказа required: true name: id schema: type: string WithLogo: name: withLogo in: query required: false description: Отображение логотипа СБП в QR-коде schema: type: boolean default: true Format: name: format in: query required: false description: Формат изображения schema: enum: - SVG - PNG QrId: name: qrId in: path required: true description: Уникальный идентификатор платёжной ссылки schema: type: string responses: InternalError: description: Внутренняя ошибка Unauthorized: description: Аутентификация не пройдена Forbidden: description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDto' examples: default: value: code: FORBIDDEN message: Доступ запрещен InternalServerError: description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDto' examples: default: value: code: SYSTEM_ERROR message: Возникла системная ошибка BadRequest: description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDto' examples: default: value: code: INVALID_DATA message: Некорректные данные NotFound: description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDto' examples: default: value: code: ORDER_NOT_FOUND message: По данному идентификатору Заказ не найден examples: OrderInfoResponseDtoPaid: summary: Успешно оплаченный заказ description: Ответ на запрос статуса, когда заказ был оплачен — **status = PAID** value: id: 281000670LSS7DN18SJQDNP4B05KLJL2 account: '40817810601002630000' amount: 8573.79 totalTaxAmount: 2.41 creationDate: '2024-06-12T19:35:55+03:00' expirationDate: '2024-08-12T20:35:55+03:00' status: PAID receiverPaymentPurpose: Какое-то назначение платежа senderPaymentPurpose: Какое-то назначение платежа redirectUrl: https://exampletsp.io/qwertyui extra: additionalInfo: testing operation restrictions: senderInn: '123456789012' qr: id: AS1B001K33DNHAKV2KNBJRQK6KHNQKJ5 name: QR на оплату 25.09.2024 в 15:12 type: DYNAMIC payload: https://b2b.cbrpay.ru/AS1B001K33DNHAKV2KNBJRQK6KHNQKJ5 imageUrl: https://pay.raif.ru/api/b2b/sbp/v1/qrs/AS1B001K33DNHAKV2KNBJRQK6KHNQKJ5/image payment: id: '123456789012345678' sbpTransactionId: PMSHT0BYVSYE7LDXMCXJSGIUHJLQWZXY status: value: SUCCESS date: '2024-06-12T19:36:55+03:00' amount: 8573.79 totalTaxAmount: 2.41 sender: legalName: ООО Ромашка inn: '123456789012' account: '40817810601002630012' bank: id: '100000000007' name: Райффайзенбанк bic: '44525700' CreateOrderResponseDtoWithOutRestrictions: summary: Заказ без ограничений description: Ответ на создание заказа без указания ограничений **Отсутствует блок restrictions** value: id: 281000670LSS7DN18SJQDNP4B05KLJL2 account: '40817810601002630000' amount: 8573.79 totalTaxAmount: 2.41 creationDate: '2024-06-12T19:35:55+03:00' expirationDate: '2024-08-12T20:35:55+03:00' status: ACTIVE receiverPaymentPurpose: Какое-то назначение платежа senderPaymentPurpose: Какое-то назначение платежа redirectUrl: https://exampletsp.io/qwertyui extra: additionalInfo: testing operation qr: id: AS1B001K33DNHAKV2KNBJRQK6KHNQKJ5 name: QR на оплату 25.09.2024 в 15:12 type: DYNAMIC payload: https://b2b.cbrpay.ru/AS1B001K33DNHAKV2KNBJRQK6KHNQKJ5 imageUrl: https://pay.raif.ru/api/b2b/sbp/v1/qrs/AS1B001K33DNHAKV2KNBJRQK6KHNQKJ5/image CreateOrderRequestDtoCountOfMinutes: summary: Заказ c указанием количества минут жизни description: Запрос на создание заказа c указанием количества минут жизни value: id: 281000670LSS7DN18SJQDNP4B05KLJL2 name: QR на оплату 25.09.2024 в 15:12 account: '40817810601002630000' amount: 7.45 totalTaxAmount: 1.25 expirationDate: +60m receiverPaymentPurpose: Какое-то назначение платежа senderPaymentPurpose: Какое-то назначение платежа redirectUrl: https://example.ru extra: additionalInfo: testing operation OrderInfoResponseDtoActive: summary: Активный заказ description: Ответ на запрос статуса, когда платежа по заказу еще не было — **status = ACTIVE** value: id: 281000670LSS7DN18SJQDNP4B05KLJL2 account: '40817810601002630000' amount: 8573.79 totalTaxAmount: 2.41 creationDate: '2024-06-12T19:35:55+03:00' expirationDate: '2024-08-12T20:35:55+03:00' status: ACTIVE receiverPaymentPurpose: Какое-то назначение платежа senderPaymentPurpose: Какое-то назначение платежа redirectUrl: https://exampletsp.io/qwertyui extra: additionalInfo: testing operation restrictions: senderInn: '123456789012' qr: id: AS1B001K33DNHAKV2KNBJRQK6KHNQKJ5 name: QR на оплату 25.09.2024 в 15:12 type: DYNAMIC payload: https://b2b.cbrpay.ru/AS1B001K33DNHAKV2KNBJRQK6KHNQKJ5 imageUrl: https://pay.raif.ru/api/b2b/sbp/v1/qrs/AS1B001K33DNHAKV2KNBJRQK6KHNQKJ5/image CreateOrderRequestDtoWithoutRestriction: summary: Заказ без ограничений description: Запрос на создание заказа без указания ограничений **Отсутствует блок restrictions** value: id: 281000670LSS7DN18SJQDNP4B05KLJL2 name: QR на оплату 25.09.2024 в 15:12 account: '40817810601002630000' amount: 7.45 totalTaxAmount: 1.25 expirationDate: '2024-08-12T20:35:55+03:00' receiverPaymentPurpose: Какое-то назначение платежа senderPaymentPurpose: Какое-то назначение платежа redirectUrl: https://example.ru extra: additionalInfo: testing operation OrderInfoResponseDtoExpired: summary: Просроченный заказ description: Ответ на запрос статуса, когда время жизни заказа истекло — **status = EXPIRED** value: id: 281000670LSS7DN18SJQDNP4B05KLJL2 account: '40817810601002630000' amount: 8573.79 totalTaxAmount: 2.41 creationDate: '2024-06-12T19:35:55+03:00' expirationDate: '2024-08-12T20:35:55+03:00' status: EXPIRED receiverPaymentPurpose: Какое-то назначение платежа senderPaymentPurpose: Какое-то назначение платежа redirectUrl: https://exampletsp.io/qwertyui extra: additionalInfo: testing operation restrictions: senderInn: '123456789012' qr: id: AS1B001K33DNHAKV2KNBJRQK6KHNQKJ5 name: QR на оплату 25.09.2024 в 15:12 type: DYNAMIC payload: https://b2b.cbrpay.ru/AS1B001K33DNHAKV2KNBJRQK6KHNQKJ5 imageUrl: https://pay.raif.ru/api/b2b/sbp/v1/qrs/AS1B001K33DNHAKV2KNBJRQK6KHNQKJ5/image CreateOrderRequestDtoWithRestriction: summary: Заказ c ограничениями description: Запрос на создание заказа с указанием ограничений **Присутствует блок restrictions** value: id: 281000670LSS7DN18SJQDNP4B05KLJL2 name: QR на оплату 25.09.2024 в 15:12 account: '12345678901234567890' amount: 7.45 totalTaxAmount: 1.25 expirationDate: '2024-08-12T20:35:55+03:00' receiverPaymentPurpose: Какое-то назначение платежа senderPaymentPurpose: Какое-то назначение платежа redirectUrl: https://example.ru extra: additionalInfo: testing operation restrictions: senderInn: '1234567890' OrderInfoResponseDtoWithoutRestrictions: summary: Активный заказ без ограничений description: Ответ на создание заказа без указаниям ограничений **Отсутствует блок restrictions** value: id: 281000670LSS7DN18SJQDNP4B05KLJL2 account: '40817810601002630000' amount: 8573.79 totalTaxAmount: 2.41 creationDate: '2024-06-12T19:35:55+03:00' expirationDate: '2024-08-12T20:35:55+03:00' status: ACTIVE receiverPaymentPurpose: Какое-то назначение платежа senderPaymentPurpose: Какое-то назначение платежа redirectUrl: https://exampletsp.io/qwertyui extra: additionalInfo: testing operation qr: id: AS1B001K33DNHAKV2KNBJRQK6KHNQKJ5 name: QR на оплату 25.09.2024 в 15:12 type: DYNAMIC payload: https://b2b.cbrpay.ru/AS1B001K33DNHAKV2KNBJRQK6KHNQKJ5 imageUrl: https://pay.raif.ru/api/b2b/sbp/v1/qrs/AS1B001K33DNHAKV2KNBJRQK6KHNQKJ5/image CreateOrderResponseDtoWithRestrictions: summary: Заказ с ограничениями description: Ответ на создание заказа с указанием ограничений **Присутствует блок restrictions** value: id: 281000670LSS7DN18SJQDNP4B05KLJL2 account: '40817810601002630000' amount: 8573.79 totalTaxAmount: 2.41 creationDate: '2024-06-12T19:35:55+03:00' expirationDate: '2024-08-12T20:35:55+03:00' status: ACTIVE receiverPaymentPurpose: Какое-то назначение платежа senderPaymentPurpose: Какое-то назначение платежа redirectUrl: https://exampletsp.io/qwertyui extra: additionalInfo: testing operation restrictions: senderInn: '1234567890' qr: id: AS1B001K33DNHAKV2KNBJRQK6KHNQKJ5 name: QR на оплату 25.09.2024 в 15:12 type: DYNAMIC payload: https://b2b.cbrpay.ru/AS1B001K33DNHAKV2KNBJRQK6KHNQKJ5 imageUrl: https://pay.raif.ru/api/b2b/sbp/v1/qrs/AS1B001K33DNHAKV2KNBJRQK6KHNQKJ5/image securitySchemes: BearerAuth: type: http description: '[Bearer secretKey](#tag/authorization) example: eyJ0eXA*** ' scheme: bearer bearerFormat: JWT x-internal: false x-refined-from: - raiffeisen-ru-agency-factoring-openapi.yml - raiffeisen-ru-raif-pay-sbp-b2b-openapi.json - raiffeisen-ru-agency-factoring-openapi.yml - raiffeisen-ru-raif-pay-sbp-b2b-openapi.yml