openapi: 3.0.1
info:
  title: OpenAPI definition
  version: v0
servers:
- url: http://po-external-gateway-api-microservice.payments/api
  description: Generated server url
paths:
  /v1/payments:settleInstantPayment:
    post:
      tags:
      - payments-controller
      description: Accepts requests for an instant payment settlement.
      operationId: settleInstantPayment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InstantPaymentSettlement'
            examples:
              instantPaymentSettlementRequest:
                summary: Request settlement for an instant payment.
                description: instantPaymentSettlementRequest
                value:
                  groupHeader:
                    messageIdentification: SCTORD200020190305ORD000011119
                  transaction:
                    debtorAgent:
                      institutionIdentification:
                        bicfi: FUBKDE71
                    paymentIdentification:
                      transactionIdentification: 00730100632BHGCRWC
                      acceptanceDateTime: 2023-04-05T09:07:37
        required: true
      responses:
        "202":
          description: Accepted - The instant payment settlement request has been
            accepted for processing.
        "400":
          description: Bad Request - Validation error occurred. This code will cover
            malformed syntax in request or incorrect data in payload.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                missingMandatoryField:
                  summary: Message identification for group header was not provided.
                  description: missingMandatoryField
                  value:
                    tppMessages:
                    - category: ERROR
                      code: FORMAT_ERROR
                      path: groupHeader.messageIdentification
                      text: groupHeader.messageIdentification may not be null
        "405":
          description: "Method Not Allowed - This code is only sent when the HTTP\
            \ method (PUT, POST, DELETE, GET etc.) is not supported by a specific\
            \ endpoint. It has nothing to do with the content, payment or account\
            \ information data model."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                unsupportedHttpMethod:
                  summary: The request was submitted with an unsupported HTTP method.
                  description: unsupportedHttpMethod
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: There was an error processing your request. It has been
                        logged (ID a449ea6319107e42).
        "415":
          description: Unsupported Media Type - A media type which the serves does
            not support has been supplied.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                unsupportedContentType:
                  summary: The request was submitted with an unsupported content type.
                    For example "application/xml" instead of "application/json".
                  description: unsupportedContentType
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: There was an error processing your request. It has been
                        logged (ID a449ea6319107e42).
        "500":
          description: Internal Server Error - Internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                internalServerError:
                  summary: The request failed due to an internal server error.
                  description: internalServerError
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: There was an error processing your request. It has been
                        logged (ID a449ea6319107e42).
        "503":
          description: "Service Unavailable - The server is currently unavailable.\
            \ Generally, this is a temporary state."
  /v1/payments/{paymentOrderId}:reject:
    post:
      tags:
      - payments-controller
      description: Manually Reject an Outgoing Payment.
      operationId: manuallyRejectOutgoingPayment
      parameters:
      - name: paymentOrderId
        in: path
        required: true
        schema:
          type: string
      - name: actionUser
        in: query
        required: true
        schema:
          type: string
      responses:
        "200":
          description: OK - The specified payment order has been marked to be manually
            rejected.
        "400":
          description: Bad Request - Validation error occurred. This code will cover
            malformed syntax in request or incorrect data in payload.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                invalidTransactionStatus:
                  summary: Transaction status is invalid for manual rejection.
                  description: invalidTransactionStatus
                  value:
                    tppMessages:
                    - category: ERROR
                      code: INVALID_TRANSACTION_STATUS
                      text: "Transaction has invalid status: TO_BE_REJECTED. Expected\
                        \ status is: TO_BE_SENT."
        "500":
          description: Internal Server Error - Internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                internalServerError:
                  summary: The request failed due to an internal server error.
                  description: internalServerError
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: There was an error processing your request. It has been
                        logged (ID a449ea6319107e42).
        "503":
          description: "Service Unavailable - The server is currently unavailable.\
            \ Generally, this is a temporary state."
  /v1/payments/{paymentOrderId}:recall:
    post:
      tags:
      - recall-controller
      description: Recall an outgoing payment.
      operationId: recallOutgoingPayment
      parameters:
      - name: paymentOrderId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Recall'
        required: true
      responses:
        "200":
          description: OK - Payment marked to be recalled successfully.
        "400":
          description: Bad Request - Validation error occurred. This code will cover
            malformed syntax in request or incorrect data in payload.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                badRecallReasonCode:
                  summary: A non SEPA compliant recall reason code was provided.
                  description: badRecallReasonCode
                  value:
                    tppMessages:
                    - category: ERROR
                      code: INVALID_REQUEST_BODY
                      text: ""
        "500":
          description: Internal Server Error - Internal server error occurred.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                internalServerError:
                  summary: The request failed due to an internal server error.
                  description: internalServerError
                  value: |-
                    {
                      "tppMessages": [
                        {
                          "category": "ERROR",
                          "code": "SERVICE_INVALID",
                          "text": "There was an error processing your request.     }
                      ]
                    }
        "503":
          description: "Service Unavailable - The server is currently unavailable.\
            \ Generally, this is a temporary state."
  /v1/payments/{paymentOrderId}:denyOutgoingRecall:
    post:
      tags:
      - recall-controller
      description: Deny an Outgoing Recall.
      operationId: denyOutgoingRecall
      parameters:
      - name: paymentOrderId
        in: path
        required: true
        schema:
          type: string
      responses:
        "200":
          description: OK - The specified outgoing recall has been marked to be rejected.
        "400":
          description: Bad Request - Validation error occurred. This code will cover
            malformed syntax in request or incorrect data in payload.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                invalidPaymentOrderId:
                  summary: No payment order found for given id.
                  description: invalidPaymentOrderId
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: original transaction for Payment Order bac5161bd53348fa8dfc143cae49ba13
                        not found
        "500":
          description: Internal Server Error - Internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                internalServerError:
                  summary: The request failed due to an internal server error.
                  description: internalServerError
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: There was an error processing your request. It has been
                        logged (ID a449ea6319107e42).
        "503":
          description: "Service Unavailable - The server is currently unavailable.\
            \ Generally, this is a temporary state."
  /v1/payments/{paymentOrderId}:denyIncomingRecall:
    post:
      tags:
      - recall-controller
      description: Deny an Incoming Recall.
      operationId: denyIncomingRecall
      parameters:
      - name: paymentOrderId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancellationDetails'
        required: true
      responses:
        "200":
          description: OK - The specified incoming recall has been marked to be rejected.
        "400":
          description: Bad Request - Validation error occurred. This code will cover
            malformed syntax in request or incorrect data in payload.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                invalidRequest:
                  summary: The request is invalid for the current state of the transaction.
                  description: invalidRequest
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: "Database update failed due to invalid request, expected\
                        \ number of updated rows is 1, actual number is: 0. The error\
                        \ message is: pending.authorized.failed"
        "500":
          description: Internal Server Error - Internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                internalServerError:
                  summary: The request failed due to an internal server error.
                  description: internalServerError
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: There was an error processing your request. It has been
                        logged (ID a449ea6319107e42).
        "503":
          description: "Service Unavailable - The server is currently unavailable.\
            \ Generally, this is a temporary state."
  /v1/payments/{paymentOrderId}:approveOutgoingRecall:
    post:
      tags:
      - recall-controller
      description: Approve an Outgoing Recall.
      operationId: approveOutgoingRecall
      parameters:
      - name: paymentOrderId
        in: path
        required: true
        schema:
          type: string
      responses:
        "200":
          description: OK - The specified outgoing recall has been authorized.
        "400":
          description: Bad Request - Validation error occurred. This code will cover
            malformed syntax in request or incorrect data in payload.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                invalidPaymentOrderId:
                  summary: No payment order found for given id.
                  description: invalidPaymentOrderId
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: original transaction for Payment Order bac5161bd53348fa8dfc143cae49ba13
                        not found
        "500":
          description: Internal Server Error - Internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                internalServerError:
                  summary: The request failed due to an internal server error.
                  description: internalServerError
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: There was an error processing your request. It has been
                        logged (ID a449ea6319107e42).
        "503":
          description: "Service Unavailable - The server is currently unavailable.\
            \ Generally, this is a temporary state."
  /v1/payments/{paymentOrderId}:approveIncomingRecall:
    post:
      tags:
      - recall-controller
      description: Approve an Incoming Recall.
      operationId: approveIncomingRecall
      parameters:
      - name: paymentOrderId
        in: path
        required: true
        schema:
          type: string
      responses:
        "200":
          description: OK - The specified incoming recall has been authorized.
        "400":
          description: Bad Request - Validation error occurred. This code will cover
            malformed syntax in request or incorrect data in payload.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                invalidRequest:
                  summary: The request is invalid for the current state of the transaction.
                  description: invalidRequest
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: "Database update failed due to invalid request, expected\
                        \ number of updated rows is 1, actual number is: 0. The error\
                        \ message is: pending.authorized.failed"
        "500":
          description: Internal Server Error - Internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                internalServerError:
                  summary: The request failed due to an internal server error.
                  description: internalServerError
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: There was an error processing your request. It has been
                        logged (ID a449ea6319107e42).
        "503":
          description: "Service Unavailable - The server is currently unavailable.\
            \ Generally, this is a temporary state."
  /v1/payments/{paymentOrderId}/aml:resendCallout:
    post:
      tags:
      - aml-controller
      description: Resends the AML callout for an Outgoing payment.
      operationId: resendCTAmlCallout
      parameters:
      - name: paymentOrderId
        in: path
        required: true
        schema:
          type: string
      responses:
        "200":
          description: OK - The AML callout was resent for the provided payment order.
        "400":
          description: Bad Request - Validation error occurred. This code will cover
            malformed syntax in request or incorrect data in payload.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                invalidRequestBody:
                  summary: No transactions that allow resending the AML callout were
                    found.
                  description: invalidRequestBody
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: "Failed to find any valid Sepa Transaction for the given\
                        \ request. The error message is: resend.aml.callout.failed"
        "405":
          description: "Method Not Allowed - This code is only sent when the HTTP\
            \ method (PUT, POST, DELETE, GET etc.) is not supported on a specific\
            \ endpoint. It has nothing to do with the consent, payment or account\
            \ information data model."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                unsupportedHttpMethod:
                  summary: The request was submitted with an unsupported HTTP method.
                  description: unsupportedHttpMethod
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: There was an error processing your request. It has been
                        logged (ID a449ea6319107e42).
        "500":
          description: Internal Server Error - Internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                internalServerError:
                  summary: The request failed due to an internal server error.
                  description: internalServerError
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: There was an error processing your request. It has been
                        logged (ID a449ea6319107e42).
        "503":
          description: "Service Unavailable - The server is currently unavailable.\
            \ Generally, this is a temporary state."
  /v1/payments/incoming:
    post:
      tags:
      - incoming-message-controller
      description: Creates an incoming message request.
      operationId: submitIncomingMessage
      parameters:
      - name: X-Request-ID
        in: header
        description: "ID of the request, unique to the call, as determined by the\
          \ initiating party."
        required: true
        schema:
          type: string
          description: "ID of the request, unique to the call, as determined by the\
            \ initiating party."
      - name: X-Payment-Scheme
        in: header
        description: Specifies payment scheme for processing.
        required: false
        schema:
          type: string
          description: Specifies payment scheme for processing.
      - name: Content-Type
        in: header
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/xml:
            schema:
              type: string
            examples:
              incomingCreditTransferRequest:
                summary: Request processing for the given incoming pacs.008 message.
                description: incomingCreditTransferRequest
                value: <Document xmlns="urn:iso:std:iso:20022:tech:xsd:pacs.008.001.02"><FIToFICstmrCdtTrf>
                  ... </FIToFICstmrCdtTrf></Document>
          text/plain:
            schema:
              type: string
        required: true
      responses:
        "202":
          description: "Accepted - Incoming file accepted and is due for processing,\
            \ when incoming scheduler is configured to run. Outgoing (complete / partial)\
            \ pacs.002 will be published in case of complete / partial processing\
            \ of incoming pacs.008. If the incoming pacs.008 is completely failed\
            \ then a rejected pacs.002 will be published. Outgoing pacs.004 will be\
            \ published for failed transaction from incoming pacs.008."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IncomingMessageResponse'
              examples:
                incomingPacs008Response:
                  summary: Successful accept incoming payment message
                  description: incomingPacs008Response
                  value:
                    messageId: SCTORD200020190305ORD000011119
                    messageType: urn:iso:std:iso:20022:tech:xsd:pacs.008.001.02
                incomingCamt056Response:
                  summary: Successful accept incoming payment recall message
                  description: incomingCamt056Response
                  value:
                    messageId: 568R9154000000000000000000000000010
                    messageType: urn:iso:std:iso:20022:tech:xsd:camt.056.001.01
        "400":
          description: Bad Request - Validation error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                invalidValueForField:
                  summary: Field contains an invalid value.
                  description: invalidValueForField
                  value:
                    tppMessages:
                    - category: ERROR
                      code: FORMAT_ERROR
                      text: The request body may not be empty
        "405":
          description: "Method Not Allowed - This code is only sent when the HTTP\
            \ method (PUT, POST, DELETE, GET etc.) is not supported on a specific\
            \ endpoint. It has nothing to do with the consent, payment or account\
            \ information data model."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                unsupportedHttpMethod:
                  summary: The request was submitted with an unsupported HTTP method.
                  description: unsupportedHttpMethod
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: There was an error processing your request. It has been
                        logged (ID a449ea6319107e42).
        "415":
          description: Unsupported Media Type - A media type which the server does
            not support has been supplied.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                unsupportedContentType:
                  summary: The request was submitted with an unsupported content type.
                    For example "application/json" instead of "application/xml".
                  description: unsupportedContentType
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: There was an error processing your request. It has been
                        logged (ID a449ea6319107e42).
        "500":
          description: Internal Server Error - Internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                internalServerError:
                  summary: The request failed due to an internal server error.
                  description: internalServerError
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: There was an error processing your request. It has been
                        logged (ID a449ea6319107e42).
        "503":
          description: "Service Unavailable - The server is currently unavailable.\
            \ Generally, this is a temporary state."
  /v1/payments/aml:
    post:
      tags:
      - AML
      description: "Accepts AML check results for Payment Orders, for example SEPA\
        \ Credit Transfers."
      operationId: processAmlResponse
      parameters:
      - name: Content-Type
        in: header
        description: application/json
        required: true
      - name: X-Request-ID
        in: header
        description: "ID of the request, unique to the call, as determined by the\
          \ initiating party."
        required: true
        schema:
          type: string
          description: "ID of the request, unique to the call, as determined by the\
            \ initiating party."
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AmlResult'
            examples:
              amlInformation:
                summary: AML check result.
                description: amlInformation
                value:
                  groupHeader:
                    messageIdentification: SCTORD200020190305ORD000011119
                  transactions:
                  - status: Accepted
                    paymentIdentification:
                      transactionIdentification: 00730100632BHGCRWC
                    debtorAgent:
                      institutionIdentification:
                        bicfi: BTRLRO22
                    interbankSettlementDate: 2019-06-28
        required: true
      responses:
        "200":
          description: OK - The AML check result has been prepared for processing.
          content:
            '*/*':
              schema:
                type: string
        "400":
          description: Bad Request - Validation error occurred. This code will cover
            malformed syntax in request or incorrect data in payload.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                missingMandatoryField:
                  summary: Message identification for group header was not provided.
                  description: missingMandatoryField
                  value:
                    tppMessages:
                    - category: ERROR
                      code: FORMAT_ERROR
                      path: groupHeader.messageIdentification
                      text: groupHeader.messageIdentification may not be null
        "405":
          description: "Method Not Allowed - This code is only sent when the HTTP\
            \ method (PUT, POST, DELETE, GET etc.) is not supported by a specific\
            \ endpoint. It has nothing to do with the content, payment or account\
            \ information data model."
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                unsupportedHttpMethod:
                  summary: The request was submitted with an unsupported HTTP method.
                  description: unsupportedHttpMethod
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: There was an error processing your request. It has been
                        logged (ID a449ea6319107e42).
        "415":
          description: Unsupported Media Type - A media type which the serves does
            not support has been supplied.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                unsupportedContentType:
                  summary: The request was submitted with an unsupported content type.
                    For example "application/xml" instead of "application/json".
                  description: unsupportedContentType
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: There was an error processing your request. It has been
                        logged (ID a449ea6319107e42).
        "500":
          description: Internal Server Error - Internal server error occurred.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                internalServerError:
                  summary: The request failed due to an internal server error.
                  description: internalServerError
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: There was an error processing your request. It has been
                        logged (ID a449ea6319107e42).
        "503":
          description: "Service Unavailable - The server is currently unavailable.\
            \ Generally, this is a temporary state."
          content:
            '*/*':
              schema:
                type: string
  /v1/inquiries:skipStatusUpdateOnRecall:
    post:
      tags:
      - incoming-inquiry-controller
      description: Skips response for Request for Status Update on Recall with given
        details.
      operationId: skipStatusUpdateOnRecall
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SkipStatusUpdateOnRecall'
            examples:
              skipStatusUpdateOnRecall:
                summary: Request for skipping Request for Status Update on Recall
                  response
                description: skipStatusUpdateOnRecall
                value:
                  groupHeader:
                    messageIdentification: 82d7125b36014c2e8cc442a3586badd0
                    creationDateTime: 2021-02-10T10:03:25
                    instructingAgent: ABCDE123
                  transactionInformation:
                    statusRequestIdentification: 4112f6688c846a89bee2b2c476f1145
        required: true
      responses:
        "200":
          description: OK - Request for skipping Status Update on Recall response
            was received
        "400":
          description: Bad Request - Invalid Transaction Status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                invalidTransactionStatus:
                  summary: Transaction status is invalid for skipping Status Update
                    on Recall response.
                  description: invalidTransactionStatus
                  value:
                    tppMessages:
                    - category: ERROR
                      code: INVALID_TRANSACTION_STATUS
                      text: "Transaction has invalid status: REPLY_SKIPPED"
        "404":
          description: Not Found - No message found for the given identification.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                messageNotFound:
                  summary: No message found for the given identification.
                  description: messageNotFound
                  value:
                    tppMessages:
                    - category: ERROR
                      code: NOT_FOUND
                      text: No pacs.028.001.01 was found for the supplied details
        "405":
          description: "Method Not Allowed - This code is only sent when the HTTP\
            \ method (PUT, POST, DELETE, GET etc.) is not supported on a specific\
            \ endpoint. It has nothing to do with the consent, payment or account\
            \ information data model."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                unsupportedHttpMethod:
                  summary: The request was submitted with an unsupported HTTP method.
                  description: unsupportedHttpMethod
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: There was an error processing your request. It has been
                        logged (ID a449ea6319107e42).
        "415":
          description: Unsupported Media Type - A media type which the server does
            not support has been supplied.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                unsupportedContentType:
                  summary: The request was submitted with an unsupported content type.
                    For example "application/xml" instead of "application/json".
                  description: unsupportedContentType
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: There was an error processing your request. It has been
                        logged (ID a449ea6319107e42).
        "500":
          description: Internal Server Error - Internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                internalServerError:
                  summary: The request failed due to an internal server error.
                  description: internalServerError
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: There was an error processing your request. It has been
                        logged (ID a449ea6319107e42).
        "503":
          description: "Service Unavailable - The server is currently unavailable.\
            \ Generally, this is a temporary state."
  /v1/inquiries:requestStatusUpdateOnRecall:
    post:
      tags:
      - inquiries-controller
      description: Create inquiry to request status update for a payment cancellation.
      operationId: requestStatusUpdateOnRecall
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OriginalCamt056Data'
        required: true
      responses:
        "200":
          description: OK - Inquiry created successfully.
        "400":
          description: Bad Request - The original Payment Cancellation Request transaction
            not found. Please check the input parameters.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                originalTransactionNotFound:
                  summary: The original Payment Cancellation Request transaction not
                    found.
                  description: originalTransactionNotFound
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: original transaction for Payment Cancellation Request
                        123456 not found
        "500":
          description: Internal Server Error - Internal server error occurred.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                internalServerError:
                  summary: The request failed due to an internal server error.
                  description: internalServerError
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: There was an error processing your request. It has been
                        logged (ID a449ea6319107e42).
        "503":
          description: "Service Unavailable - The server is currently unavailable.\
            \ Generally, this is a temporary state."
  /v1/inquiries:requestStatusUpdateOnInquiry:
    post:
      tags:
      - inquiries-controller
      description: Create status update request for existing camt.087 or camt.027
        inquiry
      operationId: requestStatusUpdateOnInquiry
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OriginalInquiryData'
        required: true
      responses:
        "200":
          description: OK - Inquiry created successfully.
        "400":
          description: Bad Request - The original Credit transfer transaction not
            found. Please check the input parameters.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                originalTransactionNotFound:
                  summary: The original Credit transfer transaction not found.
                  description: originalTransactionNotFound
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: original transaction for Payment Cancellation Request
                        123456 not found
        "500":
          description: Internal Server Error - Internal server error occurred.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                internalServerError:
                  summary: The request failed due to an internal server error.
                  description: internalServerError
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: There was an error processing your request. It has been
                        logged (ID a449ea6319107e42).
        "503":
          description: "Service Unavailable - The server is currently unavailable.\
            \ Generally, this is a temporary state."
  /v1/inquiries:rejectStatusUpdateOnRecall:
    post:
      tags:
      - incoming-inquiry-controller
      description: Handles negative response for Request for Status Update on Recall
        with given details.
      operationId: rejectStatusUpdateOnRecall
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RejectStatusUpdateOnRecall'
            examples:
              rejectStatusUpdateOnRecall:
                summary: Request for handling Request for Status Update on Recall
                  negative response
                description: rejectStatusUpdateOnRecall
                value:
                  groupHeader:
                    messageIdentification: 82d7125b36014c2e8cc442a3586badd0
                    creationDateTime: 2021-02-10T10:03:25
                    instructingAgent: ABCDE123
                  transactionInformation:
                    statusRequestIdentification: 4112f6688c846a89bee2b2c476f1145
                    originalMessageIdentification: 22b8f938c6154877886a0c1fc9e74166
                    originalInstructionIdentification: 562f8f9f8c6154844886a0c1fc9e7451
                  cancellationDetails:
                    rejectionReason: ARDT
        required: true
      responses:
        "200":
          description: OK - Request for Status Update on Recall negative response
            was received
        "400":
          description: Bad Request - Validation error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                invalidValueForField:
                  summary: Field contains an invalid value.
                  description: invalidValueForField
                  value:
                    tppMessages:
                    - category: ERROR
                      code: FORMAT_ERROR
                      text: The request body must not be empty
        "404":
          description: Not Found - No message found for the given identification.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                messageNotFound:
                  summary: No message found for the given identification.
                  description: messageNotFound
                  value:
                    tppMessages:
                    - category: ERROR
                      code: NOT_FOUND
                      text: No pacs.028.001.01 was found for the supplied details
        "405":
          description: "Method Not Allowed - This code is only sent when the HTTP\
            \ method (PUT, POST, DELETE, GET etc.) is not supported on a specific\
            \ endpoint. It has nothing to do with the consent, payment or account\
            \ information data model."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                unsupportedHttpMethod:
                  summary: The request was submitted with an unsupported HTTP method.
                  description: unsupportedHttpMethod
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: There was an error processing your request. It has been
                        logged (ID a449ea6319107e42).
        "415":
          description: Unsupported Media Type - A media type which the server does
            not support has been supplied.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                unsupportedContentType:
                  summary: The request was submitted with an unsupported content type.
                    For example "application/xml" instead of "application/json".
                  description: unsupportedContentType
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: There was an error processing your request. It has been
                        logged (ID a449ea6319107e42).
        "500":
          description: Internal Server Error - Internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                internalServerError:
                  summary: The request failed due to an internal server error.
                  description: internalServerError
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: There was an error processing your request. It has been
                        logged (ID a449ea6319107e42).
        "503":
          description: "Service Unavailable - The server is currently unavailable.\
            \ Generally, this is a temporary state."
  /v1/inquiries:claimValueDateCorrection:
    post:
      tags:
      - inquiries-controller
      description: Create inquiry to request claim for value-date change.
      operationId: requestStatusUpdateOnValueDateCorrection
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OriginalPacs008Data'
        required: true
      responses:
        "200":
          description: OK - Inquiry created successfully.
        "400":
          description: Bad Request - The original Credit Transfer transaction not
            found. Please check the input parameters.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                originalTransactionNotFound:
                  summary: The original Credit Transfer transaction not found.
                  description: originalTransactionNotFound
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: original Credit Transfer transaction for 123456 not found
        "500":
          description: Internal Server Error - Internal server error occurred.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                internalServerError:
                  summary: The request failed due to an internal server error.
                  description: internalServerError
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: There was an error processing your request. It has been
                        logged (ID a449ea6319107e42).
        "503":
          description: "Service Unavailable - The server is currently unavailable.\
            \ Generally, this is a temporary state."
  /v1/inquiries:claimNonReceipt:
    post:
      tags:
      - inquiries-controller
      description: Create inquiry for claim of non-receipt
      operationId: claimNonReceipt
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OriginalPacs008Data'
        required: true
      responses:
        "200":
          description: OK - Inquiry created successfully.
        "400":
          description: Bad Request - The original Credit transfer transaction not
            found. Please check the input parameters.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                originalTransactionNotFound:
                  summary: The original Credit transfer transaction not found.
                  description: originalTransactionNotFound
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: original transaction for Payment Cancellation Request
                        123456 not found
        "500":
          description: Internal Server Error - Internal server error occurred.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                internalServerError:
                  summary: The request failed due to an internal server error.
                  description: internalServerError
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: There was an error processing your request. It has been
                        logged (ID a449ea6319107e42).
        "503":
          description: "Service Unavailable - The server is currently unavailable.\
            \ Generally, this is a temporary state."
  /v1/inquiries:acceptStatusUpdateOnRecall:
    post:
      tags:
      - incoming-inquiry-controller
      description: Handles positive response for Request for Status Update on Recall
        with given details.
      operationId: acceptStatusUpdateOnRecall
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AcceptStatusUpdateOnRecall'
            examples:
              acceptStatusUpdateOnRecall:
                summary: Request for handling Request for Status Update on Recall
                  positive response
                description: acceptStatusUpdateOnRecall
                value:
                  groupHeader:
                    messageIdentification: 82d7125b36014c2e8cc442a3586badd0
                    creationDateTime: 2021-02-10T10:03:25
                    instructingAgent: ABCDE123
                  transactionInformation:
                    statusRequestIdentification: 4112f6688c846a89bee2b2c476f1145
                    originalMessageIdentification: 22b8f938c6154877886a0c1fc9e74166
                    originalInstructionIdentification: 562f8f9f8c6154844886a0c1fc9e7451
        required: true
      responses:
        "200":
          description: OK - Request for Status Update on Recall positive response
            was received
        "400":
          description: Bad Request - Validation error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                invalidValueForField:
                  summary: Field contains an invalid value.
                  description: invalidValueForField
                  value:
                    tppMessages:
                    - category: ERROR
                      code: FORMAT_ERROR
                      text: The request body must not be empty
        "404":
          description: Not Found - No message found for the given identification.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                messageNotFound:
                  summary: No message found for the given identification.
                  description: messageNotFound
                  value:
                    tppMessages:
                    - category: ERROR
                      code: NOT_FOUND
                      text: No pacs.028.001.01 was found for the supplied details
        "405":
          description: "Method Not Allowed - This code is only sent when the HTTP\
            \ method (PUT, POST, DELETE, GET etc.) is not supported on a specific\
            \ endpoint. It has nothing to do with the consent, payment or account\
            \ information data model."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                unsupportedHttpMethod:
                  summary: The request was submitted with an unsupported HTTP method.
                  description: unsupportedHttpMethod
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: There was an error processing your request. It has been
                        logged (ID a449ea6319107e42).
        "415":
          description: Unsupported Media Type - A media type which the server does
            not support has been supplied.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                unsupportedContentType:
                  summary: The request was submitted with an unsupported content type.
                    For example "application/xml" instead of "application/json".
                  description: unsupportedContentType
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: There was an error processing your request. It has been
                        logged (ID a449ea6319107e42).
        "500":
          description: Internal Server Error - Internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                internalServerError:
                  summary: The request failed due to an internal server error.
                  description: internalServerError
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: There was an error processing your request. It has been
                        logged (ID a449ea6319107e42).
        "503":
          description: "Service Unavailable - The server is currently unavailable.\
            \ Generally, this is a temporary state."
  /v1/collections/{collectionOrderId}:reject:
    post:
      tags:
      - collections-controller
      description: Manually Reject an Outgoing Collection.
      operationId: manuallyRejectOutgoingCollection
      parameters:
      - name: collectionOrderId
        in: path
        required: true
        schema:
          type: string
      - name: actionUser
        in: query
        required: true
        schema:
          type: string
      responses:
        "200":
          description: OK - The specified collection order has been marked to be manually
            rejected.
        "400":
          description: Bad Request - Validation error occurred. This code will cover
            malformed syntax in request or incorrect data in payload.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                invalidTransactionStatus:
                  summary: Transaction status is invalid for manual rejection.
                  description: invalidTransactionStatus
                  value:
                    tppMessages:
                    - category: ERROR
                      code: INVALID_TRANSACTION_STATUS
                      text: "Transaction has invalid status: TO_BE_REJECTED. Expected\
                        \ status is: TO_BE_SENT."
        "500":
          description: Internal Server Error - Internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                internalServerError:
                  summary: The request failed due to an internal server error.
                  description: internalServerError
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: There was an error processing your request. It has been
                        logged (ID a449ea6319107e42).
        "503":
          description: "Service Unavailable - The server is currently unavailable.\
            \ Generally, this is a temporary state."
  /v1/collections/{collectionOrderId}:rejectIncoming:
    post:
      tags:
      - collections-controller
      description: Manually Reject an Incoming Collection.
      operationId: manuallyRejectIncomingCollection
      parameters:
      - name: collectionOrderId
        in: path
        required: true
        schema:
          type: string
      - name: actionUser
        in: query
        required: true
        schema:
          type: string
      responses:
        "200":
          description: OK - The specified collection order has been marked to be manually
            rejected.
        "400":
          description: Bad Request - Validation error occurred. This code will cover
            malformed syntax in request or incorrect data in payload.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                invalidTransactionStatus:
                  summary: Transaction status is invalid for manual rejection.
                  description: invalidTransactionStatus
                  value:
                    tppMessages:
                    - category: ERROR
                      code: INVALID_TRANSACTION_STATUS
                      text: "Transaction has invalid status: TO_BE_REJECTED. Expecting\
                        \ one of the following statuses: PENDING_SETTLEMENT, RECEIVED."
        "500":
          description: Internal Server Error - Internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                internalServerError:
                  summary: The request failed due to an internal server error.
                  description: internalServerError
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: There was an error processing your request. It has been
                        logged (ID a449ea6319107e42).
        "503":
          description: "Service Unavailable - The server is currently unavailable.\
            \ Generally, this is a temporary state."
  /v1/collections/{collectionId}:reverse:
    post:
      tags:
      - collections-controller
      description: Reverse a Collection Instruction.
      operationId: reverse
      parameters:
      - name: collectionId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Reverse'
        required: true
      responses:
        "200":
          description: OK - Collection Instruction marked to be reversed successfully.
        "400":
          description: Bad Request - Validation error occurred. This code will cover
            malformed syntax in request or incorrect data in payload.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                badReversalReasonCode:
                  summary: A non SEPA compliant refund reason code was provided.
                  description: badReversalReasonCode
                  value:
                    tppMessages:
                    - category: ERROR
                      code: PARAMETER_NOT_SUPPORTED
                      text: value 'MS01' not supported
        "500":
          description: Internal Server Error - Internal server error occurred.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                internalServerError:
                  summary: The request failed due to an internal server error.
                  description: internalServerError
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: There was an error processing your request. It has been
                        logged (ID a449ea6319107e42).
        "503":
          description: "Service Unavailable - The server is currently unavailable.\
            \ Generally, this is a temporary state."
  /v1/collections/{collectionId}:refund:
    post:
      tags:
      - collections-controller
      description: Refund a Collection Instruction.
      operationId: refund
      parameters:
      - name: collectionId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Refund'
        required: true
      responses:
        "200":
          description: OK - Collection Instruction marked to be refunded successfully.
        "400":
          description: Bad Request - Validation error occurred. This code will cover
            malformed syntax in request or incorrect data in payload.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                badRefundReasonCode:
                  summary: A non SEPA compliant refund reason code was provided.
                  description: badRefundReasonCode
                  value:
                    tppMessages:
                    - category: ERROR
                      code: PARAMETER_NOT_SUPPORTED
                      text: value 'MD02' not supported
        "500":
          description: Internal Server Error - Internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                internalServerError:
                  summary: The request failed due to an internal server error.
                  description: internalServerError
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: There was an error processing your request. It has been
                        logged (ID a449ea6319107e42).
        "503":
          description: "Service Unavailable - The server is currently unavailable.\
            \ Generally, this is a temporary state."
  /v1/collections/{collectionId}/aml:resendCallout:
    post:
      tags:
      - aml-controller
      description: Resends the AML callout for an Outgoing collection.
      operationId: resendDDAmlCallout
      parameters:
      - name: collectionId
        in: path
        required: true
        schema:
          type: string
      responses:
        "200":
          description: OK - The AML callout was resent for the provided collection
            order.
        "400":
          description: Bad Request - Validation error occurred. This code will cover
            malformed syntax in request or incorrect data in payload.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                invalidRequestBody:
                  summary: No transactions that allow resending the AML callout were
                    found.
                  description: invalidRequestBody
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: "Failed to find any valid Sepa Transaction for the given\
                        \ request. The error message is: resend.aml.callout.failed"
        "405":
          description: "Method Not Allowed - This code is only sent when the HTTP\
            \ method (PUT, POST, DELETE, GET etc.) is not supported on a specific\
            \ endpoint. It has nothing to do with the consent, payment or account\
            \ information data model."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                unsupportedHttpMethod:
                  summary: The request was submitted with an unsupported HTTP method.
                  description: unsupportedHttpMethod
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: There was an error processing your request. It has been
                        logged (ID a449ea6319107e42).
        "500":
          description: Internal Server Error - Internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                internalServerError:
                  summary: The request failed due to an internal server error.
                  description: internalServerError
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: There was an error processing your request. It has been
                        logged (ID a449ea6319107e42).
        "503":
          description: "Service Unavailable - The server is currently unavailable.\
            \ Generally, this is a temporary state."
  /v1/collections/aml:
    post:
      tags:
      - AML
      description: "Accepts AML check results for collections, for example, SEPA Direct\
        \ Debits."
      operationId: processAmlResponse_1
      parameters:
      - name: Content-Type
        in: header
        description: application/json
        required: true
      - name: X-Request-ID
        in: header
        description: "ID of the request, unique to the call, as determined by the\
          \ initiating party."
        required: true
        schema:
          type: string
          description: "ID of the request, unique to the call, as determined by the\
            \ initiating party."
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AmlResult'
            examples:
              amlInformation:
                summary: AML check result.
                description: amlInformation
                value:
                  groupHeader:
                    messageIdentification: SCTORD200020190305ORD000011119
                  transactions:
                  - status: Accepted
                    collectionIdentification:
                      transactionIdentification: 00730100632BHGCRWC
                    creditorAgent:
                      institutionIdentification:
                        bicfi: BTRLRO22
                    interbankSettlementDate: 2019-06-28
        required: true
      responses:
        "200":
          description: OK - The AML check result has been prepared for processing.
          content:
            '*/*':
              schema:
                type: string
        "400":
          description: Bad Request - Validation error occurred. This code will cover
            malformed syntax in request or incorrect data in payload.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                missingMandatoryField:
                  summary: Message identification for group header was not provided.
                  description: missingMandatoryField
                  value:
                    tppMessages:
                    - category: ERROR
                      code: FORMAT_ERROR
                      path: groupHeader.messageIdentification
                      text: groupHeader.messageIdentification may not be null
        "405":
          description: "Method Not Allowed - This code is only sent when the HTTP\
            \ method (PUT, POST, DELETE, GET etc.) is not supported by a specific\
            \ endpoint. It has nothing to do with the consent, payment or account\
            \ information data model."
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                unsupportedHttpMethod:
                  summary: The request was submitted with an unsupported HTTP method.
                  description: unsupportedHttpMethod
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: There was an error processing your request. It has been
                        logged (ID a449ea6319107e42).
        "415":
          description: Unsupported Media Type - A media type which the serves does
            not support has been supplied.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                unsupportedContentType:
                  summary: The request was submitted with an unsupported content type.
                    For example "application/xml" instead of "application/json".
                  description: unsupportedContentType
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: There was an error processing your request. It has been
                        logged (ID a449ea6319107e42).
        "500":
          description: Internal Server Error - Internal server error occurred.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                internalServerError:
                  summary: The request failed due to an internal server error.
                  description: internalServerError
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: There was an error processing your request. It has been
                        logged (ID a449ea6319107e42).
        "503":
          description: "Service Unavailable - The server is currently unavailable.\
            \ Generally, this is a temporary state."
          content:
            '*/*':
              schema:
                type: string
  /v1/aml:resendCallouts:
    post:
      tags:
      - aml-controller
      description: Resends the AML callouts.
      operationId: resendAmlCallouts
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResendAmlFilter'
        required: true
      responses:
        "200":
          description: OK - The AML callouts were resent.
        "400":
          description: Bad Request - Validation error occurred. This code will cover
            malformed syntax in request or incorrect data in payload.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                invalidRequestBody:
                  summary: No transactions that allow resending the AML callout were
                    found.
                  description: invalidRequestBody
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: "Failed to find any valid Sepa Transaction for the given\
                        \ request. The error message is: resend.aml.callout.failed"
        "405":
          description: "Method Not Allowed - This code is only sent when the HTTP\
            \ method (PUT, POST, DELETE, GET etc.) is not supported on a specific\
            \ endpoint. It has nothing to do with the consent, payment or account\
            \ information data model."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                unsupportedHttpMethod:
                  summary: The request was submitted with an unsupported HTTP method.
                  description: unsupportedHttpMethod
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: There was an error processing your request. It has been
                        logged (ID a449ea6319107e42).
        "415":
          description: Unsupported Media Type - A media type which the server does
            not support has been supplied.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                unsupportedContentType:
                  summary: The request was submitted with an unsupported content type.
                    For example "application/json" instead of "application/xml".
                  description: unsupportedContentType
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: There was an error processing your request. It has been
                        logged (ID a449ea6319107e42).
        "500":
          description: Internal Server Error - Internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                internalServerError:
                  summary: The request failed due to an internal server error.
                  description: internalServerError
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: There was an error processing your request. It has been
                        logged (ID a449ea6319107e42).
        "503":
          description: "Service Unavailable - The server is currently unavailable.\
            \ Generally, this is a temporary state."
  /v1/accounts/identifications:mask:
    post:
      tags:
      - identifications-controller
      description: Mask identifications from Payments Gateway.
      operationId: mask
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IdentificationsToMask'
        required: true
      responses:
        "200":
          description: OK - Identifications masked. This operation is irreversible.
        "400":
          description: Bad Request - Validation error occurred. This code will cover
            malformed syntax in request or incorrect data in payload.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                identificationAlreadyMasked:
                  summary: At least one of the provided identifications was already
                    masked
                  description: identificationAlreadyMasked
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: "Following identifications are already masked: DK0643182702662691"
        "500":
          description: Internal Server Error - Internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                internalServerError:
                  summary: The request failed due to an internal server error.
                  description: internalServerError
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: There was an error processing your request. It has been
                        logged (ID a449ea6319107e42).
        "503":
          description: "Service Unavailable - The server is currently unavailable.\
            \ Generally, this is a temporary state."
  /v1/instructions:
    get:
      tags:
      - instructions-controller
      description: Retrieve the SEPA messages details.
      operationId: findSepaMessages
      parameters:
      - name: sepaMessageFilter
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/SepaMessageFilter'
      responses:
        "200":
          description: OK - SEPA Messages Details were correctly found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SepaMessages'
              examples:
                pacs.008 instruction information:
                  summary: Information retrieved for a pacs.008 message
                  description: pacs.008 instruction information
                  value:
                    instructions:
                    - FIToFICstmrCdtTrf:
                        grpHdr:
                          msgId: 22b8f938c6154877886a0c1fc9e74166
                          creDtTm: 2019-04-11T09:08:45+03:00
                          nbOfTxs: "2"
                          ttlIntrBkSttlmAmt:
                            value: 200
                            ccy: EUR
                          intrBkSttlmDt: 2019-04-11T00:00:00+03:00
                          sttlmInf:
                            clrSys:
                              prtry: ST2
                          instgAgt:
                            finInstnId:
                              bic: ABVRATW1XXX
                        cdtTrfTxInf:
                        - pmtId:
                            instrId: 82d7125b36014c2e8cc442a3586badd0
                            endToEndId: NOTPROVIDED
                            txId: 4112f6688c846a89bee2b2c476f1145
                          pmtTpInf:
                            svcLvl:
                              cd: SEPA
                          intrBkSttlmAmt:
                            value: 100
                            ccy: EUR
                          accptncDtTm: 2019-04-11T09:08:45+03:00
                          chrgBr: SLEV
                          dbtr:
                            nm: John Doe
                          dbtrAcct:
                            id:
                              iban: RO59INGBW91QIQFZSG6IZBJT
                          dbtrAgt:
                            finInstnId:
                              bic: INGBROBU
                          cdtrAgt:
                            finInstnId:
                              bic: BTRLRO22
                          cdtr:
                            nm: BT
                            pstlAdr:
                              ctry: DE
                          cdtrAcct:
                            id:
                              iban: RO75BTRLBSIJS00RPQWYLYWL
                          _metadata:
                            transactionSn: 1
                            transactionStatus: RECEIVED
                            paymentId: 67eacbf33f1b4eaea8d1055a2a01adea
                        - pmtId:
                            instrId: 108cf3f5fd833aa5bc5efb90c0dee19e
                            endToEndId: NOTPROVIDED
                            txId: 758e663666ae40be8e9278a9e4e899f9
                          pmtTpInf:
                            svcLvl:
                              cd: SEPA
                          intrBkSttlmAmt:
                            value: 100
                            ccy: EUR
                          accptncDtTm: 2019-04-11T09:08:45+03:00
                          chrgBr: SLEV
                          dbtr:
                            nm: John Doe
                          dbtrAcct:
                            id:
                              iban: RO59INGBW91QIQFZSG6IZBJT
                          dbtrAgt:
                            finInstnId:
                              bic: INGBROBU
                          cdtrAgt:
                            finInstnId:
                              bic: BTRLRO22
                          cdtr:
                            nm: BT
                            pstlAdr:
                              ctry: DE
                          cdtrAcct:
                            id:
                              iban: RO94BTRLVU048EN2KBPTVT7U
                          _metadata:
                            transactionSn: 2
                            transactionStatus: RECEIVED
                            paymentId: fcaae256fed94018958326c9cb752aeb
                        _metadata:
                          bulkSn: 1
                          direction: I
                          messageId: pacs.008
                          transactions: 2
                pacs.004 instruction information:
                  summary: Information retrieved for a pacs.004 message
                  description: pacs.004 instruction information
                  value:
                    instructions:
                    - PmtRtr:
                        grpHdr:
                          msgId: "1"
                          creDtTm: 2018-11-26T21:47:57+02:00
                          nbOfTxs: "1"
                          ttlRtrdIntrBkSttlmAmt:
                            value: 4000.5
                            ccy: EUR
                          intrBkSttlmDt: 2018-11-26T00:00:00+02:00
                          sttlmInf:
                            sttlmMtd: CLRG
                            clrSys:
                              prtry: ST2
                        txInf:
                        - rtrId: "2020181126130827322001"
                          orgnlGrpInf:
                            orgnlMsgId: "1231231312"
                            orgnlMsgNmId: pacs.008
                          orgnlEndToEndId: 10864caa82034bc8a12e4bf3e117d10d
                          orgnlTxId: "8097758122275259"
                          rtrdIntrBkSttlmAmt:
                            value: 4000.5
                            ccy: EUR
                          rtrRsnInf:
                            orgtr:
                              id:
                                orgId:
                                  bicorBEI: DABADKKK
                            rsn:
                              cd: AC_01
                          orgnlTxRef:
                            intrBkSttlmDt: 2018-11-26T00:00:00+02:00
                            sttlmInf:
                              sttlmMtd: CLRG
                            pmtTpInf:
                              svcLvl:
                                cd: SEPA
                            dbtr:
                              nm: Hanne Doe
                            dbtrAcct:
                              id:
                                iban: DK0643182702662691
                            dbtrAgt:
                              finInstnId:
                                bic: DABADKKK
                            cdtrAgt:
                              finInstnId:
                                bic: BTRLRO22
                            cdtr:
                              nm: John Doe
                            cdtrAcct:
                              id:
                                iban: RO69BTRL3333444433334444
                          _metadata:
                            transactionSn: 14
                            transactionStatus: RECEIVED
                            returnReason: AC01
                            paymentId: 22886adc407e4280b7df22a966d08425
                        _metadata:
                          bulkSn: 10
                          direction: I
                          messageId: pacs.004.001.02
                          procstatus: REPLIED
                          transactions: 1
                camt.056 instruction information:
                  summary: Information retrieved for a camt.056 message
                  description: camt.056 instruction information
                  value:
                    instructions:
                    - FIToFIPmtCxlReq:
                        assgnmt:
                          id: msg-id-camt.056.001.01
                          assgnr:
                            agt:
                              finInstnId:
                                bic: TESTXXXXXXX
                          assgne:
                            agt:
                              finInstnId:
                                bic: TESTXXXXXXX
                          creDtTm: 2019-05-14T21:00:00.000+0000
                        ctrlData:
                          nbOfTxs: 1
                        undrlyg:
                        - txInf:
                            cxlId: 000R9087000000011
                            orgnlGrpInf:
                              orgnlMsgId: SCTORD15682019
                              orgnlMsgNmId: pacs.008.001.02
                            orgnlInstrId: "6630844036108666"
                            orgnlEndToEndId: NOTPROVIDED
                            orgnlTxId: "8097758122275259"
                            orgnlIntrBkSttlmAmt:
                              value: 4000.5
                              ccy: EUR
                            orgnlIntrBkSttlmDt: 2019-06-19T21:00:00.000+0000
                            cxlRsnInf:
                            - orgtr:
                                nm: Beneficioso beneficiar io
                              rsn:
                                cd: DUPL
                            orgnlTxRef:
                              sttlmInf:
                                sttlmMtd: CLRG
                                clrSys:
                                  cd: REP
                              pmtTpInf:
                                svcLvl:
                                  cd: SEPA
                              rmtInf:
                                ustrd:
                                - Pruebas para CECA 1
                              ultmtDbtr:
                                nm: EUR
                              dbtr:
                                nm: ENRIQUE ROMERA MARTINEZ DE MIGUEL
                              dbtrAcct:
                                id:
                                  iban: ES1011110001087939390799
                              dbtrAgt:
                                finInstnId:
                                  bic: TESTXXXXXXX
                              cdtrAgt:
                                finInstnId:
                                  bic: TESTXXXXXXX
                              cdtr:
                                nm: Beneficioso beneficiario
                              cdtrAcct:
                                id:
                                  iban: ES6520950001153279157264
                            _metadata:
                              transactionSn: 2
                              transactionStatus: TO_BE_SENT
                              returnReason: DUPL
                              paymentId: poId
                        _metadata:
                          bulkSn: 2
                          direction: I
                          messageId: camt.056.001.01
                          procstatus: RETRIEVED
                          transactions: 1
                camt.029 instruction information:
                  summary: Information retrieved for a camt.029 message
                  description: camt.029 instruction information
                  value:
                    instructions:
                    - RsltnOfInvstgtn:
                        assgnmt:
                          id: msg-id-camt.029.001.03
                          assgnr:
                            agt:
                              finInstnId:
                                bic: TESTXXXXXXX
                          assgne:
                            agt:
                              finInstnId:
                                bic: TESTXXXXXXX
                          creDtTm: 2019-05-14T21:00:00.000+0000
                        sts:
                          conf: RJCT
                        cxlDtls:
                        - txInfAndSts:
                            cxlStsId: 568R9
                            orgnlGrpInf:
                              orgnlMsgId: SCTORD156820190620000000000001
                              orgnlMsgNmId: pacs.008.001.02
                            orgnlInstrId: a5fbae19e3d24522963ad60d018f2e49
                            orgnlEndToEndId: 7456b0bb2c1a4209b87b4636995c5d08
                            orgnlTxId: "1002"
                            txCxlSts: RJCR
                            cxlStsRsnInf:
                            - orgtr:
                                id:
                                  orgId:
                                    bicorBEI: TESTXXXXXXX
                              rsn:
                                cd: AGNT
                            orgnlTxRef:
                              intrBkSttlmAmt:
                                value: 4000.5
                                ccy: EUR
                              intrBkSttlmDt: 2019-06-19T21:00:00.000+0000
                              sttlmInf:
                                sttlmMtd: CLRG
                                clrSys:
                                  prtry: ACHT1234567890123456789012345678905
                              pmtTpInf:
                                svcLvl:
                                  cd: SEPA
                              rmtInf:
                                ustrd:
                                - Pruebas para CECA 1
                              dbtr:
                                nm: ENRIQUE ROMERA MARTINEZ DE MIGUEL
                              dbtrAcct:
                                id:
                                  iban: ES1011110001087939390799
                              dbtrAgt:
                                finInstnId:
                                  bic: TESTXXXXXXX
                              cdtrAgt:
                                finInstnId:
                                  bic: TESTXXXXXXX
                              cdtr:
                                nm: Beneficioso beneficiario
                              cdtrAcct:
                                id:
                                  iban: ES6520950001153279157264
                            _metadata:
                              transactionSn: 3
                              transactionStatus: TO_BE_SENT
                              returnReason: RJCT
                              paymentId: poId
                        _metadata:
                          bulkSn: 3
                          direction: O
                          messageId: camt.029.001.03
                          procstatus: RETRIEVED
                          transactions: 1
        "400":
          description: Bad Request - Validation error occurred. This code will cover
            malformed syntax in request or incorrect data in payload.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                invalidDirection:
                  summary: The provided direction value is not valid
                  description: invalidDirection
                  value:
                    tppMessages:
                    - category: ERROR
                      code: PARAMETER_NOT_SUPPORTED
                      text: "direction invalid value: example_invalid_direction"
        "500":
          description: Internal Server Error - Internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
              examples:
                internalServerError:
                  summary: The request failed due to an internal server error.
                  description: internalServerError
                  value:
                    tppMessages:
                    - category: ERROR
                      code: SERVICE_INVALID
                      text: There was an error processing your request. It has been
                        logged (ID a449ea6319107e42).
        "503":
          description: "Service Unavailable - The server is currently unavailable.\
            \ Generally, this is a temporary state."
components:
  schemas:
    Agent:
      required:
      - institutionIdentification
      type: object
      properties:
        institutionIdentification:
          $ref: '#/components/schemas/InstitutionIdentification'
      description: Financial institution servicing an account for the debtor.
    GroupHeader:
      required:
      - messageIdentification
      type: object
      properties:
        messageIdentification:
          type: string
          description: Message Identification from the original instruction.
      description: GroupHeader information from the original instruction.
    InstantPaymentIdentification:
      required:
      - acceptanceDateTime
      - transactionIdentification
      type: object
      properties:
        transactionIdentification:
          type: string
          description: Unique identification as assigned by the initiating party to
            be used as transaction identifier.
        acceptanceDateTime:
          type: string
          description: AcceptanceDateTime from the original instruction; must be in
            the same format as it was sent in the original instruction.
      description: Payment instruction reference.
    InstantPaymentSettlement:
      required:
      - groupHeader
      - transaction
      type: object
      properties:
        groupHeader:
          $ref: '#/components/schemas/GroupHeader'
        transaction:
          $ref: '#/components/schemas/InstantTransaction'
    InstantTransaction:
      required:
      - debtorAgent
      - paymentIdentification
      type: object
      properties:
        paymentIdentification:
          $ref: '#/components/schemas/InstantPaymentIdentification'
        debtorAgent:
          $ref: '#/components/schemas/Agent'
      description: Original transaction information.
    InstitutionIdentification:
      required:
      - bicfi
      type: object
      properties:
        bicfi:
          maxLength: 11
          minLength: 8
          type: string
          description: ISO 9362 Business identifier code (BIC) - code allocated to
            a financial institution. Must be between 8 and 11 characters.
      description: "Unique and unambiguous identification of a financial institution,\
        \ as assigned under an internationally recognised identification scheme."
    PaymentResponse:
      type: object
      properties:
        tppMessages:
          type: array
          description: Messages to the TPP on operational issues.
          items:
            $ref: '#/components/schemas/TPPMessage'
    TPPMessage:
      required:
      - category
      - code
      type: object
      properties:
        category:
          type: string
          description: Category designates the message severity.
          enum:
          - ERROR
          - WARN
        code:
          type: string
          description: "Message error codes:<ul><li>PARAMETER_NOT_SUPPORTED: The parameter\
            \ is not supported by the API.</li><li>FORMAT_ERROR: Format of certain\
            \ request fields are not matching the API requirements. An explicit path\
            \ to the corresponding field might be added in the return message.</li><li>SERVICE_INVALID:\
            \ The addressed service is not valid for the addressed resources or the\
            \ submitted data.</li><li>PAYMENT_FAILED: The payment initiation POST\
            \ request failed during the initial process.</li><li>FEATURE_NOT_ENABLED:\
            \ The request failed due to disabled feature. .</li><li>NOT_FOUND: The\
            \ request failed due to not found message. .</li><li>ORIGINAL_MESSAGE_ALREADY_REPLIED:\
            \ The associated message already has a response.</li><li>ORIGINAL_MESSAGE_PENDING_REPLY:\
            \ The associated message has no response.</li><li>INVALID_TRANSACTION_STATUS:\
            \ The request failed due to invalid transaction status.</li><li>INVALID_REQUEST_BODY:\
            \ The request failed due to invalid request body.</li><li>INVALID_TRANSACTION_STATE:\
            \ The request failed due to invalid transaction state.</li><li>INVALID_MESSAGE_TYPE:\
            \ The request failed due to invalid message type.</li></ul>"
          enum:
          - PARAMETER_NOT_SUPPORTED
          - FORMAT_ERROR
          - SERVICE_INVALID
          - PAYMENT_FAILED
          - FEATURE_NOT_ENABLED
          - NOT_FOUND
          - ORIGINAL_MESSAGE_ALREADY_REPLIED
          - ORIGINAL_MESSAGE_PENDING_REPLY
          - INVALID_TRANSACTION_STATUS
          - INVALID_REQUEST_BODY
          - INVALID_TRANSACTION_STATE
          - INVALID_MESSAGE_TYPE
          - TOO_MANY_EVENTS_FOUND
          - NO_EVENTS_FOUND
          - TENANT_NOT_FOUND
          - TOO_MANY_COMMANDS_FOUND
          - NO_COMMANDS_FOUND
        path:
          type: string
        text:
          maxLength: 512
          minLength: 1
          type: string
          description: Additional explaining text.
        errorCode:
          type: string
          description: Payment error code. Gives a more detailed analysis of any problems
            which may have occurred during the payment processing.
        errorReason:
          type: string
          description: Payment error reason. Gives a more detailed analysis of any
            problems which may have occurred during the payment processing.
      description: Messages to the TPP on operational issues.
    Recall:
      required:
      - recallReasonCode
      type: object
      properties:
        recallReasonCode:
          type: string
          description: "Reason for outgoing payment recall, as defined in the SEPA\
            \ guideline"
          enum:
          - FRAD
          - TECH
          - CUST
          - DUPL
        customerRecallReasonCode:
          type: string
          description: "Customer reason for outgoing payment recall, as defined in\
            \ the SEPA guideline"
          enum:
          - AM09
          - AC03
    CancellationDetails:
      required:
      - rejectionReason
      type: object
      properties:
        additionalInformation:
          type: array
          description: "Further details on the cancellation request reason. The order\
            \ must be as defined in the SEPA guideline. The prefixes will be added\
            \ automatically. First occurrence will be added to the first (mandatory)\
            \ entry of additional information. When denying a recall, if you do not\
            \ want to add extra information to the mandatory occurrence, please provide\
            \ an empty string. For Legal additional information, second and third\
            \ occurrence will be added on the second and third additional information."
          items:
            type: string
            description: "Further details on the cancellation request reason. The\
              \ order must be as defined in the SEPA guideline. The prefixes will\
              \ be added automatically. First occurrence will be added to the first\
              \ (mandatory) entry of additional information. When denying a recall,\
              \ if you do not want to add extra information to the mandatory occurrence,\
              \ please provide an empty string. For Legal additional information,\
              \ second and third occurrence will be added on the second and third\
              \ additional information."
        originalRecallReasonAdditionalInformation:
          type: array
          description: Further details on the cancellation reason which can be used
            when the recall rejection reason was AC03 for a recall made by the originator
            or FRAD for a recall made by the financial institution. The prefixes will
            be added automatically. Up to 10 occurrences are allowed.
          items:
            type: string
            description: Further details on the cancellation reason which can be used
              when the recall rejection reason was AC03 for a recall made by the originator
              or FRAD for a recall made by the financial institution. The prefixes
              will be added automatically. Up to 10 occurrences are allowed.
        rejectionReason:
          type: string
          description: "Reason for the cancellation status. Only ARDT, AC04, AM04,\
            \ NOAS, NOOR, CUST, LEGL, AGNT are allowed."
          enum:
          - ARDT
          - AC04
          - AM04
          - NOAS
          - NOOR
          - CUST
          - LEGL
          - AGNT
    IncomingMessageResponse:
      required:
      - messageId
      - messageType
      type: object
      properties:
        messageId:
          type: string
          description: Resource identification of the incoming message
        messageType:
          type: string
          description: URN namespace of the incoming message
    AmlPaymentIdentification:
      required:
      - transactionIdentification
      type: object
      properties:
        transactionIdentification:
          type: string
          description: Unique identification as assigned by the initiating party to
            be used as transaction identifier.
      description: Payment instruction reference.
    AmlResult:
      required:
      - groupHeader
      - transactions
      type: object
      properties:
        groupHeader:
          $ref: '#/components/schemas/GroupHeader'
        transactions:
          type: array
          description: "List of AML result checks, one per Payment Order."
          items:
            $ref: '#/components/schemas/AmlTransactionResult'
    AmlTransactionResult:
      required:
      - debtorAgent
      - interbankSettlementDate
      - paymentIdentification
      - status
      type: object
      properties:
        status:
          type: string
          description: "Actual status of the AML investigation. Must be one of `ACCEPTED`,\
            \ `SUSPENDED`, `REJECTED`, `MANUAL_REDIRECT_EXTERNAL` or `MANUAL_REDIRECT_INTERNAL`."
          enum:
          - ACCEPTED
          - SUSPENDED
          - REJECTED
          - MANUAL_REDIRECT_EXTERNAL
          - MANUAL_REDIRECT_INTERNAL
        paymentIdentification:
          $ref: '#/components/schemas/AmlPaymentIdentification'
        debtorAgent:
          $ref: '#/components/schemas/Agent'
        interbankSettlementDate:
          maxLength: 10
          minLength: 10
          type: string
          description: InterbankSettlementDate from the original instruction in the
            format `YYYY-MM-DD`.
      description: "List of AML result checks, one per Payment Order."
    GroupHeaderIncoming:
      required:
      - creationDateTime
      - instructingAgent
      - messageIdentification
      type: object
      properties:
        messageIdentification:
          type: string
          description: Message identification to identify the inquiry message
        creationDateTime:
          type: string
          description: "Date and time at which the inquiry message was created. Accepted\
            \ format: yyyy-MM-ddTHH:mm:ss"
        instructingAgent:
          type: string
          description: Agent that is instructed by the previous party in the chain
            to carry out the (set of) instruction(s).
      description: Set of characteristics shared by all individual transactions included
        in the Request for Status Update on Recall message
    SkipStatusUpdateOnRecall:
      required:
      - groupHeader
      - transactionInformation
      type: object
      properties:
        groupHeader:
          $ref: '#/components/schemas/GroupHeaderIncoming'
        transactionInformation:
          $ref: '#/components/schemas/StatusRequestIdentification'
    StatusRequestIdentification:
      required:
      - statusRequestIdentification
      type: object
      properties:
        statusRequestIdentification:
          type: string
          description: "Unique identification, as assigned by an instructing party\
            \ for an instructed party, to identify the status request"
      description: Information concerning the Request for Status Update on Recall
        message
    OriginalCamt056Data:
      required:
      - cancellationIdentification
      type: object
      properties:
        groupHeader:
          $ref: '#/components/schemas/GroupHeader'
        cancellationIdentification:
          type: string
          description: Cancellation identification.
        historicCancellationRequest:
          type: string
          description: Original camt.056.001.01 message body XML for historical requests.
        localInstrument:
          type: string
          description: Original camt.056 local instrument
    Assignment:
      type: object
      properties:
        identification:
          type: string
          description: camt.027/camt.087 assignment id
        creationDateTime:
          type: string
          description: creation date time
          format: date-time
      description: Assignment
    OriginalInquiryData:
      required:
      - caseIdentification
      - messageTypeName
      type: object
      properties:
        messageTypeName:
          type: string
          description: messageTypeName
          enum:
          - PACS_002_001_03
          - PACS_002_001_10
          - PACS_002_001_12
          - PACS_003_001_02
          - PACS_003_001_08
          - PACS_004_001_02
          - PACS_004_001_09
          - PACS_004_001_11
          - PACS_007_001_02
          - PACS_007_001_09
          - PACS_008_001_02
          - PACS_008_001_08
          - PACS_008_001_10
          - PACS_009_001_08
          - PACS_028_001_01
          - PACS_028_001_03
          - CAMT_027_001_06
          - CAMT_027_001_07
          - CAMT_029_001_03
          - CAMT_029_001_08
          - CAMT_029_001_09
          - CAMT_029_001_11
          - CAMT_056_001_01
          - CAMT_056_001_08
          - CAMT_056_001_10
          - CAMT_087_001_05
          - CAMT_087_001_06
          - SIC_PACS_008_001_08
          - SIC_PACS_004_001_09
          - SIC_PACS_002_001_10
          - MT_103
          - MT_103_RETURN
          - UNKNOWN
        assignment:
          $ref: '#/components/schemas/Assignment'
        caseIdentification:
          type: string
          description: camt.027/camt.087 case id
        historicClaimRequest:
          type: string
          description: Optional historic camt.087 or camt.027 xml
    RejectStatusUpdateOnRecall:
      required:
      - cancellationDetails
      - groupHeader
      - transactionInformation
      type: object
      properties:
        groupHeader:
          $ref: '#/components/schemas/GroupHeaderIncoming'
        transactionInformation:
          $ref: '#/components/schemas/TransactionInformation'
        cancellationDetails:
          $ref: '#/components/schemas/CancellationDetails'
    TransactionInformation:
      required:
      - originalInstructionIdentification
      - originalMessageIdentification
      - statusRequestIdentification
      type: object
      properties:
        statusRequestIdentification:
          type: string
          description: "Unique identification, as assigned by an instructing party\
            \ for an instructed party, to identify the status request"
        originalMessageIdentification:
          type: string
          description: Point to point reference assigned by the original instructing
            party to identify the original group of individual transactions
        originalInstructionIdentification:
          type: string
          description: "Unique identification, as assigned by the original instructing\
            \ party for the original instructed party, to unambiguously identify the\
            \ original instruction."
      description: "Information concerning the original transaction, to which the\
        \ Request for Status Update on Recall message refers"
    OriginalPacs008Data:
      required:
      - paymentIdentification
      type: object
      properties:
        groupHeader:
          $ref: '#/components/schemas/Pacs008GroupHeader'
        paymentIdentification:
          $ref: '#/components/schemas/PaymentIdentification'
        claimedValueDate:
          type: string
          description: Claimed value-date for change.
          format: date
        historicCreditTransferRequest:
          type: string
          description: Original pacs.008 message body XML for historical requests.
    Pacs008GroupHeader:
      required:
      - messageIdentification
      type: object
      properties:
        messageIdentification:
          type: string
          description: Original message identification.
        settlementDate:
          type: string
          description: Original settlement date.
          format: date
      description: Original pacs.008 group header information.
    PaymentIdentification:
      type: object
      properties:
        transactionIdentification:
          type: string
          description: Original transaction identification.
      description: Payment identification.
    AcceptStatusUpdateOnRecall:
      required:
      - groupHeader
      - transactionInformation
      type: object
      properties:
        groupHeader:
          $ref: '#/components/schemas/GroupHeaderIncoming'
        transactionInformation:
          $ref: '#/components/schemas/TransactionInformation'
    Reverse:
      required:
      - reasonCode
      type: object
      properties:
        reasonCode:
          type: string
          description: "Reason for an interbank Reversal, as defined in the SEPA guideline"
          enum:
          - AM05
          - MS02
          - MS03
    Refund:
      required:
      - reasonCode
      type: object
      properties:
        reasonCode:
          type: string
          description: "Reason for an interbank Refund, as defined in the SEPA guideline"
          enum:
          - MD01
          - MD06
    ResendAmlFilter:
      required:
      - direction
      type: object
      properties:
        direction:
          type: string
          description: Message Direction. Supported values are I (incoming) or O (outgoing).
          enum:
          - I
          - O
        category:
          type: string
          description: "Message Category. Supported values are SEPA_CT, SEPA_DD or\
            \ TGT."
          enum:
          - SEPA_CT
          - SEPA_DD
          - TGT
        messageId:
          type: string
          description: Incoming message identification.
        interbankSettlementDate:
          type: string
          description: "Date on which the amount of money ceases to be available to\
            \ the agent that owes it and when the amount of money becomes available\
            \ to the agent to which it is due. Accepted format: yyyy-MM-dd"
        instructingAgent:
          type: string
          description: Agent that instructs the next party in the chain to carry out
            the (set of) instruction(s).
    Identification:
      type: object
      properties:
        iban:
          maxLength: 34
          minLength: 15
          type: string
          description: ISO 13616 International Bank Account Number (IBAN) - identifier
            used internationally by financial institutions to uniquely identify the
            account of a customer.
    IdentificationsToMask:
      required:
      - identifications
      type: object
      properties:
        identifications:
          type: array
          items:
            $ref: '#/components/schemas/Identification'
    Message:
      type: object
      description: List of SEPA instructions.
    SepaMessages:
      type: object
      properties:
        tppMessages:
          type: array
          description: Messages to the TPP on operational issues.
          items:
            $ref: '#/components/schemas/TPPMessage'
        instructions:
          type: array
          description: List of SEPA instructions.
          items:
            $ref: '#/components/schemas/Message'
    SepaMessageFilter:
      required:
      - direction
      type: object
      properties:
        offset:
          minimum: 0
          type: integer
          description: Offset from which the results should be provided. Defaults
            to 0.
          format: int32
        limit:
          maximum: 100
          minimum: 1
          type: integer
          description: Limit of the number of objects returned by the server. Defaults
            to 20.
          format: int32
        network:
          type: string
          description: Network for which the instructions should be received. SEPA
            is the only value allowed
        direction:
          type: string
          description: Message Direction. Supported values are I (incoming) or O (outgoing)
        dateFrom:
          type: string
          description: "Start date from which the messages should be filtered. Accepted\
            \ format: yyyy-MM-dd"
        dateTo:
          type: string
          description: "End date up until which the messages should be filtered. Accepted\
            \ format: yyyy-MM-dd"
        messageType:
          type: string
          description: "Message type. Accepted values are pacs.008.001.02, pacs.004.001.02,\
            \ pacs.003.001.02, camt.056.001.01, camt.029.001.03, pacs.004.001.09,\
            \ pacs.009.001.08, pacs.008.001.10, pacs.004.001.11, camt.029.001.11,\
            \ camt.056.001.10"
        messageId:
          type: string
          description: "Message ID, representing the GrpHdr>>MsgId field of the message"
        originalMessageId:
          type: string
          description: "Original Message ID, representing the underlying transaction\
            \ info OrgnlMsgId"
        transactionsOffset:
          minimum: 0
          type: integer
          description: Offset from which the transactions should be provided. Defaults
            to 0. If the transactionsLimit or transactionsOffset is bigger than 0
            then the messageId parameter has to be used as transactions pagination
            in only available for one message.
          format: int32
        transactionsLimit:
          minimum: 0
          type: integer
          description: Limit of the number of transactions returned by the server.
            Defaults to 10. If the transactionsLimit is 0 only message headers will
            be returned. If the transactionsLimit or transactionsOffset is bigger
            than 0 then the messageId parameter has to be used as transactions pagination
            in only available for one message.
          format: int32
        paymentId:
          type: string
          description: "Payment ID, id provided when creating a new payment"
        txId:
          type: string
          description: "Transaction Id, id of the transaction, When provided in conjunction\
            \ with direction, messageId, and messageType, it enables the retrieval\
            \ of details for a single specific transaction. Note: If this combination\
            \ of parameters is used, all other search filters will be bypassed."
