---
swagger: "2.0"
info:
  title: PAYM-CHP-D-ChequeInformation
  description: This microservice is used to manage the details related to the check
    of the customer
  version: 1.0.0
  x-ibm-name: paym-chp-d-chequeinformation
host: 127.0.0.1
schemes:
- https
basePath: /api
produces:
- application/json
paths:
  /v1/payments/accounts/checks/status/retrieve:
    post:
      tags:
      - retrieve-check-status-list
      operationId: retrieve-check-status-list
      summary: To retrieve the status details of the check for the customer
      description: This API is used to retrieve the status details of the check for
        the customer
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: client_id
        in: header
        required: false
        type: string
        description: Client ID generated during application registration
      - name: Authorization
        in: header
        required: false
        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: false
        type: string
        description: SessionId sent by Consumer
      - name: retrieveCheckStatusRequest
        in: body
        schema:
          $ref: '#/definitions/RetrieveCheckStatusRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/RetrieveCheckStatusResponse'
        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:
  RetrieveCheckStatusRequest:
    type: object
    properties:
      accountAccessPrefix:
        description: Account access prefix
        type: string
        example: "123456"
      accountNumber:
        description: Account Number
        type: string
        example: "1234567890123456"
      checkNumber:
        description: The check number is the unique identification number of the check
        type: string
        example: "1925678"
      pageId:
        description: Unique identifier of the page for pagination
        type: integer
        format: int32
        example: 2
      'dataCenterLocation ':
        description: Location of the data center. Values 10.- Valle and 4.-MTY
        type: integer
        example: 10
    required:
    - accountAccessPrefix
    - accountNumber
    - checkNumber
  RetrieveCheckStatusResponse:
    type: object
    properties:
      accountAccessPrefix:
        description: Account access prefix
        type: string
        example: "123456"
      accountNumber:
        description: Account Number
        type: string
        example: "1234567890123456"
      checkNumber:
        description: The check number is the unique identification number of the check
        type: string
        example: "1925678"
      moreInformationFlag:
        description: More Information Flag
        type: boolean
        example: true
      pageId:
        description: Unique identifier of the page for pagination
        type: integer
        format: int32
        example: 2
      transactions:
        type: array
        items:
          $ref: '#/definitions/Transaction'
    required:
    - accountAccessPrefix
    - accountNumber
    - checkNumber
  Transaction:
    type: object
    properties:
      checkAmount:
        description: Amount specified in the check for the transaction
        type: number
        format: double
        example: 5000.550000
      finalCheckNumber:
        description: Final continuity code id of the check group where the change
          status was applied
        type: string
        example: "1925685"
      finalCheckStatus:
        description: Refers to the detail of the final check (cheque) status
        type: string
        example: Active
      initialCheckNumber:
        description: Initial continuity code id of the check group where the change
          status was applied
        type: string
        example: "1925678"
      initialCheckStatus:
        description: Refers to the detail of the initial check (cheque) status
        type: string
        example: Inactive
      transactionTimestamp:
        description: Refers to the system date and time when the actual transaction
          was executed for an account
        type: string
        format: datetime
        example: 2019-09-12T03:22:00.000z
      transactionAuthorization:
        $ref: '#/definitions/TransactionAuthorization'
    required:
    - checkAmount
    - finalCheckNumber
    - finalCheckStatus
    - initialCheckNumber
    - initialCheckStatus
    - transactionTimestamp
  TransactionAuthorization:
    type: object
    properties:
      agentId:
        description: Id of the operator
        type: string
        example: "123456"
      authorizationCode:
        description: Authorization Number
        type: string
        example: "123456789"
      branchId:
        description: Unique identifier of the branch where the transaction was applied
        type: integer
        format: int32
        example: 1234
      originatingChannelId:
        description: Originating Channel Id
        type: string
        example: "123456789012"
    required:
    - agentId
    - authorizationCode
    - branchId
    - originatingChannelId
  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://sit.api.banamex.com/mx-gcgapi/sit/api/v1/oauth/token
  Client ID:
    type: apiKey
    description: ""
    in: header
    name: X-IBM-Client-Id
security:
- Client ID: []
  OAuth2 Application Flow:
  - /api/v1
x-ibm-endpoints:
- endpointUrl: https://sit.api.banamex.com/mx-gcgapi/sit
  description: Custom Gateway API Endpoint
  type:
  - production
  - development
...