---
swagger: "2.0"
info:
  title: CSMT-CAE-D-CustomerTokenService
  description: NC This microservice is used to get customer service information.
  version: 1.0.2
  x-ibm-name: csmt-cae-d-customertokenservice
host: 127.0.0.1
schemes:
- https
basePath: /api
produces:
- application/json
paths:
  /v1/customers/services/token/status:
    post:
      tags:
      - customer-token-status
      operationId: customer-token-status
      summary: LOB:Customers; Feature:Security; Functionality:Token
      description: This API is used to retrieve the status for the customer token,
        where customer can be both physical or moral
      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: false
        type: string
        description: SessionId sent by Consumer
      - name: serviceStatusRequest
        in: body
        schema:
          $ref: '#/definitions/CustomerTokenStatusRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/CustomerTokenStatusResponse'
        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/customers/services/token/status/manage:
    put:
      tags:
      - update-customer-token-status
      operationId: update-customer-token-status
      summary: LOB:Customers; Feature:Security; Functionality:Token
      description: This API is used to update the status for the customer token, where
        customer can be both physical or moral
      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: false
        type: string
        description: SessionId sent by Consumer
      - name: updateCustomerTokenStatusRequest
        in: body
        schema:
          $ref: '#/definitions/UpdateCustomerTokenStatusRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/UpdateCustomerTokenStatusResponse'
        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'
    post:
      tags:
      - create-customer-token-status
      operationId: create-customer-token-status
      summary: LOB:Customers; Feature:Security; Functionality:Token
      description: This API is used to create the status for the customer token, where
        customer can be both physical or moral
      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: false
        type: string
        description: SessionId sent by Consumer
      - name: createCustomerTokenStatusRequest
        in: body
        schema:
          $ref: '#/definitions/CreateCustomerTokenStatusRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/CreateCustomerTokenStatusResponse'
        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:
  CustomerTokenStatusRequest:
    type: object
    properties:
      customerId:
        description: Customer identifier
        type: string
        example: 000004945914
        maxLength: 12
      stationName:
        description: Station name that calls the service
        type: string
        example: "1234"
      customerServiceNumber:
        description: Service number contracted by the customer, such as 15 than identifies
          electronic banking service
        type: integer
        format: int32
        example: 15
        maxLength: 4
      customerCategoryType:
        description: Identifier of customer category type, 99 for physical customers,
          00 for companies/enterprises
        type: integer
        format: int32
        example: 99
        maxLength: 2
      pageId:
        description: page identifier
        type: integer
        format: int32
        example: 2
        maxLength: 3
      representativeIndex:
        description: Representative index in case of companies/enterprises
        type: integer
        format: int32
        example: 1
        maxLength: 4
    required:
    - customerId
  CustomerTokenStatusResponse:
    type: object
    properties:
      moreInformationFlag:
        description: Flag that indicates if exists more information
        type: boolean
        example: false
        maxLength: 1
      pageId:
        description: page id
        type: integer
        example: 2
        maxLength: 3
      service:
        type: array
        items:
          $ref: '#/definitions/CustomerService'
    required:
    - moreInformationFlag
    - pageId
  CustomerService:
    type: object
    properties:
      customerServiceNumber:
        description: Service number contracted by the customer, such as 15 than identifies
          electronic banking service
        type: integer
        format: int32
        example: 5544
        maxLength: 4
      customerCategoryType:
        description: Identifier of customer category type, 99 for physical customers,
          00 for companies/enterprises
        type: integer
        format: int32
        example: 20
        maxLength: 2
      serviceStatus:
        description: Status of the service
        type: integer
        format: int32
        example: 1
        maxLength: 2
      representativeIndex:
        description: Representative index in case of companies/enterprises
        type: integer
        format: int32
        example: 1
        maxLength: 2
    required:
    - customerServiceNumber
    - customerCategoryType
    - serviceStatus
    - representativeIndex
  UpdateCustomerTokenStatusRequest:
    type: object
    properties:
      customerService:
        type: array
        items:
          $ref: '#/definitions/CustomerServiceDetail'
  CustomerServiceDetail:
    type: object
    properties:
      customerId:
        description: Unique identifier of the Customer
        type: string
        example: "123456789012"
        maxLength: 12
      stationName:
        description: Station name that calls the service
        type: string
        example: "1234"
      customerServiceNumber:
        description: Service number contracted by the customer, such as 15 than identifies
          electronic banking service
        type: integer
        format: int32
        example: 15
        maxLength: 4
      customerCategoryType:
        description: Identifier of customer category type, 99 for physical customers,
          00 for companies/enterprises
        type: integer
        format: int32
        example: 99
        maxLength: 2
      legalRepresentative:
        type: array
        items:
          $ref: '#/definitions/LegalRepresentative'
    required:
    - customerId
  LegalRepresentative:
    type: object
    properties:
      legalRepresentativeId:
        description: Unique identifier for corporate legal Representative
        type: string
        example: "123456789"
      legalRepresentativeStatus:
        description: Legal Representative Status
        type: string
        example: "02"
    required:
    - legalRepresentativeId
  UpdateCustomerTokenStatusResponse:
    type: object
    properties:
      customerService:
        type: array
        items:
          $ref: '#/definitions/CustomerServiceInfo'
  CustomerServiceInfo:
    type: object
    properties:
      customerId:
        description: Unique identifier of the Customer
        type: string
        example: "123456789012"
        maxLength: 12
      customerServiceNumber:
        description: Service number contracted by the customer, such as 15 than identifies
          electronic banking service
        type: integer
        format: int32
        example: 15
        maxLength: 4
      customerCategoryType:
        description: Identifier of customer category type, 99 for physical customers,
          00 for companies/enterprises
        type: integer
        format: int32
        example: 99
        maxLength: 2
      responseStatusFlag:
        description: Response status flag
        type: boolean
        example: "True"
      responseMessage:
        description: Response status Message
        type: string
        example: Retrieve Error
      legalRepresentative:
        type: array
        items:
          $ref: '#/definitions/LegalRepresentativeInfo'
    required:
    - customerId
  LegalRepresentativeInfo:
    type: object
    properties:
      legalRepresentativeId:
        description: Unique identifier for corporate legal Representative
        type: string
        example: "123456789"
      legalRepresentativeStatus:
        description: Legal Representative Status
        type: string
        example: "02"
    required:
    - legalRepresentativeId
  CreateCustomerTokenStatusRequest:
    type: object
    properties:
      customerId:
        description: Unique identifier of the Customer
        type: string
        example: "123456789012"
        maxLength: 12
      customerServiceNumber:
        description: Service number contracted by the customer, such as 15 than identifies
          electronic banking service
        type: integer
        format: int32
        example: 15
        maxLength: 4
      customerCategoryType:
        description: Identifier of customer category type, 99 for physical customers,
          00 for companies/enterprises
        type: integer
        format: int32
        example: 99
        maxLength: 2
      legalRepresentative:
        $ref: '#/definitions/LegalRepresentativeData'
    required:
    - customerId
  LegalRepresentativeData:
    type: object
    properties:
      legalRepresentativeId:
        description: Unique identifier for corporate legal Representative
        type: string
        example: "123456789"
      legalRepresentativeStatus:
        description: Legal Representative Status
        type: string
        example: "02"
  CreateCustomerTokenStatusResponse:
    type: object
    properties:
      customerId:
        description: Unique identifier of the Customer
        type: string
        example: "123456789012"
        maxLength: 12
      customerServiceNumber:
        description: Service number contracted by the customer, such as 15 than identifies
          electronic banking service
        type: integer
        format: int32
        example: 15
        maxLength: 4
      customerCategoryType:
        description: Identifier of customer category type, 99 for physical customers,
          00 for companies/enterprises
        type: integer
        format: int32
        example: 99
        maxLength: 2
      legalRepresentative:
        $ref: '#/definitions/LegalRepresentativeInformation'
    required:
    - customerId
  LegalRepresentativeInformation:
    type: object
    properties:
      legalRepresentativeId:
        description: Unique identifier for corporate legal Representative
        type: string
        example: "123456789"
      legalRepresentativeStatus:
        description: Legal Representative Status
        type: string
        example: "02"
  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
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
security:
- OAuth2 Application Flow:
  - /api/v1
  Client ID: []
x-ibm-endpoints:
- endpointUrl: https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
  type:
  - production
  - development
...