openapi: 3.2.0
info:
  title: Raiffeisen Ru Guarantee Beneficiary API
  version: 1.0.0
  description: 'Operations tagged Guarantee Beneficiary across 2 of this provider''s published API definitions: raiffeisen-ru-trade-finance-beneficiary-guarantees-openapi.yml, raiffeisen-ru-trade-finance-beneficiary-guarantees-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.raiffeisen.ru/trade-finance
tags:
- name: Guarantee Beneficiary
  description: Выпущенные гарантии в кабинете бенефициара
paths:
  /v1/beneficiary/guarantees:
    post:
      tags:
      - Guarantee Beneficiary
      summary: Получение банковских гарантий по фильтру
      operationId: searchByFilter
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GuaranteeBeneficiaryFilterRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GuaranteeBeneficiaryResponse'
              examples:
                simple:
                  summary: Список гарантий по фильтру
                  description: Возвращает список гарантий по указанному фильтру
                  value:
                    offset: 0
                    limit: 20
                    totalCount: 35
                    data:
                    - id: 12345
                      number: 70690/GI/250911
                      status: ACTIVE
                      statusName: Действует
                      issueDate: '2025-09-11'
                      endDate: '2027-10-21'
                      amount: 10115.0
                      currency: EUR
                      guaranteeTypeName: Гарантия возврата аванса
        '400':
          $ref: '#/components/responses/BadRequest'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '404':
          $ref: '#/components/responses/NotFound'
        '403':
          $ref: '#/components/responses/Forbidden'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalError'
      parameters:
      - $ref: '#/components/parameters/AuthorizationHeader'
      - $ref: '#/components/parameters/IdTokenHeader'
    servers:
    - url: https://api.raiffeisen.ru/trade-finance
  /v1/beneficiary/guarantees/{id}:
    get:
      tags:
      - Guarantee Beneficiary
      summary: Получение банковской гарантии по id гарантии
      operationId: findById
      parameters:
      - name: id
        in: path
        required: true
        explode: false
        schema:
          type: integer
          format: int64
        example: 23456
      - $ref: '#/components/parameters/IdTokenHeader'
      - $ref: '#/components/parameters/AuthorizationHeader'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GuaranteeBeneficiaryDto'
              examples:
                simple:
                  summary: Гарантия по идентификатору
                  description: Возвращает информацию о гарантии по указанному идентификатору
                  value:
                    id: 12345
                    number: 70690/GI/250911
                    status: ACTIVE
                    statusName: Действует
                    issueDate: '2025-09-11'
                    endDate: '2027-10-21'
                    amount: 10115.0
                    currency: EUR
                    guaranteeTypeName: Гарантия возврата аванса
        '400':
          $ref: '#/components/responses/BadRequest'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '404':
          $ref: '#/components/responses/NotFound'
        '403':
          $ref: '#/components/responses/Forbidden'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalError'
    servers:
    - url: https://api.raiffeisen.ru/trade-finance
