---
swagger: "2.0"
info:
  title: PAYM-POR-D-AutoPay
  description: This microservices is for getting and updating recurring payment information
  version: 1.0.0
  x-ibm-name: paym-por-d-autopay
schemes:
- https
basePath: /api
produces:
- application/json
paths:
  /v1/payments/schedule/auto/retreive:
    post:
      tags:
      - retrieve-recurring-payments
      summary: Retrieve recurring payments of a Customer
      description: Gets all recurring transactions from Credit Card of a customer
      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: CountryCode
        in: header
        required: false
        type: string
        description: Country code where the request was made
      - name: BusinessCode
        in: header
        required: false
        type: string
        description: Code of the business which made 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: retrieveRecurringPaymentsRequest
        in: body
        schema:
          $ref: '#/definitions/RetrieveRecurringPaymentsRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/RetrieveRecurringPaymentsResponse'
        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'
  /v1/payments/schedule/auto:
    put:
      tags:
      - update-recurring-payments
      summary: This API updates the status of the recurring payment of a credit card
      description: This API uodates the status of the recurring payment information
        from ECS
      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: CountryCode
        in: header
        required: false
        type: string
        description: Country code where the request was made
      - name: BusinessCode
        in: header
        required: false
        type: string
        description: Code of the business which made the request
      - 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: updateRecurringPaymentRequest
        in: body
        schema:
          $ref: '#/definitions/UpdateRecurringPaymentRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/UpdateRecurringPaymentResponse'
        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'
        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:
  RetrieveRecurringPaymentsRequest:
    type: object
    properties:
      cardNumber:
        description: Number of the plastic card
        type: string
        maxLength: 19
        example: "4332233223233285"
      productClasification:
        description: Product clasification for plastic card
        type: string
        maxLength: 3
        example: "32"
      customerId:
        description: ID of the Customer
        type: string
        maxLength: 19
        example: "73320983"
      requestType:
        description: Identify the detail required
        type: string
        maxLength: 1
        example: C
      payeeId:
        description: Id to identify the payee
        type: string
        example: "33442"
      contractId:
        description: Id to identify the contract between customer and payee
        type: string
        maxLength: 20
        example: "333567443"
      autoPayStatus:
        description: Identify the status of contracts required to be listed
        type: string
        maxLength: 1
        example: A
      nextRecords:
        $ref: '#/definitions/nextRecords'
    required:
    - cardNumber
    - requestType
  RetrieveRecurringPaymentsResponse:
    type: object
    properties:
      totalRecurringPayments:
        description: total of recurrent payments retrieved
        type: integer
        format: int32
        example: 89
      customerId:
        description: Customer number for Identification
        type: string
        maxLength: 19
        example: "39867433389"
      cardAccount:
        $ref: '#/definitions/CardAccount'
      nextRecords:
        $ref: '#/definitions/nextRecords'
    required:
    - customerId
    - totalRecurringPayments
  CardAccount:
    type: object
    properties:
      accountNumber:
        description: Number of the Customer's account
        type: string
        maxLength: 19
        example: "3348889222"
      cardNumber:
        description: Number of the plastic card
        type: string
        maxLength: 19
        example: "2334993322137766"
      cardStatus:
        description: Status of the plastic card
        type: string
        maxLength: 1
        example: active
      accountLogoName:
        description: Logo description
        type: string
        maxLength: 30
        example: active
      autoPayDetails:
        type: array
        items:
          $ref: '#/definitions/AutoPayDetails'
    required:
    - accountNumber
    - cardNumber
    - cardStatus
    - cardType
    - productClasification
  AutoPayDetails:
    type: object
    properties:
      autoPayCancelDate:
        description: Date of the last transaction of the recurring payment
        type: string
        format: date
        maxLength: 8
        example: "20180122"
      autoPayStartDate:
        description: Date when the recurring payment is restarted
        type: string
        format: date
        maxLength: 8
        example: "20181212"
      autoPayDate:
        description: Date when the recurring payment is recorded
        type: string
        format: date
        maxLength: 8
        example: "20181212"
      autoPayStatus:
        description: Status of the recurring payment
        type: string
        maxLength: 1
        example: Block
      paymentAmount:
        description: Total of the amount for paying in the recurring payment
        type: number
        format: double
        example: 2220032.220000
      contractId:
        description: Contract or Id of scheduled payment
        type: string
        maxLength: 20
        example: "9884383"
      customerSource:
        description: Source from the data was recorded
        type: string
        maxLength: 1
        example: M
      suspendedUpdateDaysCount:
        description: Number of days is going to be blocked any change for this recurring
          payment
        type: integer
        format: int32
        example: 30
      terminationDate:
        description: Date when the recurring payment was canceled or blocked
        type: string
        format: date
        maxLength: 8
        example: "20181209"
      recurringPaymentBlockedReasonType:
        description: 'Type of recurring payment block, it could be Merchant or Contract '
        type: string
        maxLength: 1
        example: M
      folioNumber:
        description: Folio number of an operation generated in OneEclipse
        type: string
        maxLength: 16
        example: "20181209"
      payeeDetails:
        $ref: '#/definitions/PayeeDetails'
    required:
    - autoPayCancelnDate
    - autoPayStartDate
    - autoPayStatus
    - paymentAmount
    - paymentScheduleId
    - suspendedUpdateDaysCount
    - terminationDate
  PayeeDetails:
    type: object
    properties:
      payeeId:
        description: Id number of the merchant
        type: string
        maxLength: 19
        example: "443255"
      payeeName:
        description: Name of the merchant
        type: string
        maxLength: 40
        example: Empresas Transnacionales S.A. de C.V.
      payeeStatus:
        description: Status of the merchant
        type: string
        maxLength: 1
        example: A
      transactions:
        type: array
        items:
          $ref: '#/definitions/Transaction'
    required:
    - payeeId
    - payeeName
    - payeeStatus
  Transaction:
    type: object
    properties:
      transactionAmount:
        description: Amount of the transaction
        type: number
        format: double
        example: 3323.220000
      transactionDate:
        description: Date when the transaction was made
        type: string
        format: date
        maxLength: 8
        example: "20181212"
    required:
    - transactionAmount
    - transactionDate
  UpdateRecurringPaymentRequest:
    type: object
    properties:
      customerId:
        description: Customer Id from the requester
        type: string
        maxLength: 19
        example: "4467965668"
      autoPay:
        $ref: '#/definitions/AutoPay'
    required:
    - customerId
  UpdateRecurringPaymentResponse:
    type: object
    properties:
      suspendedUpdateDate:
        description: Next date when the customer can perform action (Block/unlock/reactivation)
        type: string
        format: Date
        example: "20181018"
  nextRecords:
    type: object
    properties:
      nextAccountNumberToFetch:
        description: Next customer's account number  to retrieve
        type: string
        maxLength: 19
        example: "996774933"
      NextPayeeIdToFetch:
        description: Next payee Id to retrieve
        type: string
        maxLength: 19
        example: "5588"
      nextContractNumberToFetch:
        description: Next contract number to retrieve
        type: string
        maxLength: 20
        example: "1008933"
  AutoPay:
    type: object
    properties:
      autoPayStatus:
        description: Type of update requested
        type: string
        maxLength: 1
        example: B
      contractId:
        description: Contract or Id of scheduled payment
        type: string
        maxLength: 20
        example: "9884383"
      folioNumber:
        description: Folio number of an operation generated in OneEclipse
        type: string
        maxLength: 16
        example: "20181209"
      updateLevel:
        description: Level for indicate the type of updating, for CARD, Merchant or
          Contract Number
        type: string
        maxLength: 1
        example: M
      cardPlastic:
        $ref: '#/definitions/CardPlastic'
      payee:
        $ref: '#/definitions/Payee'
    required:
    - accountNumber
  CardPlastic:
    type: object
    properties:
      cardNumber:
        description: Number of the plastic card
        type: string
        maxLength: 19
        example: "3344336643482200"
      productClasification:
        description: Product clasification for plastic card
        type: string
        maxLength: 3
        example: "32"
    required:
    - cardNumber
  Payee:
    type: object
    properties:
      payeeId:
        description: Id number of the payee
        type: string
        maxLength: 19
        example: "33432"
  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
consumes:
- application/json
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
...