openapi: 3.2.0
info:
  title: Merchant API HPP Webhook Prepare error API
  version: 3.0.0
  description: Merchant API HPP Webhook
servers:
- url: http://127.0.0.1:10010/v3
security:
- accountId: []
  accountPassword: []
tags:
- name: Prepare error
paths:
  /registered-prepare-error-address:
    post:
      tags:
      - Prepare error
      summary: ''
      operationId: postprepare-error
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PrepareError'
      responses:
        '200':
          description: 'Expected response: HTTP status code 200'
components:
  schemas:
    PrepareError:
      title: prepare-error
      properties:
        webhook:
          $ref: '#/components/schemas/PrepareErrorWebhook'
        requestId:
          description: Unique request ID received after a successful initial request for the appropriate action
          type: string
          example: bdc84215-d2ed-4e39-b4dd-e7b3ba85e38b
          maxLength: 36
          minLength: 36
        message:
          description: Error message
          type: string
          example: Error occurred
          maxLength: 255
          minLength: 1
        violations:
          type: array
          items:
            $ref: '#/components/schemas/PrepareErrorViolations'
      type: object
      required:
      - requestId
      - message
    PrepareErrorWebhook:
      type: object
      properties:
        id:
          description: Unique webhook ID
          type: string
          example: '5455223499197002'
          maxLength: 16
          minLength: 16
        type:
          description: '[Webhook Type] hosted_payment_prepare'
          type: string
          example: hosted_payment_prepare
          maxLength: 50
          minLength: 1
      required:
      - id
      - type
    PrepareErrorViolations:
      type: object
      properties:
        code:
          description: '[`Error code`](#appendix--enum--webhook-error-code)'
          type: string
          example: '403'
          maxLength: 4
          minLength: 3
        message:
          description: '[`Error message `](#appendix--enum--webhook-error-code)'
          type: string
          example: Company is disabled
          maxLength: 100
          minLength: 1
  securitySchemes:
    accountId:
      type: apiKey
      in: header
      name: x-auth-account-id
    accountPassword:
      type: apiKey
      in: header
      name: x-auth-account-password