openapi: 3.0.2
info:
#---------------------------------------------------
# Information to contact the API provider
#--------------------------------------------------- 
  title: Previous Day Reporting
  description: Retrieve transaction activity, detailed transaction reports, and account summaries for one or multiple checking accounts. Previous Day focuses on activity for a historical date range.
  contact:
    name: "KeyBank Developer Support"
    email: "developers@keybank.com"
  version: 1.2.9
servers: 
#---------------------------------------------------
# List of environments for the API
#---------------------------------------------------
 - url: https://partner-api-qv.key.com
 - url: https://partner-api.key.com

paths:
#---------------------------------------------------
# List of API flows
#---------------------------------------------------
  /ddaReports/accounts/v1/healthCheck:
    get:
      tags: # Logical group based on functionality
        - HealthCheck 
      summary: Health check
      description: Verify you can connect to the API service. A bearer token is required.
      operationId: healthCheck
      security:
        - bearerAuth: []
      responses:
        '200':
          description: Successful response
          headers:
            X-CorrelationId:
              schema:
                type: string
              description: A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/healthResponse'
              example:
                 Status: Ok
                 Source: Roundtrip
                 Timestamp: '2022-09-15T04:49:03'
                 ClientIp: 156.77.111.28
                 X-Forwarded-For: '[156.77.111.28]'
  /ddaReports/accounts/v1/transactions/list:
    post:
      tags:
        - Previous Day
      summary: Get a list of transactions for a historical date range
      description: Retrieve historical transaction activity for one or multiple accounts. Transaction data can be recalled from the previous 24 months. When setting the date range (fromDate and toDate), the date range specified cannot exceed more than 90 days.
      operationId: Transactions
      security:
        - bearerAuth: []  
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DDATransactionsRequest"
            example:
              getDDATransactionsRequest:
                accountNumber:
                - '123456789'
                fromDate: '2021-06-12'
                toDate: '2021-07-12'
                creditOrDebitCode: C
                transactionTypeCode: '1003'
                fromAmount: '1.00'
                toAmount: '1000.00'
                startRowIndex: '1'
                endRowIndex: '1' 
        required: true
      responses:
        '200':
          description: Successful response
          headers:
            X-CorrelationId:
              schema:
                type: string
              description: A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DDATransactionsResponse'
              example:
                getDDATransactionsResponse:
                  responseHeader:
                    status: S
                    statusDescription: Successfully returned results for the requested range 1 to
                      1
                    retrievedRows: '1'
                    totalRows: '66'
                    dataLoadDate: '2022-07-05'
                  DDATransactions:
                  - accountNumber: '123456789'
                    transactionEffectiveDate: '2021-06-16'
                    creditOrDebitCode: C
                    transactionTypeCode: '1003'
                    transactionAmount: '524.78'
                    transactionKey: C 000000000000000001
                    transactionDescription: DEPOSIT    BRANCH 0505 PENNSYLVANIA
                    transactionSequenceNumber: '140'
                    currentLedgerBalancePostTransaction: '300596.77'
                    currencyCode: USD
                    addendaInformation:
                      WiresData:
                        creditArrangementTypeCode: ""
                        creditArrangementBankNumber: ""
                        creditArrangementBankBranch: ""
                        creditArrangementCurrencyCode: ""
                        creditInvolvedPartyIdentifier: ""
                        creditInvolvedPartyName: ""
                        creditArrangementCountryCode: ""
                        creditInvolvedPartyTypeCode: ""
                        debitArrangementTypeCode: ""
                        debitArrangementBankNumber: ""
                        debitArrangementBankBranch: ""
                        debitArrangementCurrencyCode: ""
                        debitInvolvedPartyIdentifier: ""
                        debitInvolvedPartyName: ""
                        transactionBusinessStatusCode: ""
                        sendingBankReferenceNumber: ""
                        originatingInvolvedPartyName: TEST COMPANY 1, LLC
                        originatingArrangementNumber: '12345123'
                        originatingInvolvedPartyAddressLine1: 127 Public Sq, Cleveland
                        originatingInvolvedPartyAddressLine2: OH 44114
                        beneficiaryInvolvedPartyName: TEST COMPANY 3, LLC
                        beneficiaryArrangementNumber: '3435656765'
                        beneficiaryInvolvedPartyAddressLine1: 250 Delaware Ave Ste
                        beneficiaryInvolvedPartyAddressLine2: Buffalo,NY 14202
                        intermediaryBankName: KeyBank National Association
                        intermediaryBankABANumber: '21300077'
                        intermediaryBICCode: KEYBUS33 XXX
                        intermediaryBankAddressLine1: 250 Delaware Ave Ste
                        intermediaryBankAddressLine2: Buffalo,NY 14202
                        originatingBankName: KeyBank National Association
                        originatingBankABANumber: ""
                        originatingBankBICcode: ""
                        originatingBankAddressLine1: ""
                        originatingBankAddressLine2: ""
                        beneficiaryBankName: KeyBank National Association
                        beneficiaryBankABANumber: '21300077'
                        beneficiaryBankBICcode: KEYBUS33 XXX
                        beneficiaryBankAddressLine1: 250 Delaware Ave Ste
                        beneficiaryBankAddressLine2: Buffalo,NY 14202
                        sourceTransactionIdentifier: ""
                        transactionSettledDate: ""
                        federalReferenceNumber: ""
                        incomingReferenceNumber: ""
                        currencyExchangeRate: ""
                        transactionExecutedDate: ""
                        bankToBankMemo: ""
                        transactionIdentifier: ""
                        originatingABA: ""
                        originating2ABA: ""
                        originating3ABA: ""
                        beneficiaryBankArangeNum: ""
                        beneficiaryABA: ""
                        originatingBankDebitBIC: ""
                        originatingBankCreditBIC: ""
        '400':
          description: Missing mandatory information
          headers:
            X-CorrelationId:
              schema:
                type: string
              description: A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. 
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Exception'
              example:
                ErrorMessage: "Mandatory data not provided, please verify the data and resubmit the request"
                TransactionId:  "rrt-7709400285867417207-b-gce-27587-2383364-1"        
                X-CorrelationId: "929618f2-6163-bf73-51b0-6c54a8533c74"
                TransactionTime: "2021-06-11T16:31:34.041Z"
                Api-Url: "/ddaReports/accounts/v1/transactions/list"
        '401':
          description: Unauthorized request
          headers:
            X-CorrelationId:
              schema:
                type: string
              description: A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. 
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Exception'
              example:               
                ErrorMessage: "Received request is unauthorized, please provide valid credentials"
                TransactionId:  "rrt-7709400285867417207-b-gce-27587-2383364-1"    
                X-CorrelationId: "929618f2-6163-bf73-51b0-6c54a8533c74"
                TransactionTime: "2021-06-11T16:31:34.041Z"  
                Api-Url: "/ddaReports/accounts/v1/transactions/list"
        '403':
          description: Forbidden request access
          headers:
            X-CorrelationId:
              schema:
                type: string
              description: A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. 
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Exception'
              example:
                ErrorMessage: "Access to requested resource is forbidden"
                TransactionId:  "rrt-7709400285867417207-b-gce-27587-2383364-1"         
                X-CorrelationId: "929618f2-6163-bf73-51b0-6c54a8533c74"
                TransactionTime: "2021-06-11T16:31:34.041Z" 
                Api-Url: "/ddaReports/accounts/v1/transactions/list"
        '404':
          description: Resource not found
          headers:
            X-CorrelationId:
              schema:
                type: string
              description: A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. 
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Exception'
              example:
                ErrorMessage: "Requested resource is not found, please verify the resource then resubmit the request"
                TransactionId:  "rrt-7709400285867417207-b-gce-27587-2383364-1"         
                X-CorrelationId: "929618f2-6163-bf73-51b0-6c54a8533c74"
                TransactionTime: "2021-06-11T16:31:34.041Z"
                Api-Url: "/ddaReports/accounts/v1/transactions/list"
        '405':
          description: Invalid request method
          headers:
            X-CorrelationId:
              schema:
                type: string
              description: A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. 
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Exception'
              example:
                ErrorMessage: "Requested method is not allowed, please verify the method and resubmit the request"
                TransactionId:  "rrt-7709400285867417207-b-gce-27587-2383364-1"         
                X-CorrelationId: "929618f2-6163-bf73-51b0-6c54a8533c74"
                TransactionTime: "2021-06-11T16:31:34.041Z"
                Api-Url: "/ddaReports/accounts/v1/transactions/list"
        '415':
          description: Invalid request type
          headers:
            X-CorrelationId:
              schema:
                type: string
              description: A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. 
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Exception'
              example:
                ErrorMessage: "Requested media type is not allowed, please verify the media type and resubmit the request"
                TransactionId:  "rrt-7709400285867417207-b-gce-27587-2383364-1"  
                X-CorrelationId: "929618f2-6163-bf73-51b0-6c54a8533c74"
                TransactionTime: "2021-06-11T16:31:34.041Z"
                Api-Url: "/ddaReports/accounts/v1/transactions/list"
        '429':
          description: Request timeout
          headers:
            X-CorrelationId:
              schema:
                type: string
              description: A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. 
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Exception'
              example:
                ErrorMessage: "Number requests threshold reached, please resubmit the request after sometime"
                TransactionId:  "rrt-7709400285867417207-b-gce-27587-2383364-1" 
                X-CorrelationId: "929618f2-6163-bf73-51b0-6c54a8533c74"
                TransactionTime: "2021-06-11T16:31:34.041Z"
                Api-Url: "/ddaReports/accounts/v1/transactions/list"
        '500':
          description: Unknown error
          headers:
            X-CorrelationId:
              schema:
                type: string
              description: A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. 
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Exception'
              example:
                ErrorMessage: "Runtime error occurred in the service, please check with application support team before resubmitting the request"
                TransactionId:  "rrt-7709400285867417207-b-gce-27587-2383364-1"       
                X-CorrelationId: "929618f2-6163-bf73-51b0-6c54a8533c74"
                TransactionTime: "2021-06-11T16:31:34.041Z"
                Api-Url: "/ddaReports/accounts/v1/transactions/list"
        '502':
          description: Bad gateway
          headers:
            X-CorrelationId:
              schema:
                type: string
              description: A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. 
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Exception'
              example:
                ErrorMessage: "Error received from backend"
                TransactionId:  "rrt-7709400285867417207-b-gce-27587-2383364-1"        
                TransactionTime: "2021-06-11T16:31:34.041Z"
                X-CorrelationId: "929618f2-6163-bf73-51b0-6c54a8533c74"
                Api-Url: "/ddaReports/accounts/v1/transactions/list"
                ServiceError: 
                  ConnectError : "Connectivity error occurred with the downstream service (Unexpected EOF at target), please check with application support team before resubmitting the request"
        '503':
          description: Unavailable service
          headers:
            X-CorrelationId:
              schema:
                type: string
              description: A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. 
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Exception'
              example:
                ErrorMessage: "Error received from backend"
                TransactionId:  "rrt-7709400285867417207-b-gce-27587-2383364-1"     
                X-CorrelationId: "929618f2-6163-bf73-51b0-6c54a8533c74"
                TransactionTime: "2021-06-11T16:31:34.041Z"
                Api-Url: "/ddaReports/accounts/v1/transactions/list"
                ServiceError: 
                  ConnectError : "Service is currently unavailable (NoActiveTargets), please check with application support before resubmitting the request."
        '504':
          description: Unable to process request
          headers:
            X-CorrelationId:
              schema:
                type: string
              description: A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. 
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Exception'
              example:
                ErrorMessage: "Error received from backend"
                TransactionId:  "rrt-7709400285867417207-b-gce-27587-2383364-1"       
                X-CorrelationId: "929618f2-6163-bf73-51b0-6c54a8533c74"
                TransactionTime: "2021-06-11T16:31:34.041Z"
                Api-Url: "/ddaReports/accounts/v1/transactions/list"
                ServiceError: 
                  ConnectError : "Request could not be processed on time (GatewayTimeout), please wait a moment and resubmit the request."
  /ddaReports/accounts/v1/transactions/details:
    post:
      tags:
        - Previous Day
      summary: Get a detailed transaction report
      description: Retrieve the transaction details associated with a specific transaction key and account number combination.
      operationId: TransactionsDetails
      security:
        - bearerAuth: []  
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DDATransactionsDetailsRequest"
            example:
              getDDATransactionsDetailsRequest:
                transactionKey:
                -  'C 000000000000000001' 
                accountNumber:
                - '123456789'
        required: true
      responses:
        '200':
          description: Successful response
          headers:
            X-CorrelationId:
              schema:
                type: string
              description: A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DDATransactionsDetailsResponse'
              example:
                getDDATransactionsDetailsResponse:
                  responseHeader:
                    status: S
                    statusDescription: Successfully returned  1 results from sourcing layer.
                    dataLoadDate: 2022-07-05
                  DDATransactionsDetails:
                  - accountNumber: '123456789'
                    transactionEffectiveDate: 2021-07-09
                    creditOrDebitCode: C
                    transactionType: '1003'
                    transactionAmount: '90.82'
                    transactionKey: C 000000000000000001
                    transactionDescription: DEPOSIT    BRANCH 0505 PENNSYLVANIA
                    transactionSequenceNumber: '140'
                    currentLedgerBalancePostTransaction: '376145.36'
                    snapshotDate: 2021-07-09
                    collectedCashAmount: '90.82'
                    shortFloatAmountDay1: '0'
                    checkSerialNumber: '100014399'
                    traceID: C 000000000000000001
                    glSourceCode: '5'
                    operatorID:  ""
                    BAICode: '301'
                    BAICodeDesc: COMMERCIAL DEPOSIT
                    addendaInformation:
                      WiresData:
                        creditArrangementTypeCode: ""
                        creditArrangementBankNumber: ""
                        creditArrangementBankBranch: ""
                        creditArrangementCurrencyCode: ""
                        creditInvolvedPartyIdentifier: ""
                        creditInvolvedPartyName: ""
                        creditArrangementCountryCode: ""
                        creditInvolvedPartyTypeCode: ""
                        debitArrangementTypeCode: ""
                        debitArrangementBankNumber: ""
                        debitArrangementBankBranch: ""
                        debitArrangementCurrencyCode: ""
                        debitInvolvedPartyIdentifier: ""
                        debitInvolvedPartyName: ""
                        transactionBusinessStatusCode: ""
                        sendingBankReferenceNumber: ""
                        originatingInvolvedPartyName: TEST COMPANY 1, LLC
                        originatingArrangementNumber: '12345123'
                        originatingInvolvedPartyAddressLine1: 127 Public Sq, Cleveland
                        originatingInvolvedPartyAddressLine2: OH 44114
                        beneficiaryInvolvedPartyName: TEST COMPANY 3, LLC
                        beneficiaryArrangementNumber: '3435656765'
                        beneficiaryInvolvedPartyAddressLine1: 250 Delaware Ave Ste
                        beneficiaryInvolvedPartyAddressLine2: Buffalo,NY 14202
                        intermediaryBankName: KeyBank National Association
                        intermediaryBankABANumber: '21300077'
                        intermediaryBICCode: KEYBUS33 XXX
                        intermediaryBankAddressLine1: 250 Delaware Ave Ste
                        intermediaryBankAddressLine2: Buffalo,NY 14202
                        originatingBankName: KeyBank National Association
                        originatingBankABANumber: ""
                        originatingBankBICcode: ""
                        originatingBankAddressLine1: ""
                        originatingBankAddressLine2: ""
                        beneficiaryBankName: KeyBank National Association
                        beneficiaryBankABANumber: '21300077'
                        beneficiaryBankBICcode: KEYBUS33 XXX
                        beneficiaryBankAddressLine1: 250 Delaware Ave Ste
                        beneficiaryBankAddressLine2: Buffalo,NY 14202
                        sourceTransactionIdentifier:  ""
                        transactionSettledDate: ""
                        federalReferenceNumber: ""
                        incomingReferenceNumber: ""
                        currencyExchangeRate: ""
                        transactionExecutedDate: ""
                        bankToBankMemo: ""
                        transactionIdentifier: ""
                        originatingABA: ""
                        originating2ABA: ""
                        originating3ABA: ""
                        beneficiaryBankArangeNum: ""
                        beneficiaryABA: ""
                        originatingBankDebitBIC: ""
                        originatingBankCreditBIC: ""
        '400':
          description: Missing mandatory information
          headers:
            X-CorrelationId:
              schema:
                type: string
              description: A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. 
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Exception'
              example:
                ErrorMessage: "Mandatory data not provided, please verify the data and resubmit the request"
                TransactionId:  "rrt-7709400285867417207-b-gce-27587-2383364-1"        
                X-CorrelationId: "929618f2-6163-bf73-51b0-6c54a8533c74"
                TransactionTime: "2021-06-11T16:31:34.041Z"
                Api-Url: "/ddaReports/accounts/v1/transactions/details"
        '401':
          description: Unauthorized request
          headers:
            X-CorrelationId:
              schema:
                type: string
              description: A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. 
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Exception'
              example:               
                ErrorMessage: "Received request is unauthorized, please provide valid credentials"
                TransactionId:  "rrt-7709400285867417207-b-gce-27587-2383364-1"    
                X-CorrelationId: "929618f2-6163-bf73-51b0-6c54a8533c74"
                TransactionTime: "2021-06-11T16:31:34.041Z"  
                Api-Url: "/ddaReports/accounts/v1/transactions/details"
        '403':
          description: Forbidden request access
          headers:
            X-CorrelationId:
              schema:
                type: string
              description: A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. 
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Exception'
              example:
                ErrorMessage: "Access to requested resource is forbidden"
                TransactionId:  "rrt-7709400285867417207-b-gce-27587-2383364-1"         
                X-CorrelationId: "929618f2-6163-bf73-51b0-6c54a8533c74"
                TransactionTime: "2021-06-11T16:31:34.041Z"  
                Api-Url: "/ddaReports/accounts/v1/transactions/details"
        '404':
          description: Resource not found
          headers:
            X-CorrelationId:
              schema:
                type: string
              description: A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. 
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Exception'
              example:
                ErrorMessage: "Requested resource is not found, please verify the resource then resubmit the request"
                TransactionId:  "rrt-7709400285867417207-b-gce-27587-2383364-1"         
                X-CorrelationId: "929618f2-6163-bf73-51b0-6c54a8533c74"
                TransactionTime: "2021-06-11T16:31:34.041Z"
                Api-Url: "/ddaReports/accounts/v1/transactions/details"
        '405':
          description: Invalid request method
          headers:
            X-CorrelationId:
              schema:
                type: string
              description: A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. 
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Exception'
              example:
                ErrorMessage: "Requested method is not allowed, please verify the method and resubmit the request"
                TransactionId:  "rrt-7709400285867417207-b-gce-27587-2383364-1"         
                X-CorrelationId: "929618f2-6163-bf73-51b0-6c54a8533c74"
                TransactionTime: "2021-06-11T16:31:34.041Z"
                Api-Url: "/ddaReports/accounts/v1/transactions/details"
        '415':
          description: Invalid request type
          headers:
            X-CorrelationId:
              schema:
                type: string
              description: A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. 
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Exception'
              example:
                ErrorMessage: "Requested media type is not allowed, please verify the media type and resubmit the request"
                TransactionId:  "rrt-7709400285867417207-b-gce-27587-2383364-1"  
                X-CorrelationId: "929618f2-6163-bf73-51b0-6c54a8533c74"
                TransactionTime: "2021-06-11T16:31:34.041Z"
                Api-Url: "/ddaReports/accounts/v1/transactions/details"
        '429':
          description: Request timeout
          headers:
            X-CorrelationId:
              schema:
                type: string
              description: A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. 
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Exception'
              example:
                ErrorMessage: "Number requests threshold reached, please resubmit the request after sometime"
                TransactionId:  "rrt-7709400285867417207-b-gce-27587-2383364-1" 
                X-CorrelationId: "929618f2-6163-bf73-51b0-6c54a8533c74"
                TransactionTime: "2021-06-11T16:31:34.041Z"
                Api-Url: "/ddaReports/accounts/v1/transactions/details"
        '500':
          description: Unknown error
          headers:
            X-CorrelationId:
              schema:
                type: string
              description: A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. 
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Exception'
              example:
                ErrorMessage: "Runtime error occurred in the service, please check with application support team before resubmitting the request"
                TransactionId:  "rrt-7709400285867417207-b-gce-27587-2383364-1"       
                X-CorrelationId: "929618f2-6163-bf73-51b0-6c54a8533c74"
                TransactionTime: "2021-06-11T16:31:34.041Z"
                Api-Url: "/ddaReports/accounts/v1/transactions/details"
        '502':
          description: Bad gateway
          headers:
            X-CorrelationId:
              schema:
                type: string
              description: A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. 
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Exception'
              example:
                ErrorMessage: "Error received from backend"
                TransactionId:  "rrt-7709400285867417207-b-gce-27587-2383364-1"        
                X-CorrelationId: "929618f2-6163-bf73-51b0-6c54a8533c74"
                TransactionTime: "2021-06-11T16:31:34.041Z"
                Api-Url: "/ddaReports/accounts/v1/transactions/details"
                ServiceError: 
                  ConnectError : "Connectivity error occurred with the downstream service (Unexpected EOF at target), please check with application support team before resubmitting the request"
        '503':
          description: Unavailable service
          headers:
            X-CorrelationId:
              schema:
                type: string
              description: A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. 
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Exception'
              example:
                ErrorMessage: "Error received from backend"
                TransactionId:  "rrt-7709400285867417207-b-gce-27587-2383364-1"     
                X-CorrelationId: "929618f2-6163-bf73-51b0-6c54a8533c74"
                TransactionTime: "2021-06-11T16:31:34.041Z"
                Api-Url: "/ddaReports/accounts/v1/transactions/details"
                ServiceError: 
                  ConnectError : "Service is currently unavailable (NoActiveTargets), please check with application support before resubmitting the request."
        '504':
          description: Unable to process request
          headers:
            X-CorrelationId:
              schema:
                type: string
              description: A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. 
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Exception'
              example:
                ErrorMessage: "Error received from backend"
                TransactionId:  "rrt-7709400285867417207-b-gce-27587-2383364-1"       
                X-CorrelationId: "929618f2-6163-bf73-51b0-6c54a8533c74"
                TransactionTime: "2021-06-11T16:31:34.041Z"
                Api-Url: "/ddaReports/accounts/v1/transactions/details"
                ServiceError: 
                  ConnectError : "Request could not be processed on time (GatewayTimeout), please wait a moment and resubmit the request."
  /ddaReports/accounts/v1/transactions/prevDay/summary:
    post:
      tags:
        - Previous Day
      summary: Get an account summary report for a single historical date
      description: Retrieve a summary of historical, single-day account activity for one or multiple accounts. Transaction data can be recalled from the previous 24 months.
      operationId: PrevDaySummary
      security:
        - bearerAuth: []  
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DDAPrevDaySummaryRequest"
            example: 
              getDDAPrevDaySummaryRequest:
                accountNumber:
                - '123456789'
                date: '2022-07-18'
        required: true
      responses:
        '200':
          description: Successful response
          headers:
            X-CorrelationId:
              schema:
                type: string
              description: A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DDAPrevDaySummaryResponse'
              example: 
                getDDAPrevDaySummaryResponse:
                  responseHeader:
                    status: S
                    statusDescription: Successfully processed the request.
                    dataLoadDate: '2022-05-10'
                    summaryTotal:
                      totalClosingLedger: '42.21'
                      totalClosingAvailable: '42.21'
                      totalFloatDay1: '0.0'
                      totalFloatDay2: '0.0'
                      sumTotalCredits: '2.22'
                      sumTotalDebits: '0.02'
                      totalOpeningAvailable: '42.21'
                  DDAPrevDaySummary:
                  - accountNumber: '123456789'
                    arrangementName: TEST COMPANY 1, LLC
                    closingLedger: '42.21'
                    closingAvailable: '42.21'
                    shortFloatAmountDay0: '0'
                    shortFloatAmountDay1: '0'
                    shortFloatAmountDay2: '0'
                    shortFloatAmountDay3: '0'
                    shortFloatAmountDay4: '0'
                    shortFloatAmountDay5: '0'
                    shortFloatAmountDay6: '0'
                    reportDate: 2022-07-18
                    totalCredits: '2.22'
                    totalDebits: '0.02'
                    openingAvailable: '42.21'
                    achCredits: '0'
                    depositsAmount: '0'
                    wireTransferCredits: '0.21'
                    zbaCredits: '0'
                    otherMiscCredits: '2.01'
                    achDebits: '0'
                    checksAmount: '0'
                    returnedItemDebits: '0'
                    wireTransferDebits: '0.01'
                    zbaDebits: '0'
                    otherMiscDebits: '0.01'
                    totalAccountCredits: '2.22'
                    totalAccountDebits: '0.02'
                    achCreditCount: '0'
                    depositsCount: '0'
                    wireTransferCreditsCount: '4'
                    zbaCreditsCount: '0'
                    otherMiscCreditsCount: '3'
                    achDebitsCount: '0'
                    checksCount: '0'
                    returnedItemDebitsCount: '0'
                    wireTransferDebitsCount: '1'
                    zbaDebitsCount: '0'
                    otherMiscDebitsCount: '1'
                    totalCreditCount: '7'
                    totalDebitCount: '2'
        '400':
          description: Missing mandatory information
          headers:
            X-CorrelationId:
              schema:
                type: string
              description: A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. 
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Exception'
              example:
                ErrorMessage: "Mandatory data not provided, please verify the data and resubmit the request"
                TransactionId:  "rrt-7709400285867417207-b-gce-27587-2383364-1"        
                X-CorrelationId: "929618f2-6163-bf73-51b0-6c54a8533c74"
                TransactionTime: "2021-06-11T16:31:34.041Z"
                Api-Url: "/ddaReports/accounts/v1/transactions/prevDay/summary"
        '401':
          description: Unauthorized request
          headers:
            X-CorrelationId:
              schema:
                type: string
              description: A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. 
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Exception'
              example:               
                ErrorMessage: "Received request is unauthorized, please provide valid credentials"
                TransactionId:  "rrt-7709400285867417207-b-gce-27587-2383364-1"    
                X-CorrelationId: "929618f2-6163-bf73-51b0-6c54a8533c74"
                TransactionTime: "2021-06-11T16:31:34.041Z"  
                Api-Url: "/ddaReports/accounts/v1/transactions/prevDay/summary"
        '403':
          description: Forbidden request access
          headers:
            X-CorrelationId:
              schema:
                type: string
              description: A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. 
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Exception'
              example:
                ErrorMessage: "Access to requested resource is forbidden"
                TransactionId:  "rrt-7709400285867417207-b-gce-27587-2383364-1"         
                X-CorrelationId: "929618f2-6163-bf73-51b0-6c54a8533c74"
                TransactionTime: "2021-06-11T16:31:34.041Z"  
                Api-Url: "/ddaReports/accounts/v1/transactions/prevDay/summary"
        '404':
          description: Resource not found
          headers:
            X-CorrelationId:
              schema:
                type: string
              description: A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. 
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Exception'
              example:
                ErrorMessage: "Requested resource is not found, please verify the resource then resubmit the request"
                TransactionId:  "rrt-7709400285867417207-b-gce-27587-2383364-1"         
                X-CorrelationId: "929618f2-6163-bf73-51b0-6c54a8533c74"
                TransactionTime: "2021-06-11T16:31:34.041Z"
                Api-Url: "/ddaReports/accounts/v1/transactions/prevDay/summary"
        '405':
          description: Invalid request method
          headers:
            X-CorrelationId:
              schema:
                type: string
              description: A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. 
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Exception'
              example:
                ErrorMessage: "Requested method is not allowed, please verify the method and resubmit the request"
                TransactionId:  "rrt-7709400285867417207-b-gce-27587-2383364-1"         
                X-CorrelationId: "929618f2-6163-bf73-51b0-6c54a8533c74"
                TransactionTime: "2021-06-11T16:31:34.041Z"
                Api-Url: "/ddaReports/accounts/v1/transactions/prevDay/summary"
        '415':
          description: Invalid request type
          headers:
            X-CorrelationId:
              schema:
                type: string
              description: A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. 
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Exception'
              example:
                ErrorMessage: "Requested media type is not allowed, please verify the media type and resubmit the request"
                TransactionId:  "rrt-7709400285867417207-b-gce-27587-2383364-1"  
                X-CorrelationId: "929618f2-6163-bf73-51b0-6c54a8533c74"
                TransactionTime: "2021-06-11T16:31:34.041Z"
                Api-Url: "/ddaReports/accounts/v1/transactions/prevDay/summary"
        '429':
          description: Request timeout
          headers:
            X-CorrelationId:
              schema:
                type: string
              description: A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. 
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Exception'
              example:
                ErrorMessage: "Number requests threshold reached, please resubmit the request after sometime"
                TransactionId:  "rrt-7709400285867417207-b-gce-27587-2383364-1" 
                X-CorrelationId: "929618f2-6163-bf73-51b0-6c54a8533c74"
                TransactionTime: "2021-06-11T16:31:34.041Z"
                Api-Url: "/ddaReports/accounts/v1/transactions/prevDay/summary"
        '500':
          description: Unknown error
          headers:
            X-CorrelationId:
              schema:
                type: string
              description: A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. 
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Exception'
              example:
                ErrorMessage: "Runtime error occurred in the service, please check with application support team before resubmitting the request"
                TransactionId:  "rrt-7709400285867417207-b-gce-27587-2383364-1"       
                X-CorrelationId: "929618f2-6163-bf73-51b0-6c54a8533c74"
                TransactionTime: "2021-06-11T16:31:34.041Z"
                Api-Url: "/ddaReports/accounts/v1/transactions/prevDay/summary"
        '502':
          description: Bad gateway
          headers:
            X-CorrelationId:
              schema:
                type: string
              description: A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. 
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Exception'
              example:
                ErrorMessage: "Error received from backend"
                TransactionId:  "rrt-7709400285867417207-b-gce-27587-2383364-1"        
                X-CorrelationId: "929618f2-6163-bf73-51b0-6c54a8533c74"
                TransactionTime: "2021-06-11T16:31:34.041Z"
                Api-Url: "/ddaReports/accounts/v1/transactions/prevDay/summary"
                ServiceError: 
                  ConnectError : "Connectivity error occurred with the downstream service (Unexpected EOF at target), please check with application support team before resubmitting the request"
        '503':
          description: Unavailable service
          headers:
            X-CorrelationId:
              schema:
                type: string
              description: A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. 
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Exception'
              example:
                ErrorMessage: "Error received from backend"
                TransactionId:  "rrt-7709400285867417207-b-gce-27587-2383364-1"     
                X-CorrelationId: "929618f2-6163-bf73-51b0-6c54a8533c74"
                TransactionTime: "2021-06-11T16:31:34.041Z"
                Api-Url: "/ddaReports/accounts/v1/transactions/prevDay/summary"
                ServiceError: 
                  ConnectError : "Service is currently unavailable (NoActiveTargets), please check with application support before resubmitting the request."
        '504':
          description: Unable to process request
          headers:
            X-CorrelationId:
              schema:
                type: string
              description: A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. 
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Exception'
              example:
                ErrorMessage: "Error received from backend"
                TransactionId:  "rrt-7709400285867417207-b-gce-27587-2383364-1"       
                X-CorrelationId: "929618f2-6163-bf73-51b0-6c54a8533c74"
                TransactionTime: "2021-06-11T16:31:34.041Z"
                Api-Url: "/ddaReports/accounts/v1/transactions/prevDay/summary"
                ServiceError: 
                  ConnectError : "Request could not be processed on time (GatewayTimeout), please wait a moment and resubmit the request."
