Architecture/SEPA-TIS-Specs.md

@@ -8,25 +8,21 @@ 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:
+  /payment-request:
     post:
       tags:
         - output
-      summary: sends payment request to bank
+      summary: Sends payment request to bank
       operationId: paymentRequest
-      description: Sends ayment request to bank
+      description: Sends payment request to bank
       consumes:
         - application/json
       produces:
@@ -38,7 +34,29 @@ paths:
           schema:
             $ref: '#/definitions/PaymentRequest'
       responses:
-        200:
+        '200':
+          description: ALways HTTP code 200
+          schema:
+            $ref: '#/definitions/Response'
+  /payment-return-request:
+    post:
+      tags:
+        - output
+      summary: Sends payment return request to bank
+      operationId: paymentReturnRequest
+      description: Sends payment return request to bank
+      consumes:
+        - application/json
+      produces:
+        - application/json
+      parameters:
+        - in: body
+          name: paymentReturnRequest
+          description: Payment requet to send
+          schema:
+            $ref: '#/definitions/PaymentReturnRequest'
+      responses:
+        '200':
           description: ALways HTTP code 200
           schema:
             $ref: '#/definitions/Response'
@@ -54,7 +72,7 @@ definitions:
       jsonrpc:
         type: number
         format: double
-        example: 1.0
+        example: 1
       id:
         type: integer
         example: 1
@@ -65,6 +83,28 @@ definitions:
         type: array
         items:
           $ref: '#/definitions/PaymentRequestParams'
+  PaymentReturnRequest:
+    type: object
+    required:
+      - jsonrpc
+      - id
+      - method
+      - params
+    properties:
+      jsonrpc:
+        type: number
+        format: double
+        example: 1
+      id:
+        type: integer
+        example: 1
+      method:
+        type: string
+        example: ffcctrns
+      params:
+        type: array
+        items:
+          $ref: '#/definitions/PaymentReturnRequestParams'
   PaymentRequestParams:
     type: object
     required:
@@ -136,6 +176,113 @@ definitions:
         $ref: '#/definitions/Participant'
       debtor:
         $ref: '#/definitions/Participant'
+  PaymentReturnRequestParams:
+    type: object
+    required:
+      - doc_id
+      - type
+      - date_time
+      - priority
+      - bussiness_area
+      - assignment_id
+      - assigner_bic
+      - assignee_bic
+      - cancellation_id
+      - original_message_id
+      - original_end_to_end_id
+      - original_amount
+      - original_currency
+      - original_date
+      - original_transfer_mtd
+      - original_transfer_prtry
+      - original_transfer_cd
+      - original_tx_id
+      - creditor
+      - debtor
+      - cancellation_reason
+      - cancelling_party
+    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
+      assignment_id:
+        type: string
+        example: Cx00003
+      assigner_bic:
+        type: string
+        example: PCTULT21XXX
+      assignee_bic:
+        type: string
+        example: LIABLT2XMSD
+      cancellation_id:
+        type: string
+        example: Cx00003
+      original_message_id:
+        type: string
+        example: D118091001045732
+      original_end_to_end_id:
+        type: string
+        example: NOTPROVIDED
+      original_tx_id:
+        type: string
+        example: 3
+      original_amount:
+        type: number
+        format: double
+        example: 13.31
+      original_currency:
+        type: string
+        example: EUR
+      original_date:
+        type: string
+        format: date
+      cancelling_party:
+        $ref: '#/definitions/CancellingParty'
+      cancellation_reason:
+        $ref: '#/definitions/CancellationReason'
+      original_transfer_mtd:
+        type: string
+        example: CLRG
+      original_transfer_prtry:
+        type: string
+        example: LITAS-MIG
+      original_transfer_cd:
+        type: string
+        example: SEPA
+      creditor:
+        $ref: '#/definitions/Participant'
+      debtor:
+        $ref: '#/definitions/Participant'
+  CancellingParty:
+    type: object
+    properties:
+      customer_name:
+        type: string
+        example: Dan Notestein or PCTULT21XXX
+      bank_bic:
+        type: string
+        example: PCTULT21XXX
+  CancellationReason:
+    type: object
+    properties:
+      iso_code:
+        type: string
+        example: DUPL
+      code:
+        type: string
+        example: FRAD or TECH
   Participant:
     type: object
     required:
@@ -195,7 +342,6 @@ definitions:
       message:
         type: string
         example: Document with given ID already exists
-# Added by API Auto Mocking Plugin
 host: localhost
 basePath: /
 schemes: