---
swagger: "2.0"
info:
  title: SERV-PYO-D-ProcessedPayments
  description: This micro service has the functionality to retrieve details of the
    processed payment files.
  version: 1.0.0
  x-ibm-name: serv-pyo-d-processedpayments
host: 127.0.0.1
schemes:
- https
basePath: /api
produces:
- application/json
paths:
  /v1/servicing/payments/status/retrieve:
    post:
      tags:
      - retrieve-payment-status
      operationId: retrieve-payment-status
      summary: The API is used to check the status of the success operations.
      description: search a payment file and retrive the status details.
      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: true
        type: string
        description: Country code in 2 character ISO 3166 format.
      - name: businesscode
        in: header
        required: true
        type: string
        description: Business code identified during application registration.
      - name: ChannelId
        in: header
        required: true
        type: string
        description: Channel where request originated.
      - name: sid
        in: header
        required: true
        type: string
      - name: retrievePaymentStatusRequest
        in: body
        required: true
        schema:
          $ref: '#/definitions/RetrievePaymentStatusRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/RetrievePaymentStatusResponse'
        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/servicing/payments/rejected/retrieve:
    post:
      tags:
      - retrieve-rejected-payments
      operationId: retrieve-rejected-payments
      summary: The API is used to check the details of the rejected payments.
      description: Search for a payment file and retrieve the status details  of rejected
        payments.
      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: true
        type: string
        description: Country code in 2 character ISO 3166 format.
      - name: businesscode
        in: header
        required: true
        type: string
        description: Business code identified during application registration.
      - 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: retrieveRejectedPaymentsRequest
        in: body
        required: true
        schema:
          $ref: '#/definitions/RetrieveRejectedPaymentsRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/RetrieveRejectedPaymentsResponse'
        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:
  RetrievePaymentStatusRequest:
    type: object
    properties:
      customerId:
        description: CitiBanamex internal customer indentifier.
        type: string
        minLength: 1
        maxLength: 12
        pattern: ^[0-9]{1,12}
        example: "668450123"
      paymentFile:
        $ref: '#/definitions/PaymentFile'
    required:
    - customerId
    - paymentFile
  RetrieveRejectedPaymentsRequest:
    type: object
    properties:
      customerId:
        description: CitiBanamex internal customer indentifier.
        type: string
        minLength: 1
        maxLength: 12
        pattern: ^[0-9]{1,12}
        example: "668450123"
      paymentFile:
        $ref: '#/definitions/PaymentFile'
    required:
    - customerId
    - paymentFile
  PaymentFile:
    type: object
    properties:
      fileSequenceNumber:
        description: is a sequential number of the payment file.
        type: integer
        format: int32
        example: 99
      paymentDate:
        description: It is the date of the customer when he uploads his payment file,
          it is considered as the original date of the payment application.
        type: string
        format: date
        pattern: ([12]\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01]))
        example: "2019-12-30"
      serviceSubType:
        description: This field refers to the nature of the file,  with which the
          file is categorized in the payment domain.
        type: string
        minLength: 1
        maxLength: 2
        example: "05"
        pattern: ^[0-9][1-9]{1,2}
    required:
    - fileSequenceNumber
    - paymentDate
    - serviceSubType
  RetrievePaymentStatusResponse:
    type: object
    properties:
      paymentFileDetail:
        $ref: '#/definitions/PaymentFileDetail'
      paymentSummary:
        type: array
        items:
          $ref: '#/definitions/PaymentSummary'
  PaymentFileDetail:
    type: object
    properties:
      fileStatusCode:
        description: Code of payment file status.
        type: string
        maxLength: 2
        example: 30
      fileStatusReason:
        description: Reason of the status the processed file.
        type: string
        maxLength: 20
        example: Procesado
      paymentFileRejectionReason:
        description: Reason for file payment rejection.
        type: string
        maxLength: 20
        example: Error en el formato del archivo
      authorizationCode:
        description: Is the code of authorization for the payment file.
        type: integer
        maxLength: 6
        format: int32
        example: 800
      fileDescription:
        description: Description of file.
        type: string
        maxLength: 20
        example: PAGO NOMINA
      rejectionRetryCount:
        description: Number of retries for all payments into the file.
        type: integer
        maxLength: 6
        format: int32
        example: 30
      totalPaymentCount:
        description: Total count of payments into the file.
        type: integer
        format: int32
        example: 1500
      fileName:
        description: Name of the payment file
        type: string
        example: 2019-11-05_09-32-29.302_27414s01.10.051119.000000013898.002.pgm_sol_Req.xml
    required:
    - fileStatusCode
    - fileStatusReason
    - authorizationCode
    - fileDescription
    - rejectionRetryCount
  PaymentSummary:
    type: object
    description: Summary of total amounts and payment status.
    properties:
      paymentCount:
        description: This field refers to the number of payments by status that exist
          within the file
        type: integer
        format: int32
        example: 100
      totalPaymentAmount:
        description: total payment amount
        type: number
        format: double
        example: 1500.100000
      paymentStatusReason:
        description: different of the status reason that payment may have
        type: string
        enum:
        - REGISTERED
        - REJECTED_LOAD
        - CANCELLED_WITHOUT_APPLIED
        - PENDING_RESPONSE
        - APPLIED
        - REJECTED
        - CANCELLED_APPLIED
        - ADJUSTMENT
      operationType:
        description: describe operation type of the payment (DEBIT,CREDIT)
        type: string
        enum:
        - DEBIT
        - CREDIT
    required:
    - paymentCount
    - totalPaymentAmount
    - paymentStatusReason
    - operationType
  RetrieveRejectedPaymentsResponse:
    type: object
    properties:
      rejectedPaymentCount:
        description: Total number of rejected movements sent
        type: integer
        format: int32
        example: 99
      rejectedPayment:
        type: array
        items:
          $ref: '#/definitions/RejectedPayment'
  RejectedPayment:
    type: object
    properties:
      paymentId:
        description: It is a consecutive number for each payment of the file
        type: integer
        format: int32
        example: 10
      paymentStatusCode:
        description: Status code of the payment
        type: string
        maxLength: 2
        example: "05"
      paymentStatusReason:
        description: Payment status
        type: string
        maxLength: 20
        example: REJECTED
      paymentRejectionReasonCode:
        description: Is code of why payment was rejected.
        type: string
        maxLength: 4
        example: "422"
      paymentRejectionReason:
        description: Is a description of why payment was rejected
        type: string
        maxLength: 31
        example: Debit Account blocked
    required:
    - paymentId
    - paymentStatusCode
    - paymentStatusReason
    - paymentRejectionReasonCode
    - paymentRejectionReason
  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://sandbox.externalapib2b.wlb.nam.nsroot.net:7101/mx-gcgapi-uat/sandbox2/api/v1/oauth/token
  ClientID:
    type: apiKey
    description: ""
    in: header
    name: X-IBM-Client-Id
security:
- OAuth2 Application Flow:
  - /api/v1
  ClientID: []
x-ibm-endpoints:
- endpointUrl: https://sandbox.externalapib2b.wlb.nam.nsroot.net:7101/mx-gcgapi-uat/sandbox2
  type:
  - production
  - development
...