---
swagger: "2.0"
info:
  title: SERV-PYI-D-PaymentServiceValidation
  description: This microservice contains the functionalities of being able to retrieve
    the payment services information
  version: 1.0.0
  x-ibm-name: serv-pyi-d-paymentservicevalidation
host: 127.0.0.1
schemes:
- https
basePath: /api
produces:
- application/json
paths:
  /v1/servicing/payments/customers/services/retrieve:
    post:
      tags:
      - retrieve-payment-service-information
      operationId: retrieve-payment-service-information
      summary: 'With some payment file information, several apis of the customer domain
        are consulted for retriving services information. '
      description: 'Retrieve information of payment services witch contains informations
        of charge account, customer data and the representatives which sends the file.
        The api consulting various APIs in the client''s domain. '
      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 in 2 character ISO 3166 format
      - name: businesscode
        in: header
        required: false
        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: PaymentServiceInformation
        in: body
        schema:
          $ref: '#/definitions/PaymentServiceInformationRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/PaymentServiceInformationResponse'
        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/customers/services/validate:
    post:
      tags:
      - payment-service-validation
      operationId: payment-service-validation
      summary: This api consults a catalog of products  in payments doman checking
        that the product sent is activated for the customer
      description: A product catalog of the payment domain is consulted, in order
        to verify if the service is activated to confirm if the client can send payroll
        files, returning for this case an Http200 code Ok, and otherwise an error
        with code Http 422
      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: 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: false
        type: string
        description: SessionId sent by Consumer
      - name: PaymentServiceValidationRequest
        in: body
        schema:
          $ref: '#/definitions/PaymentServiceValidationRequest'
      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:
  PaymentServiceInformationRequest:
    type: object
    properties:
      accountNumber:
        description: Customer's Account Number with the Bank.
        type: string
        example: "12345678901"
        maxLength: 11
      customerId:
        description: CitiBanamex internal customer identifier.
        type: string
        example: "123456789012"
        minLength: 1
        maxLength: 12
        pattern: ^[0-9]{1,12}
      dataCenterLocation:
        description: this field indicates data center location, where the infomation
          is processed.
        type: string
        example: "12"
        maxLength: 2
      authorizationIndicator:
        description: Indicator to identify if the file needs a remote authorization
          of the representative 2. It will happen in different moment
        type: integer
        format: int32
        example: 1
      makerLegalRepresentativeId:
        description: this is the Id of representant/customer who sends the file.
        type: string
        example: "12"
        maxLength: 2
        default: "00"
      checkerLegalRepresentativeId:
        description: this is the Id of representant who autorize sends the file.
        type: string
        example: "12"
        maxLength: 2
        default: "00"
      totalPaymentAmount:
        description: the total payment amount.
        type: number
        format: double
        example: 1000.800000
      serviceSubType:
        description: this field refers to the nature of the file,  with which the
          file is categorized in the payment domain.
        type: string
        example: "05"
        maxLength: 2
        pattern: ^[0-9]*$
    required:
    - accountNumber
    - customerId
    - dataCenterLocation
    - authorizationIndicator
    - makerLegalRepresentativeId
    - checkerLegalRepresentativeId
    - totalPaymentAmount
    - serviceSubType
  PaymentServiceInformationResponse:
    type: object
    properties:
      acoount:
        $ref: '#/definitions/Account'
      service:
        $ref: '#/definitions/Service'
      fullName:
        description: Client name
        type: string
        example: Juan Perez
  Account:
    type: object
    properties:
      productCode:
        description: Unique code that identifies the product
        type: string
        example: "1234"
      productInstrument:
        description: This is the instrument number
        type: string
        example: "1234"
  Service:
    type: object
    properties:
      contractNumber:
        description: contract number for client
        type: string
        example: "123456789012"
      branchId:
        description: Is the branch office for the account
        type: string
        example: "12"
  PaymentServiceValidationRequest:
    type: object
    properties:
      customerId:
        description: CitiBanamex internal customer identifier
        type: string
        example: "668450123"
        maxLength: 12
        pattern: ^[0-9]*$
      serviceSubType:
        description: this field refers to the nature of the file,  with which the
          file is categorized in the payment domain.
        type: string
        example: "05"
        maxLength: 2
        pattern: ^[0-9]*$
    required:
    - customerId
    - serviceSubType
  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
...