components:
  responses:
    UnprocessableEntity:
      description: Unprocessable Entity
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseDto'
    Forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseDto'
    InternalError:
      description: Внутренняя ошибка
    Unauthorized:
      description: Аутентификация не пройдена
    BadRequest:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseDto'
    NotFound:
      description: Not Found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseDto'
  schemas:
    Principal:
      type: object
      properties:
        shortName:
          type: string
          description: Наименование принципала
          example: ООО "ТЕСТ-ТЕХНОЛОГИИ ПЛЮС"
        cnum:
          type: string
          description: CNUM принципала
          example: Z55687
        inn:
          type: string
          description: ИНН принципала
          example: '7712345678'
      description: CNUM принципала
    ErrorResponseItemDto:
      required:
      - code
      - detail
      - id
      type: object
      properties:
        code:
          type: string
        detail:
          type: string
        meta:
          type: object
        id:
          type: string
        source:
          $ref: '#/components/schemas/ErrorSource'
    GuaranteeBeneficiaryFilterRequest:
      type: object
      properties:
        filter:
          $ref: '#/components/schemas/GuaranteeFilterDto'
        paging:
          $ref: '#/components/schemas/Paging'
        order:
          type: array
          items:
            $ref: '#/components/schemas/Order'
    Order:
      required:
      - sortBy
      properties:
        priority:
          type: integer
          format: int32
          example: 1
        sortBy:
          type: string
          example: number
        orderBy:
          $ref: '#/components/schemas/SortDirection'
    Beneficiary:
      type: object
      properties:
        shortName:
          type: string
          description: Наименование бенефициара
          example: АО "ТЕСТ-КОНСАЛТИНГ"
        cnum:
          type: string
          description: CNUM бенефициара
          example: '407016'
        inn:
          type: string
          description: ИНН бенефициара
          example: '7814987654'
    RangeDtoBigDecimal:
      type: object
      properties:
        from:
          type: number
          description: Начальное значение интервала
          example: 1000000
        to:
          type: number
          description: Конечное значение интервала
          example: 10000000
      description: Сумма гарантии, интервал
    GuaranteeFilterDto:
      type: object
      properties:
        beneficiaryCnum:
          type: array
          description: CNUM бенефициара
          items:
            type: string
            description: CNUM бенефициара
            example: '407016'
        guaranteeNumber:
          type: string
          description: Номер гарантии
          example: 70669/GI/250911
        statusTFO:
          type: array
          description: Статус гарантии
          items:
            type: string
            description: Статус гарантии
            example: ACTIVE
        issueDate:
          $ref: '#/components/schemas/RangeDtoLocalDate'
        expiryDate:
          $ref: '#/components/schemas/RangeDtoLocalDate'
        amount:
          $ref: '#/components/schemas/RangeDtoBigDecimal'
        currency:
          type: array
          description: Код валюты
          items:
            type: string
            description: Код валюты
            example: RUR
        guaranteeType:
          type: array
          description: Код типа гарантии
          items:
            type: string
            description: Код типа гарантии
            example: tax
        principal:
          $ref: '#/components/schemas/Principal'
    SortDirection:
      type: string
      enum:
      - ASC
      - DESC
    Paging:
      required:
      - limit
      - offset
      properties:
        offset:
          type: integer
          format: int32
          example: 60
        limit:
          type: integer
          format: int32
          example: 20
    ErrorSource:
      required:
      - pointer
      type: object
      properties:
        pointer:
          type: string
    GuaranteeBeneficiaryResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/GuaranteeBeneficiaryDto'
      allOf:
      - $ref: '#/components/schemas/Pagination'
    ErrorResponseDto:
      required:
      - errors
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ErrorResponseItemDto'
    GuaranteeBeneficiaryDto:
      required:
      - id
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 22799
        guaranteeNumber:
          type: string
          example: 70669/GI/250911
        statusTFO:
          type: string
          example: ACTIVE
        issueDate:
          type: string
          format: date
          example: '2025-09-11'
        expiryDate:
          type: string
          format: date
          example: '2025-09-30'
        amount:
          type: number
          example: 10000000
        currency:
          type: string
          example: RUR
        guaranteeType:
          type: string
          example: tax
        principal:
          $ref: '#/components/schemas/Principal'
        beneficiaryCnum:
          type: string
          example: '407016'
        beneficiary:
          $ref: '#/components/schemas/Beneficiary'
    Pagination:
      required:
      - limit
      - offset
      - totalCount
      type: object
      properties:
        offset:
          type: integer
          format: int32
          example: 0
        limit:
          type: integer
          format: int32
          example: 20
        totalCount:
          type: integer
          format: int64
          example: 35
    RangeDtoLocalDate:
      type: object
      properties:
        from:
          type: string
          format: date
          example: '2025-09-01'
        to:
          type: string
          format: date
          example: '2025-09-30'
      description: Дата окончания действия гарантии
  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=
x-refined-from:
- raiffeisen-ru-trade-finance-beneficiary-guarantees-openapi.yml
- raiffeisen-ru-trade-finance-beneficiary-guarantees-openapi.yml