---
swagger: "2.0"
info:
  title: SERV-SOR-D-TesofeAcMgt
  description: This microservice is used to manage users' TESOFE accounts.
  version: 1.0.0
  x-ibm-name: serv-sor-d-tesofeacmgt
host: 127.0.0.1
schemes:
- https
basePath: /api
produces:
- application/json
paths:
  /v1/servicing/accounts/tesofe/retrieve:
    post:
      tags:
      - retrieve-tesofe-account-detail
      operationId: retrieve-tesofe-account-detail
      summary: To retrieve the tesofe account details of a customer. It will obtain
        a control account or sub-account from the backend system.
      description: This API is used to retrieve the tesofe account details of a customer.
        It will obtain a control account or sub-account from the backend system.
      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: 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: sid
        in: header
        required: true
        type: string
        description: SessionId sent by Consumer
      - name: tesofeAccountRequest
        in: body
        schema:
          $ref: '#/definitions/TesofeAccountRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/TesofeAccountResponse'
        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/accounts/tesofe/structure/retrieve:
    post:
      tags:
      - retrieve-tesofe-account-structure
      operationId: retrieve-tesofe-account-structure
      summary: To retrieve the tesofe accounts structure. Account structure refers
        to all the child-accounts that belong to the parent-account
      description: This API is used to retrieve the tesofe accounts structure. Account
        structure refers to all the child-accounts that belong to the parent-account
      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: 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: sid
        in: header
        required: true
        type: string
        description: SessionId sent by Consumer
      - name: tesofeAccountStructureRequest
        in: body
        schema:
          $ref: '#/definitions/TesofeAccountStructureRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/TesofeCheckingAccountStructureResponse'
        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:
  TesofeAccountRequest:
    type: object
    properties:
      customerId:
        description: Unique Identifier of the customer.
        type: string
        example: "123456789012"
      dataCenterLocation:
        description: Data center location
        type: string
        example: "10"
    required:
    - customerId
    - dataCenterLocation
  TesofeAccountResponse:
    type: object
    properties:
      customerName:
        description: Name of the customer.
        type: string
        example: Roberto Vilchis
      account:
        $ref: '#/definitions/Account'
    required:
    - customerName
  Account:
    type: object
    properties:
      accountNumber:
        description: Account number
        type: string
        example: "82749287364928300000"
      branchId:
        description: Branch to which the account belongs
        type: string
        example: "5894"
      accountUsageType:
        description: 'This field refers to the account property that indicates about
          the tesofe customer. The values it can take are 60: Count normal control,
          61: Concentrator Control Account, 62: Normal Subaccount, 63: Concentrator
          Subaccount'
        type: string
        example: "60"
      lastUpdatedDate:
        description: Data when the last update was made to the account.
        type: string
        format: date
        example: "2020-09-22"
      product:
        $ref: '#/definitions/Product'
      accountMediaAccess:
        $ref: '#/definitions/AccountMediaAccessData'
    required:
    - accountNumber
    - branchId
    - accountUsageType
    - lastUpdatedDate
    - product
  Product:
    type: object
    properties:
      productCode:
        description: Unique identifier of the product
        type: string
        example: "1234"
      productInstrument:
        description: Product instrument code of the account
        type: string
        example: "12"
    required:
    - productCode
    - productInstrument
  AccountMediaAccessData:
    type: object
    properties:
      deviceAccessPrefix:
        description: The device access prefix which is first four digits of account
        type: string
        example: "7008"
        maxLength: 4
        pattern: ^[0-9]*$
      deviceAccessId:
        description: Unique device access media ID
        type: string
        example: 000000278445
        maxLength: 12
        pattern: ^[0-9]*$
    required:
    - deviceAccessPrefix
    - deviceAccessId
  TesofeAccountStructureRequest:
    type: object
    properties:
      queryType:
        description: 'Indicates the type of query that will be made to the legacy
          system. Example Values: I- Initial consultation, S- Subsequent consultation,
          N- Final consultation, T- Entire account structure, D- Specific Sub-account
          Query, X- Specific Query of Account Control'
        type: string
        enum:
        - I
        - S
        - "N"
        - T
        - D
        - X
        example: I
      checkingAccountId:
        description: Unique identifier of the customer�s checking account
        type: string
        example: "7008000000278445"
        minLength: 16
        maxLength: 16
        pattern: ^[0-9]*$
      lastRelatedCheckingAccountId:
        description: The reference for the last related checking account that is used
          to get the next account set, when there are more information to retrieve
        type: string
        example: "7008000000278445"
        minLength: 16
        maxLength: 16
        pattern: ^[0-9]*$
    required:
    - checkingAccountId
  TesofeCheckingAccountStructureResponse:
    type: object
    properties:
      moreInformationFlag:
        description: More Information Flag
        type: boolean
        example: true
      checkingAccount:
        $ref: '#/definitions/CheckingAccount'
    required:
    - moreInformationFlag
  CheckingAccount:
    type: object
    properties:
      accountId:
        description: Unique identifier of the customer�s checking account
        type: string
        example: "7008000000278445"
        minLength: 16
        maxLength: 16
        pattern: ^[0-9]*$
      customerId:
        description: Unique Identifier of the customer owner of the checking account
        type: string
        example: "123456789012"
      relatedCheckingAccounts:
        type: array
        items:
          $ref: '#/definitions/CheckingAccountDetail'
    required:
    - accountId
    - customerId
  CheckingAccountDetail:
    type: object
    properties:
      accountId:
        description: Unique identifier of the customer�s checking account
        type: string
        example: "7008000000278445"
        minLength: 16
        maxLength: 16
        pattern: ^[0-9]*$
      accountHierarchyLevel:
        description: Level of the checking account in the tesofe account�s hierarchy
        type: string
        example: "1"
        maxLength: 2
      accountStatusCode:
        description: Status of the checking account
        type: string
        example: "21"
        maxLength: 2
      currencyCode:
        description: Currency Code
        type: string
        example: "01"
        maxLength: 2
      accountUsageType:
        description: 'This field refers to the account property that indicates about
          the tesofe customer. The values it can take are 60: Count normal control,
          61: Concentrator Control Account, 62: Normal Subaccount, 63: Concentrator
          Subaccount'
        type: string
        example: "60"
        maxLength: 2
      customerId:
        description: Unique Identifier of the customer.
        type: string
        example: "123456789012"
      customerName:
        description: Name of the customer who is the owner of the sub account
        type: string
        example: MALVEX S.A de C.V
    required:
    - accountId
    - accountHierarchyLevel
    - accountStatusCode
    - currencyCode
    - accountUsageType
    - customerId
    - customerName
  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
  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://sandbox.externalapib2b.wlb.nam.nsroot.net:7101/mx-gcgapi-uat/sandbox2
  type:
  - production
  - development
...