---
swagger: "2.0"
info:
  title: CSMT-SEH-V-AccountStatementTransactions
  description: The Microservice helps to orchestrate and retrieve account specific
    transactions for  a particular period
  version: 1.0.0
  x-ibm-name: csmt-seh-v-accountstatementtransactions
host: 127.0.0.1
schemes:
- https
basePath: /api
produces:
- application/json
paths:
  /v1/customers/accounts/statements/transactions:
    post:
      tags:
      - account-statement-transactions
      operationId: account-statement-transactions
      summary: The API helps to orchestrate and retrieve account specific transactions
        for  a particular period
      description: The API helps to orchestrate and retrieve account specific transactions
        for  a particular period
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: client_id
        in: header
        required: true
        type: string
        description: Client ID generated during application registration
      - name: Authorization
        in: header
        required: true
        type: string
        description: The Authorization Token received during login
      - name: Accept
        in: header
        required: true
        type: string
        description: Content-Types that are acceptable for the response
      - name: uuid
        in: header
        required: true
        type: string
        description: 128 bit UUID that you generate for every request
      - name: Accept-Language
        in: header
        required: false
        type: string
        description: List of acceptable human languages for response
      - name: Content-Type
        in: header
        required: true
        type: string
        description: Content-Types that are sent in the request
      - name: ChannelId
        in: header
        required: true
        type: string
        description: Channel where request originated
      - name: sid
        in: header
        required: true
        type: string
        description: SessionId sent by Consumer
      - name: accountStatementTransactionRequest
        in: body
        required: true
        description: Cycle for which transaction being requested
        schema:
          $ref: '#/definitions/AccountStatementTransactionRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/AccountStatementTransactionResponse'
        400:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>invalidRequest</td><td>Missing
            or invalid Parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>unAuthorized</td><td>Authorization
            credentials are missing or invalid</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        403:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>The request
            operation is not configured to access this resource</td><td>Channel/Country/Business
            provided in the request is not supported currently</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>resourceNotFound</td><td>The requested
            resource was not found</td><td>Empty resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>businessValidationFailed</td><td>Business
            validation error occured on one or more parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>fatal</td><td>serverUnavailable</td><td>The
            request failed due to an internal error/server unavailability</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
definitions:
  AccountStatementTransactionRequest:
    type: object
    properties:
      accountId:
        type: string
        description: unique identifier of account mapped to account number
        example: "12345678"
      rowLimit:
        description: Maximum Number of transactions per request for each account
        type: integer
        format: int32
        example: 10
      pageId:
        description: Page Id
        type: integer
        example: 10
      transactionQueryCycle:
        description: Cycle for which transaction being requested
        type: integer
        example: 10
    required:
    - accountId
    - rowLimit
    - pageId
    - transactionQueryCycle
  AccountStatementTransactionResponse:
    type: object
    properties:
      moreInformationFlag:
        description: Indicates if the account has more transactions available.
        type: boolean
        example: true
      pageId:
        description: Id of the page
        type: integer
        format: int32
        example: 5
      transactionQueryCycle:
        description: Transaction Cycle for which details is required
        type: integer
        example: 10
      transactions:
        type: array
        items:
          $ref: '#/definitions/Transaction'
    required:
    - moreInformationFlag
    - transactionQueryCycle
    - pageId
  Transaction:
    type: object
    properties:
      transactionAmount:
        description: Transaction amount
        type: number
        format: double
        example: 15000.010000
      transactionDate:
        description: Date on which the transaction was made
        type: string
        example: "2019-12-26"
      transactionDescription:
        description: Transaction description
        type: string
        example: IVA COMISION ANUAL
      transactionStatus:
        description: Transaction status
        type: string
        example: Aprobada
      requestReceiptIndicator:
        description: Indicate if the transaction is for CEP
        type: string
        example: E
      transactionReferenceNumber:
        description: Transaction reference number
        type: string
        example: D INT 423234454
      authorizationCode:
        description: Transaction authorization code
        type: string
        example: "1274"
      runningBalanceAmount:
        description: Refers to available balance in the account associated with current
          transaction
        type: number
        format: double
        example: 55286.950000
      merchantCategoryCode:
        description: It is used to classify the business by the type of goods or services
          it provides
        type: string
        example: "145253"
      loanTransactions:
        $ref: '#/definitions/LoanAccount'
  LoanAccount:
    type: object
    properties:
      transactionCode:
        description: Transaction Code
        type: string
        example: "123"
      transactionType:
        description: Transaction Type
        type: string
        example: "01"
      branchId:
        description: Branch Id
        type: string
        example: "1234"
      tellerStationNumber:
        description: Teller where the transaction is attended
        type: string
        example: "123"
  ErrorResponse:
    properties:
      type:
        type: string
        description: Invalid - Request did not confirm to the specification and was
          unprocessed and rejected. Please fix the value and try again
        enum:
        - error
        - warn
        - invalid
        - fatal
      code:
        description: Error code which qualifies the error
        type: string
      details:
        description: Human readable explanation specific to the occurrence of the
          problem
        type: string
      location:
        description: The name of the field that resulted in the error
        type: string
      moreInfo:
        description: More Info can be used to pass any additional details
        type: string
      uuid:
        description: 128 bit UUID that you generate for every request
        type: string
      timestamp:
        description: Timestamp of the error
        type: string
    required:
    - type
    - code
x-ibm-configuration:
  enforced: true
  testable: true
  phase: realized
securityDefinitions:
  OAuth2 Application Flow:
    type: oauth2
    description: ""
    flow: application
    scopes:
      /api/v1: ""
    tokenUrl: https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/oauth/token
  Client ID:
    type: apiKey
    description: ""
    in: header
    name: X-IBM-Client-Id
security:
- OAuth2 Application Flow:
  - /api/v1
  Client ID: []
x-ibm-endpoints:
- endpointUrl: https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
  type:
  - production
  - development
...