components:
#---------------------------------------------------
# Data definitions
#---------------------------------------------------    
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
  schemas:
    healthResponse:
      type: object
      title: healthResponse
      properties:
        Status:
          type: string
          description: Status of the health check response.
        Source:
          type: string
          description: Origin of the system response can be 'Gateway' or 'Roundtrip'. Roundtrip returns a response from the farthest system involved.
        Timestamp:
          type: string
          description: Date (YYYY-MM-DD) and time (HH:MM:SS) of response from the API service.
        ClientIp:
          type: string
          description: Client IP address the gateway receives from the request.
        X-Forwarded-For:
          type: string
          description: Sequence of IP addresses for systems between the client and the gateway.
    DDATransactionsRequest:
      type: object
      description: Contains the request payload
      properties:
        getDDATransactionsRequest:
          type: object            
          required:
            - accountNumber
            - fromDate
            - toDate
          properties:
            accountNumber:
              type: array
              items:
                type: string
              description: Use a bank account number to get its historical transaction activity. Retrieving multiple accounts with a single request may impact performance, depending on the volume of transaction activity.
              example: ["123456789"]
            fromDate:
              type: string
              description: "Start date for the date range. The date must be prior to the current date. Transaction data can be recalled from the previous 24 months. Date range cannot exceed more than 90 days. Format: YYYY-MM-DD"
              example: "2022-04-01"
            toDate:
              type: string
              description: "The end date of a date range for the submitted transactions. Transaction data can be recalled from the previous 24 months. The date cannot be today's date and it must be later than the start date (fromDate). Date range cannot exceed more than 90 days. Format: YYYY-MM-DD"
              example: "2022-06-16"
            creditOrDebitCode:
              type: string
              description: "Code that indicates if the transaction is a credit or a debit. To retrieve both credit and debit transactions, leave this field blank. Valid values: C (credit), D (debit)"
              example: C
            transactionTypeCode:
              type: string
              description: The banking processor code for a particular transaction type. If the type is not specified in the request, all transaction types associated with the account activity are returned.
              example: "5602"
            fromAmount:
              type: string
              description: The minimum amount of a transaction. If no amount is specified, all amounts greater than $0.00 are returned.
              example: "100.00"
            toAmount:
              type: string
              description: The maximum amount of a transaction. If no amount is specified, all transactions are returned.
              example: "500.00"
            startRowIndex:
              type: string
              description: Pagination parameter that indicates the starting count available for the records. If this parameter is not provided, value will default to 1.
              example: "1"
            endRowIndex:
              type: string
              description: Pagination parameter that indicates the last count available for the records. If this parameter is not provided, value will default to 1000. The request cannot exceed more than 1000 records from the startRowIndex.
              example: "1000"
    responseHeaders:
      required:
      - status
      - statusDescription      
      type: object
      properties:
        status:
          type: string
          description: Indicates whether the result was successfully retrieved.
          example: S
        statusDescription:
          type: string
          description: Description of the status.
          example: Successfully fetched the records from Sourcing Layer.
        dataLoadDate:
          type: string
          format: date
          description: "Indicates the date that the requested data was loaded. Format: YYYY-MM-DD"
          example: "2021-03-26"
        retrievedRows:
          type: string
          description: Total number of transactions retrieved.
          example: "1"
        totalRows:
          type: string
          description: Total number of transactions matching the requested criteria.
          example: "10"
        summaryTotal:
          $ref: '#/components/schemas/SummaryTotal'
    SummaryTotal:
      type: object
      description: Contains the current balance summary information.
      properties:
        totalClosingLedger:
          type: string
          description: Sum of all account-level closing ledger balances.
          example: "875.00"
        totalClosingAvailable:
          type: string
          description: Sum of all account-level closing available balances.
          example: "875.00"
        totalFloatDay1:
          type: string
          description: Sum of all account-level 1 day float.
          example: "0.00"
        totalFloatDay2:
          type: string
          description: Sum of all account-level 2 day float.
          example: "0.00"
        sumTotalCredits:
          type: string
          description: Sum of all account-level total credits.
          example: "100.00"
        sumTotalDebits:
          type: string
          description: Sum of all account-level total debits.
          example: "200.00"
        totalOpeningAvailable:
          type: string
          description: Sum of all account-level opening available balances.
          example: "875.00"                
    addendaInformation:
      description: Contains addenda information by transaction type.
      type: object
      properties:
        WiresData:
          type: object
          $ref: '#/components/schemas/wiresData'  
    wiresData: 
      type: object
      description: Contains all associated wire transaction details. Applicable only if the transaction type is Wire.
      properties:
        creditArrangementTypeCode:
          type: string
          description: Credit account type code
          example: ""
        creditArrangementBankNumber:
          type: string
          description: Bank number holding the credit account.
          example: ""
        creditArrangementBankBranch:
          type: string
          description: Bank branch holding the credit account.
          example: ""
        creditArrangementCurrencyCode:
          type: string
          description: Transaction currency code of the credit account.
          example: ""
        creditInvolvedPartyIdentifier:
          type: string
          description: Customer number associated with the credit account.
          example: ""
        creditInvolvedPartyName:
          type: string
          description: Customer name associated with the credit account.
          example: ""
        creditArrangementCountryCode:
          type: string
          description: Country of the credit account.
          example: ""
        creditInvolvedPartyTypeCode:
          type: string
          description: Customer type associated with the credit account.
          example: ""
        debitArrangementTypeCode:
          type: string
          description: Debit account type code
          example: ""
        debitArrangementBankNumber:
          type: string
          description: Bank number holding the debit account.
          example: ""
        debitArrangementBankBranch:
          type: string
          description: Bank branch holding the debit account.
          example: ""
        debitArrangementCurrencyCode:
          type: string
          description: Transaction currency code of the debit account.
          example: ""
        debitInvolvedPartyIdentifier:
          type: string
          description: Customer number associated with the debit account.
          example: ""
        debitInvolvedPartyName:
          type: string
          description: Customer name associated with the debit account.
          example: ""
        transactionBusinessStatusCode:
          type: string
          description: Transaction business status code
          example: ""
        sendingBankReferenceNumber:
          type: string
          description: Reference number attached to a wire, issued by the sending bank.
          example: ""
        originatingInvolvedPartyName:
          type: string
          description: Name of the wire transaction originator.
          example: ""
        originatingArrangementNumber:
          type: string
          description: Account number of the wire transaction originator.
          example: ""
        originatingInvolvedPartyAddressLine1:
          type: string
          description: Address line 1 of the wire transaction originator.
          example: ""
        originatingInvolvedPartyAddressLine2:
          type: string
          description: Address line 2 of the wire transaction originator.
          example: ""
        beneficiaryInvolvedPartyName:
          type: string
          description: Beneficiary of the wire payment.
          example: ""
        beneficiaryArrangementNumber:
          type: string
          description: Account number of the beneficiary.
          example: ""
        beneficiaryInvolvedPartyAddressLine1:
          type: string
          description: Address line 1 of the beneficiary.
          example: ""
        beneficiaryInvolvedPartyAddressLine2:
          type: string
          description: Address line 2 of the beneficiary.
          example: ""
        intermediaryBankName:
          type: string
          description: Name of the intermediary bank.
          example: ""
        intermediaryBankABANumber:
          type: string
          description: ABA number of the intermediary bank.
          example: ""
        intermediaryBICCode:
          type: string
          description: BIC number of the intermediary bank.
          example: ""
        intermediaryBankAddressLine1:
          type: string
          description: Address line 1 of the intermediary bank.
          example: ""
        intermediaryBankAddressLine2:
          type: string
          description: Address line 2 of the intermediary bank.
          example: ""
        originatingBankName:
          type: string
          description: Name of the wire originating bank.
          example: ""
        originatingBankABANumber:
          type: string
          description: ABA number of the wire originating bank.
          example: ""
        originatingBankBICcode:
          type: string
          description: BIC number of the wire originating bank.
          example: ""
        originatingBankAddressLine1:
          type: string
          description: Address line 1 of the wire originating bank.
          example: ""
        originatingBankAddressLine2:
          type: string
          description: Address line 2 of the wire originating bank.
          example: ""
        beneficiaryBankName:
          type: string
          description: Name of the beneficiary bank.
          example: ""
        beneficiaryBankABANumber:
          type: string
          description: ABA number of the beneficiary bank.
          example: ""
        beneficiaryBankBICcode:
          type: string
          description: BIC number of the beneficiary bank.
          example: ""
        beneficiaryBankAddressLine1:
          type: string
          description: Address line 1 of the beneficiary bank.
          example: ""
        beneficiaryBankAddressLine2:
          type: string
          description: Address line 2 of the beneficiary bank.
          example: ""
        sourceTransactionIdentifier:
          type: string
          description: End-to-end ID to uniquely identify a transaction in source systems.
          example: ""
        transactionSettledDate:
          type: string
          format: date
          description: "Date the transaction is settled. Format: YYYY-MM-DD"
          example: ""
        federalReferenceNumber:
          type: string
          description: Federal reference number
          example: ""
        incomingReferenceNumber:
          type: string
          description: The incoming reference number, which is provided by the sending bank.
          example: ""
        currencyExchangeRate:
          type: string
          description: Exchange rate
          example: ""
        transactionExecutedDate:
          type: string
          format: date
          description: "Date the transaction is executed. Format: YYYY-MM-DD"
          example: ""
        bankToBankMemo:
          type: string
          description: Free-form text transmitted between the banks.
          example: ""
        transactionIdentifier:
          type: string
          description: Transaction identifier
          example: ""
        originatingABA:
          type: string
          description: ABA number of the wire originating bank.
        originating2ABA:
          type: string
          description: Alternative or second ABA number of the wire originating bank.
        originating3ABA:
          type: string
          description: Alternative or third ABA number of the wire originating bank.
        beneficiaryBankArangeNum:
          type: string
          description: Beneficiary bank account number
        beneficiaryABA:
          type: string
          description: Beneficiary ABA
        originatingBankDebitBIC:
          type: string
          description: Originating bank debit BIC
        originatingBankCreditBIC:
          type: string
          description: Originating bank credit BIC
    ddaTransactions:
      type: object
      description: Contains the list of transactions for the given date range.
      properties:
        accountNumber:
          type: string
          description: Account number associated with the transaction.
          example: "123456789"
        transactionEffectiveDate:
          type: string
          format: date
          description: "Effective date of the transaction. Format: YYYY-MM-DD"
          example: "2021-06-16"
        creditOrDebitCode:
          type: string 
          description: "Code that indicates if the transaction is a credit or a debit. Valid values: C (credit), D (debit)"
          example: "C"
        transactionTypeCode:
          type: string
          description: The banking processor code for a particular transaction type.
          example: "1003"
        transactionAmount:
          type: string
          description: Transaction amount
          example: "524.78"
        transactionKey:
          type: string
          description: An alphanumeric code associated with most transaction types (Lockbox, ACH, Wire, RTP, Check, and Deposits), the key contains the transaction date with a randomly generated ID. 
          example: "C-LBS4805120000000011"
        transactionDescription:
          type: string
          description: Brief description of the transaction.
          example: "DEPOSIT    BRANCH 0505 PENNSYLVANIA"
        transactionSequenceNumber:
          type: string
          description: Batch sequence number of the transaction.
          example: "140"
        currentLedgerBalancePostTransaction:
          type: string
          description: Current ledger balance following the posting of this transaction.
          example: "300596.77"
        currencyCode:
          type: string
          description: "Currency code of the transaction. Default value: USD"
          example: "USD"
        addendaInformation:
          type: object
          $ref: '#/components/schemas/addendaInformation'
    DDATransactionsResponse:
      type: object
      description: Contains the response payload for the transaction list request.
      properties:
        getDDATransactionsResponse:
          type: object
          required:
            - responseHeader
          properties:
            responseHeader:
              $ref: '#/components/schemas/responseHeaders'     
            DDATransactions:
              type: array
              items:
                $ref: '#/components/schemas/ddaTransactions'
    DDATransactionsResponseError:
      type: object
      description: Detailed error information as generated by the list of transactions endpoint.
      properties:
        getDDATransactionsResponse:
          type: object
          required:
            - responseHeader
          properties:
            responseHeader:
              type: object
              required:
                - status
                - statusDescription
              properties:
                status:
                  type: string
                  example: S
                  description: Indicates whether the result was successfully retrieved.
                statusDescription:
                  type: string
                  example: Successfully fetched the records from Sourcing Layer.  
                  description: Description of the status.
            errorResponse:
              $ref: '#/components/schemas/errorResponse'
    DDATransactionsDetailsRequest:
      type: object
      description: Contains the request payload
      properties:
        getDDATransactionsDetailsRequest:
          type: object
          required:
            - transactionKey
            - accountNumber
          properties:
            transactionKey:
              type: array
              items:
                type: string
                example:
                  - "D-ACH 12345678912345"
                  - "D-ACH 12345678912345" 
              description: The alphanumeric code used to keep the transaction activity secure. Multiple transactionKeys can be comma separated.
            accountNumber:
              type: array
              items:
                type: string
              description: Use a bank account number to get its historical transaction activity. Retrieving multiple accounts with a single request may impact performance, depending on the volume of transaction activity.
              example: ["123456789"]             
    DDATransactionsDetailsResponseError:
      type: object
      description: Detailed error information as generated by the detailed transaction report endpoint.
      properties:
        getDDATransactionsDetailsResponse:
          type: object
          required:
            - responseHeader
          properties:
            responseHeader:
              type: object
              required:
                - status
                - statusDescription
              properties:
                status:
                  type: string
                  example: S
                  description: Indicates whether the result was successfully retrieved.
                statusDescription:
                  type: string
                  example: Successfully fetched the records from Sourcing Layer.    
                  description: Description of the status.
            errorResponse:
              $ref: '#/components/schemas/errorResponse'
    ddaTransactionsDetailsAddendaInformation:
      type: object
      description: Contains addenda information by transaction type.
      properties:
        WiresData:
          type: object
          $ref: '#/components/schemas/wiresData'
    ddaTransactionsDetails:
      type: object
      description: Contains the transaction details associated with a specific transaction key and account number combination.
      properties:
        accountNumber:
          type: string
          description: Account number associated with the transaction.
          example: "123456789"
        transactionEffectiveDate:
          type: string
          format: date
          description: "Effective date of the transaction. Format: YYYY-MM-DD"
          example: "2019-10-31"
        dataLoadDate:
          type: string
          format: date
          description: "Indicates the date that the requested data was loaded. Format: YYYY-MM-DD"
        creditOrDebitCode:
          type: string
          description: "Code that indicates if the transaction is a credit or a debit. Valid values: C (credit), D (debit)"
          example: "D"
        transactionType:
          type: string
          description: The banking processor code for a particular transaction type.
          example: "26"
        transactionAmount:
          type: string
          description: Transaction amount
          example: "0.00"
        transactionKey:
          type: string
          description: An alphanumeric code used to keep the transaction activity secure.
          example: "12345678910123"
        transactionDescription:
          type: string
          description: Brief description of the transaction.
          example: "PADLIUCCON"
        transactionSequenceNumber:
          type: string
          description: Batch sequence number of the transaction.
        currentLedgerBalancePostTransaction:
          type: string
          description: Current ledger balance following the posting of this transaction.
          example: "-7197.9"
        snapshotDate:
          type: string
          description: "Snapshot date. Format: YYYY-MM-DD"
          example: "2021-07-09"
        collectedCashAmount:
          type: string
          description: Collected cash amount
          example: "90.82"
        shortFloatAmountDay1:                  
          type: string
          description: Dollar amount of short float for the current business day.
          example: "0"
        checkSerialNumber:
          type: string
          description: Serial number of the check.
          example: "100014399"
        traceID:
          type: string
          description: Source transaction identifier
          example: "C 000000000000000001"
        glSourceCode:                  
          type: string
          description: KeyBank-assigned GL source code
          example: "5"
        operatorID:
          type: string
          description: Operator ID - free-form text field for use by sending application.
          example: null
        BAICode:
          type: string
          description: The three-digit BAI (Bank Administration Institute) code for the transaction.
          example: "301"
        BAICodeDesc:
          type: string
          description: Provides the description corresponding to a BAI code.
          example: "COMMERCIAL DEPOSIT"
        addendaInformation:
          type: object
          $ref: '#/components/schemas/ddaTransactionsDetailsAddendaInformation'        
    ddaPrevDaySummary:
      type: object
      properties:
        accountNumber:
          type: string
          description: Account number associated with the transaction. 
          example: "123456789"
        closingLedger:
          type: string
          description: Ledger balance in the account at the time of closure.
          example: "875.00"
        closingAvailable:
          type: string
          description: Amount available end of day for transactions.
          example: "850.00"
        shortFloatAmountDay0:
          type: string
          description: Dollar amount of short float day 0.
          example: "0.00"
        shortFloatAmountDay1:
          type: string
          description: Dollar amount of short float day 1.
          example: "0.00"
        shortFloatAmountDay2:
          type: string
          description: Dollar amount of short float day 2.
          example: "0.00"
        shortFloatAmountDay3:
          type: string
          description: Dollar amount of short float day 3.
          example: "0.00"
        shortFloatAmountDay4:
          type: string
          description: Dollar amount of short float day 4.
          example: "0.00"
        shortFloatAmountDay5:
          type: string
          description: Dollar amount of short float day 5.
          example: "0.00"
        shortFloatAmountDay6:
          type: string
          description: Dollar amount of short float day 6.
          example: "0.00"
        reportDate:
          type: string
          format: date
          description: "Date the transaction posted. Format: YYYY-MM-DD"
          example: "2021-05-21"
        totalCredits:
          type: string
          description: Total credit transaction amount
          example: "2"
        totalDebits:
          type: string
          description: Total debit transaction amount
          example: "5"
        openingAvailable:
          type: string
          description: Opening available balance
          example: "875.00"
        achCredits:
          type: string
          description: ACH credits amount
          example: "100.00"
        depositsAmount:
          type: string
          description: Deposits amount
          example: "100.00"
        wireTransferCredits:
          type: string
          description: Wire transfer credits amount
          example: "5.00"
        zbaCredits:
          type: string
          description: ZBA credits amount
          example: "0.00"
        otherMiscCredits:
          type: string
          description: Other miscellaneous credits amount
          example: "5.00"
        achDebits:
          type: string
          description: ACH debits amount
          example: "50.00"
        checksAmount:
          type: string
          description: Checks amount
          example: "10.00"
        returnedItemDebits:
          type: string
          description: Returned item debits amount
          example: "10.00"
        wireTransferDebits:
          type: string
          description: Wire transfer debits amount
          example: "10.00"
        zbaDebits:
          type: string
          description: ZBA debits amount 
          example: "0.00"
        otherMiscDebits:
          type: string
          description: Other miscellaneous debits amount
          example: "0.00"
        totalAccountCredits:
          type: string
          description: Total account credits
          example: "10.00"
        totalAccountDebits:
          type: string
          description: Total account debits
          example: "10.00"
        achCreditCount:
          type: string
          description: ACH credits count
          example: "1"
        depositsCount:
          type: string
          description: Deposits count
          example: "5"
        wireTransferCreditsCount:
          type: string
          description: Wire transfer credits count
          example: "0"
        zbaCreditsCount:
          type: string
          description: ZBA credits count
          example: "0"
        otherMiscCreditsCount:
          type: string
          description: Other miscellaneous credits count
          example: "0"
        achDebitsCount:
          type: string
          description: ACH debits count
          example: "2"
        checksCount:
          type: string
          description: Checks count
          example: "1"
        returnedItemDebitsCount:
          type: string
          description: Returned item debits count
          example: "0"
        wireTransferDebitsCount:
          type: string
          description: Wire transfer debits count
          example: "3"
        zbaDebitsCount:
          type: string
          description: ZBA debits count 
          example: "0"
        otherMiscDebitsCount:
          type: string
          description: Other miscellaneous debits count
          example: "0"
        totalCreditCount:
          type: string
          description: Total credits count
          example: "3"
        totalDebitCount:
          type: string   
          description: Total debits count
          example: "4"  
    DDATransactionsDetailsResponse:
      type: object
      properties:
        getDDATransactionsDetailsResponse:
          type: object
          required:
            - responseHeader
          properties:
            responseHeader:
              $ref: '#/components/schemas/responseHeaders'
            DDATransactionsDetails:
              type: array
              items:
                $ref: '#/components/schemas/ddaTransactionsDetails'                   
    DDAPrevDaySummaryRequest:
      type: object
      description: Contains the request payload
      properties:
        getDDAPrevDaySummaryRequest:
          type: object
          required:
            - accountNumber
            - date
          properties:
            accountNumber:
              type: array
              items:
                type: string
              description: Use a bank account number to get its historical transaction activity. Retrieving multiple accounts with a single request may impact performance, depending on the volume of transaction activity.
              example: ["123456789"]
            date:
              type: string
              description: "Date for which the transaction summaries are to be retrieved. Transaction data can be recalled from the previous 24 months. Format: YYYY-MM-DD"
              example: "2018-11-20"
    DDAPrevDaySummaryResponse:
      type: object
      description: Contains the response payload for the account summary report request.
      properties:
        getDDAPrevDaySummaryResponse:
          type: object
          required:
            - responseHeader
          properties:
            responseHeader:
             $ref: '#/components/schemas/responseHeaders'     
            DDAPrevDaySummary:
             type: array
             items:
              $ref: '#/components/schemas/ddaPrevDaySummary'     
    DDAPrevDaySummaryResponseError:
      type: object
      description: Detailed error information as generated by the account summary report endpoint.
      properties:
        getDDAPrevDaySummaryResponse:
          type: object
          required:
            - responseHeader
          properties:
            responseHeader:
              required:
                - status
                - statusDescription
              properties:
                status:
                  type: string
                  example: S
                  description: Indicates whether the result was successfully retrieved.
                statusDescription:
                  type: string
                  description: Description of the status.
              type: object
            errorResponse:
              $ref: '#/components/schemas/errorResponse'
    Exception:
      type: object
      description: Contains information about errors related to the request.
      title: ExceptionSchema
      properties:
        ErrorMessage: 
          type: string
          description: A human-readable message that describes the type or source of the error.
          example: "Requested resource is not found, please verify the resource then resubmit the request."
        TransactionId:
          type: string
          description: A unique transaction ID returned with the response, useful for traceability.
          example: "rrt-7354978519411102852-c-gce-30597-7590748-1"
        TransactionTime: 
          type: string
          description: Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
          example: "2021-06-30T18:55:10.337"
        Api-Url:
          type: string
          description: The API URL path in the call that generated the response.
        ServiceError:
          type: object
          title: ServiceError
          description: Detailed service-level error details, if available.
          oneOf:
            - $ref: '#/components/schemas/ServiceErrorData'
            - $ref: '#/components/schemas/connectError'          
    connectError:
      type: object
      properties:
        ConnectError:
          type: string
          description: API connectivity error information, if available.
    errorResponse:
      type: object
      description: Detailed error information generated by the chain of services involved either as a business fault or system fault.
      properties:
        businessFault:
          type: array
          items:
            $ref: '#/components/schemas/businessFault'
        systemFault:
          type: array
          items:
            $ref: '#/components/schemas/systemFault'
    businessFault: 
      type: object
      description: Indicates business fault error details.
      properties:
        errorCode:
          type: string
          description: Business error code
          example: ECA-W-001
        errorDescription:
          type: string
          description: A human-readable message that describes the type or source of the business error.
          example: Missing mandatory field(s)-AccountNumber. 
    ServiceErrorData:
      type: object
      description: Detailed service-level error details, if available.
      title: ServiceErrorData
      oneOf:
      - $ref: '#/components/schemas/DDATransactionsResponseError'
      - $ref: '#/components/schemas/DDATransactionsDetailsResponseError'
      - $ref: '#/components/schemas/DDAPrevDaySummaryResponseError'
    systemFault:
      type: object
      description: Indicates system fault error details.
      properties:
        errorCode:
          type: string
          description: System error code
          example: ECA-E-001
        errorDescription:
          type: string
          description: A human-readable message that describes the type or source of the system error.
          example: WM encountered an error while trying to retrieve Count of records from database.
