openapi: 3.2.0
info:
  title: Raiffeisen Ru Notification External API
  version: '1.0'
  description: 'Operations tagged notification-external across 2 of this provider''s published API definitions: raiffeisen-ru-raif-pay-notifications-openapi.yml, raiffeisen-ru-raif-pay-notifications-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.raiffeisen.ru/raif-pay
tags:
- name: notification-external
paths:
  /v1/merchants/{publicId}/notifications:
    post:
      summary: Создание уведомления
      operationId: postV1Notifications
      description: Метод создание уведомления
      tags:
      - notification-external
      parameters:
      - schema:
          type: string
        in: path
        name: publicId
        description: Идентификатор мерчанта
        required: true
        example: 123456-7890
      - $ref: '#/components/parameters/IdTokenHeader'
      - $ref: '#/components/parameters/AuthorizationHeader'
      requestBody:
        required: true
        description: Создание уведомления
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateNotificationRequest'
            examples:
              createPaymentSlip:
                summary: Создание настроек квитанции
                value:
                  type: PAYMENT_SLIP
                  orderNumber: 123-123
                  customer:
                    email: test@test.ru
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateNotificationResponse'
              examples:
                Ответ создания уведомления:
                  summary: Успешное создание уведомления
                  value:
                    id: 09b9f34d-e6d1-432d-87a6-61ec5e4018cb
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralError'
              examples:
                Тело ошибки:
                  summary: Ошибка
                  value:
                    code: ERROR_CODE
                    message: Описание ошибки
                    traceId: c396fda4d36c4f12
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalError'
    servers:
    - url: https://api.raiffeisen.ru/raif-pay
  /v1/merchants/{publicId}/notifications/{id}:
    delete:
      summary: Удаление уведомления
      operationId: deleteV1Notification
      tags:
      - notification-external
      parameters:
      - schema:
          type: string
        in: path
        name: publicId
        description: Идентификатор мерчанта
        required: true
        example: 123456-7890
      - schema:
          type: string
        in: path
        name: id
        description: Идентификатор уведомления
        required: true
        example: 09b9f34d-e6d1-432d-87a6-61ec5e4018cb
      - $ref: '#/components/parameters/IdTokenHeader'
      - $ref: '#/components/parameters/AuthorizationHeader'
      responses:
        '200':
          description: OK
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralError'
              examples:
                Тело ошибки:
                  summary: Ошибка
                  value:
                    code: ERROR_CODE
                    message: Описание ошибки
                    traceId: c396fda4d36c4f12
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalError'
    servers:
    - url: https://api.raiffeisen.ru/raif-pay
components:
  responses:
    Unauthorized:
      description: Аутентификация не пройдена
    InternalError:
      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=
  schemas:
    CreateNotificationRequest:
      type: object
      title: CreateNotificationRequest
      description: Запрос на создание уведомления
      properties:
        type:
          type: string
          description: Тип уведомления
          example: PAYMENT_SLIP
        customer:
          $ref: '#/components/schemas/Customer'
        orderNumber:
          type: string
          description: Номер заказа
          example: order-test
      required:
      - type
      - customer
      - orderNumber
    Customer:
      title: Customer
      type: object
      description: Данные о покупателе
      properties:
        email:
          type: string
          description: Почта покупателя
          example: test@test.ru
      required:
      - email
    GeneralError:
      title: GeneralError
      type: object
      description: Объект ошибки
      properties:
        code:
          type: string
          description: Код ошибки запроса
          example: ERROR_CODE
        message:
          type: string
          description: Описание ошибки
          example: Описание ошибки
        traceId:
          type: string
          description: Идентификатор выполнения запроса при наличии ошибки
          example: c396fda4d36c4f12
    CreateNotificationResponse:
      type: object
      title: CreateNotificationResponse
      description: Ответ на запрос создания уведомления
      properties:
        id:
          type: string
          format: uuid
          description: Идентификатор уведомления
          example: 09b9f34d-e6d1-432d-87a6-61ec5e4018cb
x-refined-from:
- raiffeisen-ru-raif-pay-notifications-openapi.yml
- raiffeisen-ru-raif-pay-notifications-openapi.yml