---
swagger: "2.0"
info:
  title: csmt-cbi-o-transaction-risk-analysis
  description: This microservice will orchestrate the requests from Mobile and Avatar
    in order to decript and complete data necessary to call TMX throught Transmit
    to get a risk score for transantions monetary.
  version: 1.1.0
  x-ibm-name: csmt-cbi-o-transaction-risk-analysis
host: 127.0.0.1
basePath: /api
schemes:
- https
produces:
- application/json
paths:
  /v1/customers/interbank-transactions/risk-scores/retrieve:
    post:
      tags:
      - retrieve-interbank-transaction-risk-score
      operationId: retrieve-interbank-transaction-risk-score
      summary: 'LOB: Mobile; Feature: Threat Metrix score; Functionality: Retrieve
        Risk Score for interbank transactions'
      description: This API helps to complete data for Interbank Payments in order
        to retrieve the risk score from TMX
      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: interbankPaymentRiskScoreRequest
        in: body
        required: true
        schema:
          $ref: '#/definitions/InterbankPaymentRiskScoreRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/InterbankPaymentRiskScoreResponse'
        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/intrabank-transactions/risk-scores/retrieve:
    post:
      tags:
      - retrieve-intrabank-transaction-risk-score
      operationId: retrieve-intrabank-transaction-risk-score
      summary: 'LOB: Mobile; Feature: Threat Metrix score; Functionality: Retrieve
        Risk Score for intrabank transactions'
      description: This API helps to complete data for intrabank transactions in order
        to retrieve the risk score from TMX
      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: intrabankPaymentRiskScoreRequest
        in: body
        required: true
        schema:
          $ref: '#/definitions/IntrabankPaymentRiskScoreRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/IntrabankPaymentRiskScoreResponse'
        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/own-transactions/risk-scores/retrieve:
    post:
      tags:
      - retrieve-own-transaction-risk-score
      operationId: retrieve-own-transaction-risk-score
      summary: 'LOB: Mobile; Feature: Threat Metrix score; Functionality: Retrieve
        Risk Score for own transactions'
      description: This API helps to complete data for Own Payments in order to retrieve
        the risk score from TMX
      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: ownPaymentRiskScoreRequest
        in: body
        required: true
        schema:
          $ref: '#/definitions/OwnPaymentRiskScoreRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/OwnPaymentRiskScoreResponse'
        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/insight-investments/risk-scores/retrieve:
    post:
      tags:
      - retrieve-insight-investment-risk-score
      operationId: retrieve-insight-investment-risk-score
      summary: 'LOB: Mobile; Feature: Threat Metrix score; Functionality: Retrieve
        Risk Score for In Sight Investments'
      description: This API helps to complete data for In Sight Investments in order
        to retrieve the risk score from TMX
      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: inSightInvestmentRiskScoreRequest
        in: body
        required: true
        schema:
          $ref: '#/definitions/InSightInvestmentRiskScoreRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/InSightInvestmentRiskScoreResponse'
        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/term-investments/risk-scores/retrieve:
    post:
      tags:
      - retrieve-term-investment-risk-score
      operationId: retrieve-term-investment-risk-score
      summary: 'LOB: Mobile; Feature: Threat Metrix score; Functionality: Retrieve
        Risk Score for Term Investments'
      description: This API helps to complete data for Term Investments in order to
        retrieve the risk score from TMX
      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: termInvestmentsRiskScoreRequest
        in: body
        required: true
        schema:
          $ref: '#/definitions/TermInvestmentsRiskScoreRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/TermInvestmentsRiskScoreResponse'
        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/fund-investments/risk-scores/retrieve:
    post:
      tags:
      - retrieve-fund-investment-risk-score
      operationId: retrieve-fund-investment-risk-score
      summary: 'LOB: Mobile; Feature: Threat Metrix score; Functionality: Retrieve
        Risk Score for fund Investments'
      description: This API helps to complete data for fund Investments in order to
        retrieve the risk score from TMX
      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: fundInvestmentRiskScoreRequest
        in: body
        required: true
        schema:
          $ref: '#/definitions/FundInvestmentRiskScoreRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/FundInvestmentRiskScoreResponse'
        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:
  InterbankPaymentRiskScoreRequest:
    type: object
    properties:
      dataCenterLocation:
        description: It is an identifier of the place where the User was created.
        type: string
        example: "10"
      tmxSessionId:
        description: This is a session identifier generated when device profiling
          was initiated
        type: string
        maxLength: 128
        example: "12345678"
      tmxEventType:
        description: Type of the event performed
        type: string
        example: PAYMENT
      legacySessionId:
        description: The inputted Web Session ID that represents a session for a user
          in a customers
        type: string
        example: 2da237808d724441a94797dad7c30d00
      payeeType:
        description: 'Beneficiary Type: It can be a specific number for each type'
        type: string
        example: "1521"
      localTransactionDate:
        description: Local time when the transaction takes place at the acceptor location.
        type: string
        format: date-time
        example: "2017-07-21T17:32:28Z"
      customer:
        $ref: '#/definitions/Customer'
    required:
    - dataCenterLocation
    - tmxSessionId
    - tmxEventType
    - localTransactionDate
    - customer
  InterbankPaymentRiskScoreResponse:
    type: object
    properties:
      transactionId:
        description: Identifier retrieved from transmit generated in TMX
        type: string
        example: "4013060000"
      highRiskCode:
        description: Risk score from TMX transaction risk assessment
        type: string
        example: "10"
      operationName:
        description: 'Name of the operation made '
        type: string
        example: Login
      decisionCode:
        description: Refers to how the operation should proceed 1-allow, 2-review,
          3-deny
        type: string
        example: "1"
    required:
    - transactionId
    - highRiskCode
    - operationName
    - decisionCode
  IntrabankPaymentRiskScoreRequest:
    type: object
    properties:
      dataCenterLocation:
        description: It is an identifier of the place where the User was created.
        type: string
        example: "10"
      tmxSessionId:
        description: This is a session identifier generated when device profiling
          was initiated
        type: string
        maxLength: 128
        example: "12345678"
      tmxEventType:
        description: Type of the event performed
        type: string
        example: PAYMENT
      legacySessionId:
        description: The inputted Web Session ID that represents a session for a user
          in a customers
        type: string
        example: 2da237808d724441a94797dad7c30d00
      localTransactionDate:
        description: Local time when the transaction takes place at the acceptor location.
        type: string
        format: date-time
        example: "2017-07-21T17:32:28Z"
      customer:
        $ref: '#/definitions/Customer'
    required:
    - tmxSessionId
    - tmxEventType
    - dataCenterLocation
    - localTransactionDate
    - customer
  IntrabankPaymentRiskScoreResponse:
    type: object
    properties:
      transactionId:
        description: Identifier retrieved from transmit generated in TMX
        type: string
        example: "4013060000"
      highRiskCode:
        description: Risk score from TMX transaction risk assessment
        type: string
        example: "10"
      operationName:
        description: 'Name of the operation made '
        type: string
        example: Login
      decisionCode:
        description: Refers to how the operation should proceed 1-allow, 2-review,
          3-deny
        type: string
        example: "1"
    required:
    - transactionId
    - highRiskCode
    - operationName
    - decisionCode
  OwnPaymentRiskScoreRequest:
    type: object
    properties:
      dataCenterLocation:
        description: It is an identifier of the place where the User was created.
        type: string
        example: "10"
      tmxSessionId:
        description: This is a session identifier generated when device profiling
          was initiated
        type: string
        maxLength: 128
        example: "12345678"
      tmxEventType:
        description: Type of the event performed
        type: string
        example: PAYMENT
      legacySessionId:
        description: The inputted Web Session ID that represents a session for a user
          in a customers
        type: string
        example: 2da237808d724441a94797dad7c30d00
      localTransactionDate:
        description: Local time when the transaction takes place at the acceptor location.
        type: string
        format: date-time
        example: "2017-07-21T17:32:28Z"
      customer:
        $ref: '#/definitions/Customer'
    required:
    - tmxSessionId
    - tmxEventType
    - dataCenterLocation
    - localTransactionDate
    - customer
  OwnPaymentRiskScoreResponse:
    type: object
    properties:
      transactionId:
        description: Identifier retrieved from transmit generated in TMX
        type: string
        example: "4013060000"
      highRiskCode:
        description: Risk score from TMX transaction risk assessment
        type: string
        example: "10"
      operationName:
        description: 'Name of the operation made '
        type: string
        example: Login
      decisionCode:
        description: Refers to how the operation should proceed 1-allow, 2-review,
          3-deny
        type: string
        example: "1"
    required:
    - transactionId
    - highRiskCode
    - operationName
    - decisionCode
  InSightInvestmentRiskScoreRequest:
    type: object
    properties:
      dataCenterLocation:
        description: It is an identifier of the place where the User was created.
        type: string
        example: "10"
      tmxSessionId:
        description: This is a session identifier generated when device profiling
          was initiated
        type: string
        maxLength: 128
        example: "12345678"
      tmxEventType:
        description: Type of the event performed
        type: string
        example: PAYMENT
      legacySessionId:
        description: The inputted Web Session ID that represents a session for a user
          in a customers
        type: string
        example: 2da237808d724441a94797dad7c30d00
      localTransactionDate:
        description: Local time when the transaction takes place at the acceptor location.
        type: string
        format: date-time
        example: "2017-07-21T17:32:28Z"
      customer:
        $ref: '#/definitions/Customer'
    required:
    - tmxSessionId
    - tmxEventType
    - dataCenterLocation
    - localTransactionDate
    - customer
  InSightInvestmentRiskScoreResponse:
    type: object
    properties:
      transactionId:
        description: Identifier retrieved from transmit generated in TMX
        type: string
        example: "4013060000"
      highRiskCode:
        description: Risk score from TMX transaction risk assessment
        type: string
        example: "10"
      operationName:
        description: 'Name of the operation made '
        type: string
        example: Login
      decisionCode:
        description: Refers to how the operation should proceed 1-allow, 2-review,
          3-deny
        type: string
        example: "1"
    required:
    - transactionId
    - highRiskCode
    - operationName
    - decisionCode
  TermInvestmentsRiskScoreRequest:
    type: object
    properties:
      dataCenterLocation:
        description: It is an identifier of the place where the User was created.
        type: string
        example: "10"
      tmxSessionId:
        description: This is a session identifier generated when device profiling
          was initiated
        type: string
        maxLength: 128
        example: "12345678"
      tmxEventType:
        description: Type of the event performed
        type: string
        example: PAYMENT
      legacySessionId:
        description: The inputted Web Session ID that represents a session for a user
          in a customers
        type: string
        example: 2da237808d724441a94797dad7c30d00
      localTransactionDate:
        description: Local time when the transaction takes place at the acceptor location.
        type: string
        format: date-time
        example: "2017-07-21T17:32:28Z"
      customer:
        $ref: '#/definitions/Customer'
    required:
    - tmxSessionId
    - tmxEventType
    - dataCenterLocation
    - localTransactionDate
    - customer
  TermInvestmentsRiskScoreResponse:
    type: object
    properties:
      transactionId:
        description: Identifier retrieved from transmit generated in TMX
        type: string
        example: "4013060000"
      highRiskCode:
        description: Risk score from TMX transaction risk assessment
        type: string
        example: "10"
      operationName:
        description: 'Name of the operation made '
        type: string
        example: Login
      decisionCode:
        description: Refers to how the operation should proceed 1-allow, 2-review,
          3-deny
        type: string
        example: "1"
    required:
    - transactionId
    - highRiskCode
    - operationName
    - decisionCode
  FundInvestmentRiskScoreRequest:
    type: object
    properties:
      dataCenterLocation:
        description: It is an identifier of the place where the User was created.
        type: string
        example: "10"
      tmxSessionId:
        description: This is a session identifier generated when device profiling
          was initiated
        type: string
        maxLength: 128
        example: "12345678"
      tmxEventType:
        description: Type of the event performed
        type: string
        example: PAYMENT
      legacySessionId:
        description: The inputted Web Session ID that represents a session for a user
          in a customers
        type: string
        example: 2da237808d724441a94797dad7c30d00
      localTransactionDate:
        description: Local time when the transaction takes place at the acceptor location.
        type: string
        format: date-time
        example: "2017-07-21T17:32:28Z"
      customer:
        $ref: '#/definitions/Customer'
    required:
    - tmxSessionId
    - tmxEventType
    - dataCenterLocation
    - localTransactionDate
    - customer
  FundInvestmentRiskScoreResponse:
    type: object
    properties:
      transactionId:
        description: Identifier retrieved from transmit generated in TMX
        type: string
        example: "4013060000"
      highRiskCode:
        description: Risk score from TMX transaction risk assessment
        type: string
        example: "10"
      operationName:
        description: 'Name of the operation made '
        type: string
        example: Login
      decisionCode:
        description: Refers to how the operation should proceed 1-allow, 2-review,
          3-deny
        type: string
        example: "1"
    required:
    - transactionId
    - highRiskCode
    - operationName
    - decisionCode
  Customer:
    type: object
    properties:
      customerType:
        description: Type of customer
        type: string
        example: Individual
      customerId:
        description: This is a unique customer identifier
        type: string
        example: "123456"
      device:
        $ref: '#/definitions/Device'
      transaction:
        $ref: '#/definitions/Transaction'
    required:
    - transaction
    - customerType
    - customerId
  SourceAccount:
    type: object
    properties:
      accountNumber:
        description: This is the source account
        type: string
        example: "12345678903"
      product:
        $ref: '#/definitions/Product'
    required:
    - accountNumber
  Transaction:
    type: object
    properties:
      localCurrencyTransactionAmount:
        description: Transaction amount set for the payment in MXN
        type: number
        format: double
        example: 20000.550000
      recurringTransactionFlag:
        description: Flag to indicate if the transaction is frequently used
        type: boolean
        example: false
      futureDateSelectedFlag:
        description: Flag to indicate if the transaction will be applied in the future
        type: boolean
        example: true
      transactionReferenceNumber:
        description: Transaction Reference Number, it is introduced by the customer.
        type: string
        pattern: ^[0-9]+$
        example: "02022021"
      transactionReferenceId:
        description: Transaction alphanumeric Reference, it is introduced by the customer.
        type: string
        example: JOB PAYMENT02022021
      foreignCurrencyTransactionAmount:
        description: Transaction amount set for the payment in USD
        type: number
        format: double
        example: 2000.500000
      foreignExchangeRate:
        description: Exchange rate for the foreign currency transaction amount
        type: number
        format: double
        example: 19.380000
      codiPaymentType:
        description: 'Codi Payment type. Type: 19,20,21 and 22. 19: Face-to-face payments
          (person to person), 20: Non-face-to-face payments on one occasion (individual
          to legal entity), 21: Recurring non-face-to-face payments (individual to
          legal entity), 22: Non-face-to-face payments on behalf of a third party
          (individuals to legal entities)'
        type: string
        example: "19"
      bankId:
        description: Bank identifier of the destination account
        type: string
        example: Citi
      transactionId:
        description: Identifier of the transaction performed
        type: string
        example: "4013060000"
      serialNumber:
        description: Identifier for the investment transaction.
        type: string
        example: "123214213"
      sourceAccount:
        $ref: '#/definitions/SourceAccount'
      destinationAccount:
        $ref: '#/definitions/DestinationAccount'
    required:
    - transactionId
    - bankId
    - localCurrencyTransactionAmount
    - destinationAccount
    - sourceAccount
  DestinationAccount:
    type: object
    properties:
      accountNumber:
        description: Beneficiary account Number
        type: string
        example: "12345678903"
      accountAlias:
        description: Beneficiary CLABE
        type: string
        example: "12345678912345678"
      cardNumber:
        description: Beneficiary card number
        type: string
        example: "1234567812345678"
      phoneNumber:
        description: Beneficiary phone number associated to the destination account
        type: string
        example: "1234512345"
  Product:
    type: object
    properties:
      productCode:
        description: Product Code
        type: string
        example: "113"
      productInstrument:
        description: Instrument
        type: string
        example: "4"
  Device:
    type: object
    properties:
      deviceApplicationType:
        description: The type of application used on the device for authentication.
          Sample application types are Mobile Thin IOS, Mobile Thick Android etc.
        type: string
        maxLength: 255
        example: MOBILE_THICK_IOS
      ipAddress:
        description: Ip address of the device
        type: string
        maxLength: 15
        example: 100.200.102.500
      geoLatitude:
        description: Device location latitude
        type: string
        maxLength: 20
        example: "23.634501"
      geoLongitude:
        description: Device location longitude
        type: string
        maxLength: 20
        example: "-102.552788"
  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 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
...