Architecture/SEPA-TIS-Specs.md

+# **OpenAPI (Swagger) Specification
+
+Note: All endpoints will be on the same path, only `method` parameter will change
+
+```yaml
+swagger: '2.0'
+info:
+  description: API for TIS connection to DIS in SEPA connector project
+  version: 1.0.0
+  title: SEPA-TIS
+  # put the contact info for your development or API team
+  contact:
+    email: kbotor@syncad.com
+
+# tags are used for organizing operations
+tags:
+- name: input
+  description: Endpoints for mesages incoming from bank
+- name: output
+  description: Endpoints for messages outgoing to bank
+
+paths:
+  /paymentrequest:
+    post:
+      tags:
+      - output
+      summary: sends payment request to bank
+      operationId: paymentRequest
+      description: Sends ayment request to bank
+      consumes:
+      - application/json
+      produces:
+      - application/json
+      parameters:
+      - in: body
+        name: paymentRequest
+        description: Payment requet to send
+        schema:
+          $ref: '#/definitions/PaymentRequest'
+      responses:
+        200:
+          description: ALways HTTP code 200
+          schema: 
+            $ref: '#/definitions/Response'
+definitions:
+  PaymentRequest:
+    type: object
+    required:
+    - jsonrpc
+    - id
+    - method
+    - params
+    properties:
+      jsonrpc:
+        type: number
+        format: double
+        example: 1.0
+      id:
+        type: integer
+        example: 1
+      method:
+        type: string
+        example: ffcctrns
+      params:
+        type: array
+        items:
+            $ref: '#/definitions/PaymentRequestParams'
+  PaymentRequestParams:
+    type: object
+    required:
+      - doc_id
+      - type
+      - date_time
+      - priority
+      - bussiness_area
+      - date
+      - mtd
+      - prtry
+      - instr_id
+      - end_to_end_id
+      - cd
+      - amount
+      - currency
+      - tx_id
+      - chrg_br
+      - creditor_bic
+      - creditor_iban
+      - creditor_name
+      - creditor_country
+      - creditor_address_line1
+      - creditor_address_line2
+      - debtor_bic
+      - debtor_iban
+      - debtor_name
+      - debtor_country
+      - debtor_address_line1
+      - debtor_address_line2
+    properties:
+      doc_id:
+        type: string
+        example: D118091001045732
+      type:
+        type: string
+        example: FFCCTRNS
+      date_time:
+        type: string
+        format: date-time
+      priority:
+        type: integer
+        example: 51
+      bussiness_area:
+        type: string
+        example: SEAPSCT
+      date:
+        type: string
+        format: date
+      mtd:
+        type: string
+        example: CLRG
+      prtry:
+        type: string
+        example: LITAS-MIG
+      instr_id:
+        type: string
+        example: D118091001048175
+      end_to_end_id:
+        type: string
+        example: NOTPROVIDED
+      cd:
+        type: string
+        example: SEPA
+      amount:
+        type: number
+        format: double
+        example: 13.31
+      currency:
+        type: string
+        example: EUR
+      tx_id:
+        type: string
+        example: 8e7070743da24402a7fc290bc62fbcd0
+      chrg_br:
+        type: string
+        example: SLEV
+      creditor:
+        $ref: '#/definitions/Participant'
+      debtor:
+        $ref: '#/definitions/Participant'
+  Participant:
+    type: object
+    required:
+      - bic
+      - iban
+      - name
+    properties:
+      bic:
+        type: string
+        example: LIABLT20XXX
+      iban:
+        type: string
+        example: LT261010000002132402
+      name:
+        type: string
+        example: Dan Notestein
+      country:
+        type: string
+        example: LT
+      address_line1:
+        type: string
+      address_line2:
+        type: string
+  Response:
+    type: object
+    required:
+      - id
+    properties:
+      id:
+        type: integer
+        example: 1
+      result:
+        $ref: '#/definitions/Result'
+      error:
+        $ref: '#/definitions/Error'
+  Result:
+    type: object
+    required:
+     - doc_id
+     - status
+    properties:
+      doc_id:
+        type: string
+        example: D118091001045732
+      status:
+        type: string
+        example: Accepted
+  Error:
+    type: object
+    required:
+      - code
+      - message
+    properties:
+      code:
+        type: string
+        example: DIS-0001
+      message:
+        type: string
+        example: Document with given ID already exists
+host: localhost
+basePath: /
+schemes:
+ - https
+```
\ No newline at end of file