---
swagger: "2.0"
info:
  title: PAYM-PPM-O-PemexPayment
  description: This API is to process a PEMEX refinery payment created from citidirect
    platform. The  PEMEX Refinery microservice is going to place the request to intelligent
    channel (tuxedo) via an undefined mechanism (pending definition).
  version: 1.0.0
  x-ibm-name: paym-ppm-o-pemexpayment
host: 127.0.0.1
schemes:
- https
basePath: /api
produces:
- application/json
paths:
  /v1/payments/pemex:
    post:
      tags:
      - processRefineryPayment
      summary: To process a PEMEX refinery payment created from citidirect platform.
      description: This API is to process a PEMEX refinery payment created from citidirect
        platform. The  PEMEX Refinery microservice is going to place the request to
        intelligent channel (tuxedo) via an undefined mechanism (pending definition).
        This API is post-login, and entry-point and private.
      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
        description: The Authorization Token received during login
        type: string
        required: true
      - name: Accept
        in: header
        description: Content-Types that are acceptable for the response
        type: string
        required: true
      - name: uuid
        in: header
        description: 128 bit UUID that you generate for every request
        type: string
        required: true
      - name: Accept-Language
        in: header
        description: List of acceptable human languages for response
        type: string
        required: false
      - name: Content-Type
        in: header
        description: Content-Types that are sent in the request
        required: true
        type: string
      - name: ChannelID
        in: header
        description: Channel Id identifies the consumer from where the request comes
        required: true
        type: string
      - name: sid
        in: header
        description: SessionId sent by Consumer
        required: true
        type: string
      - name: processRefineryPaymentRequest
        in: body
        schema:
          $ref: '#/definitions/ProcessRefineryPaymentRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/ProcessRefineryPaymentResponse'
        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:
  ProcessRefineryPaymentRequest:
    type: object
    properties:
      sourceAccount:
        $ref: '#/definitions/SourceAccount'
  SourceAccount:
    type: object
    properties:
      accountNumber:
        description: Account number of the customer
        type: string
        example: "123456789012"
      branchId:
        description: Branch Code of the branch which hold the account.
        type: string
        example: b001
      customerId:
        description: Customer ID is a key associated with a specific entity or person
          Citi does business or has some relationship with.
        type: string
        example: A123
      payment:
        $ref: '#/definitions/Payment'
    required:
    - accountNumber
    - branchId
    - customerId
  Payment:
    type: object
    properties:
      paymentAmount:
        description: Payment Amount
        type: number
        format: double
        example: 25000
      paymentDescription:
        description: Detail description of the payment made
        type: string
        example: Sample description
      pemexId:
        description: Unique identifier associated with Pemex account
        type: string
        example: "0"
    required:
    - paymentAmount
    - pemexId
  ProcessRefineryPaymentResponse:
    type: object
    properties:
      paymentAuthorizationNumber:
        description: Payment Authorization Number.
        type: string
        example: "527016"
      paymentDate:
        description: Date and time on which payment is made
        type: string
        format: datetime
        example: "2018-04-22 07:22:06"
    required:
    - paymentAuthorizationNumber
    - paymentDate
  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
    required:
    - type
    - code
x-ibm-configuration:
  enforced: true
  testable: true
  phase: realized
securityDefinitions:
  OAuth2 Application Flow:
    type: oauth2
    description: ""
    flow: application
    tokenUrl: https://sit.api.banamex.com/mx-gcgapi/sit/api/v1/oauth/token
    scopes:
      /api/v1: ""
  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
...