openapi: 3.0.1
info:
  title: Instant Payment Sanctions..
  description: This Application is for Instant Payment Sanctions
  version: 0.1.0
servers:
- url: http://localhost:8081/v1/api
  description: Generated server url
paths:
  /sanctions-hawkai:
    post:
      tags:
      - Sanctions
      summary: Gives the sanctions response for input provided
      description: Returns the result for Sanctions check
      operationId: checkSanctions
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SanctionsRequest'
        required: true
      responses:
        "400":
          description: Bad request
          content:
            application/json:
              example:
                returnCode: KO
                reasonCode: API_FAILURE
                reasonLabel: API fails with http code 400
        "500":
          description: An internal server error
          content:
            application/json:
              example:
                returnCode: KO
                reasonCode: API_FAILURE
                reasonLabel: API fails with http code 500
        "200":
          description: Successfully retrieved the Sanctions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SanctionsResponse'
        '401':
          description: Unauthorized Access
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '405':
          description: Method Not Allowed
        '409':
          description: Conflict
        '415':
          description: Unsupported Media Type
        '429':
          description: Too Many Requests
        '504':
          description: Gateway Timeout
components:
  schemas:
    SanctionsRequest:
      required:
      - creditorIBAN
      - creditorNm
      - debtorIBAN
      - debtorNm
      - intrBkSttlmAmt
      - intrBkSttlmAmtCcy
      - msgDirection
      - msgType
      - payloadId
      type: object
      properties:
        msgDirection:
          pattern: SND|RCV
          type: string
          description: The direction of processed message
          example: SND
        msgType:
          type: string
          description: 'The type of processed message '
          example: pacs.008
        payloadId:
          type: string
          description: Unique reference of the message related to the payload
          example: get10-7
        debtorNm:
          type: string
          description: Debtor name of the message
          example: Marchand Nathan
        creditorNm:
          type: string
          description: Creditor name of the message
          example: Dupuis Julie
        debtorIBAN:
          type: string
          description: Debtor IBAN of the message
          example: FR0310096000302981354579BXX
        creditorIBAN:
          type: string
          description: Creditor IBAN of the message
          example: FR031009600030298135457XXXX
        intrBkSttlmAmt:
          type: string
          description: Amount of the message.
          example: "99.98"
        intrBkSttlmAmtCcy:
          type: string
          description: Currency of the message.
          example: EUR
    SanctionsResponse:
      required:
      - reasonCode
      - reasonLabel
      - returnCode
      type: object
      properties:
        returnCode:
          maxLength: 2
          minLength: 2
          type: string
          description: Return code of Sanctions
          example: OK
        reasonCode:
          maxLength: 15
          minLength: 1
          type: string
          description: Reason code of Sanctions
          example: ""
        reasonLabel:
          type: string
          description: Reason Label of Sanctions
          example: ""