---
swagger: "2.0"
info:
  title: PAYM-EAS-D-Debit-POC
  description: The purpose of this Microservice is to test a debit transaction for
    eas.
  version: 1.0.0
  x-ibm-name: paym-eas-d-debit-poc
host: 127.0.0.1
schemes:
- https
basePath: /api
produces:
- application/json
paths:
  /v1/payments/debit/checking:
    post:
      tags:
      - debit-checking-account
      summary: 'To debit an amount from the checking account in system S500 '
      description: 'This API is used to debit an amount from the checking account
        in system S500 '
      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: dataCenterLocation
        in: header
        description: CSI Data center location number
        required: false
        type: string
        maxLength: 2
      - name: stationName
        in: header
        description: Computer name calling or executing API
        required: false
        type: string
        maxLength: 8
      - name: debitCheckingAccountRequest
        in: body
        schema:
          $ref: '#/definitions/DebitCheckingAccountRequest'
      responses:
        200:
          description: Successful operation.
        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:
  DebitCheckingAccountRequest:
    type: object
    properties:
      stationName:
        description: identificador de la estacion (lenght 8)
        type: string
        example: Y0870A76
      applicationReferenceNumber:
        description: Authorization number sent by front end for each transaction
        type: string
        example: "00000001"
      dataCenterLocation:
        description: customer csi length 2
        type: integer
        example: "10"
      idCaja:
        description: identificador de caja contable (lenght 1)
        type: string
        example: A
      numeroCaja:
        description: numero de caja contable (length 2)
        type: integer
        example: 70
      debitDetailInformation:
        $ref: '#/definitions/DebitDetailInformation'
      account:
        $ref: '#/definitions/AccountDetails'
    required:
    - applicationReferenceNumber
    - stationName
    - dataCenterLocation
    - idCaja
    - numeroCaja
    - debitDetailInformation
  DebitDetailInformation:
    type: object
    properties:
      debitAmount:
        description: Debit Amount
        type: number
        format: double
        example: 2500
      debitReference:
        description: Numeric Reference (Length 12)
        type: string
        example: "123456789012"
      debitDescription:
        description: Legend Alphanumeric (identificador j-16)
        type: string
        example: OXXO
    required:
    - paymentAmount
    - debitReference
    - debitDescription
  AccountDetails:
    type: object
    properties:
      accountIdentifier:
        description: Account Contract
        type: string
        example: "123456789012"
      branchId:
        description: Origin bank branch Id
        type: string
        example: "9999"
    required:
    - accountIdentifier
    - branchId
  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: URI to human readable documentation or detailed description of
          the error
        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:
- OAuth2 Application Flow:
  - /api/v1
  Client ID: []
x-ibm-endpoints:
- endpointUrl: https://sit.api.banamex.com/mx-gcgapi/sit
  description: Custom Gateway API Endpoint
  type:
  - production
  - development
...