---
swagger: "2.0"
info:
  title: csmt-cbi-o-payee-risk-analysis
  description: This microservice will orchestrate the requests from Mobile and Avatar
    in order to complete data necessary to call TMX throught Transmit to get a risk
    score.
  version: 1.0.0
  x-ibm-name: csmt-cbi-o-payee-risk-analysis
host: 127.0.0.1
basePath: /api
schemes:
- https
produces:
- application/json
paths:
  /v1/customers/interbank-payees/risk-scores/retrieve:
    post:
      tags:
      - retrieve-interbank-payee-risk-score
      operationId: retrieve-interbank-payee-risk-score
      summary: 'LOB: Mobile; Feature: Threat Metrix score; Functionality: Retrieve
        Risk Score for inter-bank payees operation'
      description: This API helps to complete data about adding a new interbank payee
        in order to retrieve the risk score from TMX through Transmit
      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: interbankPayeeRiskScoreRequest
        in: body
        required: true
        schema:
          $ref: '#/definitions/InterbankPayeeRiskScoreRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/InterbankPayeeRiskScoreResponse'
        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-payees/risk-scores/retrieve:
    post:
      tags:
      - retrieve-intrabank-payee-risk-score
      operationId: retrieve-intrabank-payee-risk-score
      summary: 'LOB: Mobile; Feature: Threat Metrix score; Functionality: Retrieve
        Risk Score for intra-bank payees operation'
      description: This API helps to complete data about adding a new intrabank payee
        in order to retrieve the risk score from TMX through Transmit
      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: IntrabankPayeeRiskScoreRequest
        in: body
        required: true
        schema:
          $ref: '#/definitions/IntrabankPayeeRiskScoreRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/IntrabankPayeeRiskScoreResponse'
        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:
  InterbankPayeeRiskScoreRequest:
    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
        example: "12345678"
      webSessionId:
        description: The inputted Web Session ID that represents a session for a user
          in a customers
        type: string
        example: 2da237808d724441a94797dad7c30d00
      eventType:
        description: Type of the performed event
        type: string
        example: ADD_PAYEE
      localTransactionDate:
        description: Local date and time when the transaction takes place at the acceptor
          location.
        type: string
        format: date-time
        example: "2017-07-21T17:32:28Z"
      userAuthentication:
        $ref: '#/definitions/UserAuthenticationInfo'
      payeeAcount:
        $ref: '#/definitions/PayeeAccount'
    required:
    - tmxSessionId
    - eventType
    - userAuthentication
    - payeeAcount
    - localTransactionDate
  InterbankPayeeRiskScoreResponse:
    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 name configured in Transmit
        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
  IntrabankPayeeRiskScoreRequest:
    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
        example: "12345678"
      eventType:
        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 date and 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'
      device:
        $ref: '#/definitions/Device'
    required:
    - tmxSessionId
    - eventType
    - localTransactionDate
  IntrabankPayeeRiskScoreResponse:
    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:
      customerId:
        description: This is a unique customer identifier
        type: string
        example: "1234567"
      payeeAccountInfo:
        $ref: '#/definitions/PayeeAccountInfo'
    required:
    - payeeAccountInfo
  PayeeAccountInfo:
    type: object
    properties:
      accountType:
        description: Type of the account
        type: string
        example: "10"
      accountNumber:
        description: Beneficiary account Number
        type: string
        example: "123456789"
      accountAlias:
        description: Beneficiary CLABE
        type: string
        example: "456789945613"
      cardNumber:
        description: Beneficiary card number
        type: string
        example: "1234567890123456"
      phoneNumber:
        description: Beneficiary phone number associated to the destination account
        type: string
        example: "123456789"
      branchId:
        description: Branch identifier of the destination account
        type: string
        example: "1234"
        maxLength: 4
      currencyCode:
        description: A currency code is a code that uniquely identifies a currency.
          ISO 4217 is the International Standard for currency codes
        type: string
        maxLength: 4
        example: USD
      payeeInfo:
        $ref: '#/definitions/PayeeInfo'
    required:
    - currencyCode
    - payeeInfo
    - accountType
  PayeeInfo:
    type: object
    properties:
      payeeNickName:
        description: Beneficiary Alias
        type: string
        example: TELMEX
      transactionLimitAmount:
        description: Limit of the transaction amount set for the payee
        type: number
        format: double
        example: 20000.550000
      emailAddress:
        description: Payee email address
        type: string
        example: john.wick@citi.com
    required:
    - payeeNickName
    - transactionLimitAmount
  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
        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"
  UserAuthenticationInfo:
    type: object
    properties:
      userId:
        description: This is a unique customer identifier e.g. user name, account
          id, or login name.
        type: string
        example: "111577480"
      device:
        $ref: '#/definitions/Device'
    required:
    - userId
  PayeeAccount:
    type: object
    properties:
      payeeRecipientType:
        description: Type of the recipient account
        type: string
        example: SAME_BANK
      accountType:
        description: Type of the account
        type: string
        example: DEBIT
      accountNumber:
        description: Beneficiary account Number
        type: string
        example: "123456789"
      accountAlias:
        description: Beneficiary CLABE
        type: string
        example: "456789945613"
      payee:
        $ref: '#/definitions/Payee'
    required:
    - accountType
    - payeeRecipientType
    - payee
  Payee:
    type: object
    properties:
      payeeType:
        description: Type of the payee
        type: string
        example: "1551"
      payeeFullName:
        description: Full name of the payee
        type: string
        example: JUAN PEREZ
      payeeNickName:
        description: Beneficiary Alias
        type: string
        example: TELMEX
      transactionLimitAmount:
        description: Limit of the transaction amount set for the payee
        type: number
        format: double
        example: 20000.550000
      emailAddress:
        description: Payee email address
        type: string
        example: john.wick@citi.com
      taxId:
        description: Payee RFC
        type: string
        example: JOSN871010HL6
      curp:
        description: Payee CURP
        type: string
        example: JOSN871010MMCXPX09
    required:
    - payeeType
    - payeeFullName
    - payeeNickName
    - transactionLimitAmount
  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
...