---
swagger: "2.0"
info:
  title: CSMT-CEH-D-CustomerServices
  description: This microservice is used to get customer service information
  version: 1.0.0
  x-ibm-name: csmt-ceh-d-customerservices
host: 127.0.0.1
schemes:
- https
basePath: /api
produces:
- application/json
paths:
  /v1/private/customers/profiles/services:
    post:
      tags:
      - customer-by-service
      operationId: customer-by-service
      summary: This API is used to get customer information by customer number, service
        number and serviceType
      description: API information retrieved from S016
      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: customerByServiceRequest
        in: body
        schema:
          $ref: '#/definitions/CustomerByServiceRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/CustomerByServiceResponse'
        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/private/customers/profiles/service:
    post:
      tags:
      - create-customer-service
      operationId: create-customer-service
      summary: To create service information for the customer
      description: This API is used to create service information for the 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: 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: createCustomerServiceRequest
        in: body
        schema:
          $ref: '#/definitions/CreateCustomerServiceRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/CreateCustomerServiceResponse'
        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'
    put:
      tags:
      - update-customer-service
      operationId: update-customer-service
      summary: To update service information for the customer
      description: This API is used to update service information for the 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: 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: updateCustomerServiceRequest
        in: body
        schema:
          $ref: '#/definitions/UpdateCustomerServiceRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/UpdateCustomerServiceResponse'
        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:
  CustomerByServiceResponse:
    type: object
    properties:
      customerServiceDetail:
        $ref: '#/definitions/CustomerServiceDetail'
  CustomerServiceDetail:
    type: object
    properties:
      customerName:
        description: Name of the customer
        type: string
        example: Chris Brown
      agentId:
        description: Identifier of the agent
        type: string
        example: "123456789012"
      activationDate:
        description: Operation start Date
        type: string
        format: date
        example: "2018-01-01"
      addressType:
        description: Address type
        type: string
        example: Office
      applicationVersion:
        description: Software Version
        type: string
        example: "1234"
      canceledDate:
        description: Service Cancel Date
        type: string
        format: date
        example: "2018-01-01"
      consolidatedStatementIndicator:
        description: Edition Account Statement
        type: integer
        example: 12
      createdDate:
        description: Creation Date
        type: string
        format: date
        example: "2018-01-01"
      stationName:
        description: Computer name calling or executing API
        type: string
        example: "1234"
      pinUpdateDate:
        description: Password update date
        type: string
        format: date
        example: "2019-03-26"
      pinAssignmentCode:
        description: Password assignment to the customer
        type: integer
        example: 12
      customerServiceStatus:
        description: Status of the customer in the service
        type: string
        example: "40"
      lastUpdatedDate:
        description: Date of last modification
        type: string
        format: date
        example: "2018-01-01"
      preferContactMedium:
        description: Delivery device
        type: string
        example: "2000"
      preferredBranchId:
        description: Service Promoter Branch
        type: string
        example: "1234"
      renewalDate:
        description: Service Renewal Date
        type: string
        format: date
        example: "2018-01-01"
      securityTokenIndicator:
        description: equipment Proprietary
        type: string
        example: "12"
      statementDeliveryMode:
        description: Account Statement Device
        type: string
        example: "2"
      fee:
        type: array
        items:
          $ref: '#/definitions/Fee'
      account:
        $ref: '#/definitions/Account'
  Fee:
    type: object
    properties:
      feeAmount:
        description: feesCharge
        type: number
        format: double
        example: 100
  CustomerByServiceRequest:
    type: object
    properties:
      customerCategoryType:
        description: Customer´s Electronic Banking service, based on the catalog D9
          of S080 15-51, 15-21, 15-06, 15-99
        type: string
        example: "21"
      customerId:
        description: Unique Identifier of the customer
        type: string
        example: "123456789012"
      customerServiceNumber:
        description: Service Number
        type: string
        example: "15"
    required:
    - customerId
  Account:
    type: object
    properties:
      billingCycleDay:
        description: billingCycleDay
        type: integer
        example: 28
        maxLength: 2
      productCode:
        description: productCode
        type: string
        example: "0066"
        maxLength: 4
      productInstrument:
        description: productInstrument
        type: string
        example: "0006"
        maxLength: 4
      accountNumber:
        description: accountNumber
        type: string
        example: 009000498622
        maxLength: 12
  CreateCustomerServiceRequest:
    type: object
    properties:
      customerServiceInformation:
        $ref: '#/definitions/CustomerServiceInformation'
  CustomerServiceInformation:
    type: object
    properties:
      customerId:
        description: Unique Identifier of the customer
        type: string
        example: "123456789012"
        maxLength: 12
      agentId:
        description: Identifier of the agent
        type: string
        example: "123456789012"
        maxLength: 10
      addressType:
        description: Address type
        type: string
        example: Office
        maxLength: 4
      applicationVersion:
        description: Software Version
        type: string
        example: "1234"
        maxLength: 4
      consolidatedStatementIndicator:
        description: Edition Account Statement
        type: integer
        example: 12
        maxLength: 2
      customerServiceStatus:
        description: Status of the customer in the service
        type: string
        example: "40"
        maxLength: 2
      preferContactMedium:
        description: Delivery device
        type: string
        example: "2000"
        maxLength: 4
      preferredBranchId:
        description: Service Promoter Branch
        type: string
        example: "1234"
        maxLength: 4
      securityTokenIndicator:
        description: equipment Proprietary
        type: string
        example: "12"
        maxLength: 2
      statementDeliveryMode:
        description: Account Statement Device
        type: string
        example: "2"
        maxLength: 2
      customerCategoryType:
        description: Customer´s Electronic Banking service, based on the catalog D9
          of S080 15-51, 15-21, 15-06, 15-99
        type: string
        example: "21"
        maxLength: 2
      customerServiceNumber:
        description: Service Number
        example: "15"
        type: string
        maxLength: 4
      feeInformation:
        type: array
        items:
          $ref: '#/definitions/FeeInformation'
      accountInformation:
        $ref: '#/definitions/AccountInformation'
    required:
    - customerId
  FeeInformation:
    type: object
    properties:
      feeAmount:
        description: feesCharge
        type: number
        format: double
        example: 10
        maxLength: 2
  AccountInformation:
    type: object
    properties:
      billingCycleDay:
        description: billingCycleDay
        type: integer
        example: 28
        maxLength: 2
      productCode:
        description: productCode
        type: string
        example: "0066"
        maxLength: 4
      productInstrument:
        description: productInstrument
        type: string
        example: "0006"
        maxLength: 4
      accountNumber:
        description: accountNumber
        type: string
        example: 009000498622
        maxLength: 12
  CreateCustomerServiceResponse:
    type: object
    properties:
      activationDate:
        description: Operation start Date
        type: string
        format: date
        example: "2018-01-01"
        maxLength: 10
      renewalDate:
        description: Service Renewal Date
        type: string
        format: date
        example: "2018-01-01"
        maxLength: 10
      lastUpdatedDate:
        description: Date of last modification
        type: string
        format: date
        example: "2018-01-01"
        maxLength: 10
      createdDate:
        description: Creation Date
        type: string
        format: date
        example: "2018-01-01"
        maxLength: 10
      canceledDate:
        description: Service Cancel Date
        type: string
        format: date
        example: "2018-01-01"
        maxLength: 10
  UpdateCustomerServiceRequest:
    type: object
    properties:
      customerServiceData:
        $ref: '#/definitions/CustomerServiceData'
  CustomerServiceData:
    type: object
    properties:
      customerId:
        description: Unique Identifier of the customer
        type: string
        example: "123456789012"
        maxLength: 12
      customerCategoryType:
        description: Customer´s Electronic Banking service, based on the catalog D9
          of S080 15-51, 15-21, 15-06, 15-99
        type: string
        example: "21"
        maxLength: 2
      customerServiceNumber:
        description: Service Number
        type: string
        example: "15"
        maxLength: 4
      customerServiceStatus:
        description: Status of the customer in the service
        type: string
        example: "40"
        maxLength: 2
      accountDetail:
        $ref: '#/definitions/AccountDetail'
    required:
    - customerId
  AccountDetail:
    type: object
    properties:
      billingCycleDay:
        description: billingCycleDay
        type: integer
        example: 28
        maxLength: 2
      productCode:
        description: productCode
        type: string
        example: "0066"
        maxLength: 4
      productInstrument:
        description: productInstrument
        type: string
        example: "0006"
        maxLength: 4
      accountNumber:
        description: accountNumber
        type: string
        example: 009000498622
        maxLength: 12
  UpdateCustomerServiceResponse:
    type: object
    properties:
      activationDate:
        description: Operation start Date
        type: string
        format: date
        example: "2018-01-01"
        maxLength: 10
      renewalDate:
        description: Service Renewal Date
        type: string
        format: date
        example: "2018-01-01"
        maxLength: 10
      lastUpdatedDate:
        description: Date of last modification
        type: string
        format: date
        example: "2018-01-01"
        maxLength: 10
      createdDate:
        description: Creation Date
        type: string
        format: date
        example: "2018-01-01"
        maxLength: 10
      canceledDate:
        description: Service Cancel Date
        type: string
        format: date
        example: "2018-01-01"
        maxLength: 10
  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
security:
- OAuth2 Application Flow:
  - /api/v1
  Client ID: []
securityDefinitions:
  OAuth2 Application Flow:
    type: oauth2
    description: ""
    flow: application
    scopes:
      /api/v1: ""
    tokenUrl: https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/oauth/token
  Client ID:
    type: apiKey
    description: ""
    in: header
    name: X-IBM-Client-Id
x-ibm-endpoints:
- endpointUrl: https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
  type:
  - production
  - development
...