---
swagger: "2.0"
info:
  title: CSMT-CRM-D-CodiBanxicoRegistration
  description: The microservice helps to register deivces to Banxico for Codi feature
  version: 1.0.2
  x-ibm-name: csmt-crm-d-codibanxicoregistration
host: 127.0.0.1
schemes:
- https
basePath: /api
produces:
- application/json
paths:
  /v1/customers/codi-banxico/register:
    post:
      tags:
      - register-codi-device
      operationId: register-codi-device
      summary: The API helps to register a device to Banxico for Codi feature
      description: The API helps to register a device to Banxico for Codi feature
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: client_id
        in: header
        required: true
        type: string
        description: Client ID generated during application registration
      - name: Authorization
        in: header
        required: true
        type: string
        description: The Authorization Token received during login
      - name: Accept
        in: header
        required: true
        type: string
        description: Content-Types that are acceptable for the response
      - name: uuid
        in: header
        required: true
        type: string
        description: 128 bit UUID that you generate for every request
      - name: Accept-Language
        in: header
        required: false
        type: string
        description: List of acceptable human languages for response
      - name: Content-Type
        in: header
        required: true
        type: string
        description: Content-Types that are sent in the request
      - name: ChannelId
        in: header
        required: true
        type: string
        description: Channel where request originated
      - name: sid
        in: header
        required: true
        type: string
        description: SessionId sent by Consumer
      - name: registerCodiDeviceRequest
        in: body
        schema:
          $ref: '#/definitions/RegisterCodiDeviceRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/RegisterCodiDeviceResponse'
        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/codi-banxico/validate:
    post:
      tags:
      - validate-codi-device
      operationId: validate-codi-device
      summary: The API helps to validate a device with Banxico for Codi feature
      description: The API helps to validate a device with Banxico for Codi feature
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: client_id
        in: header
        required: true
        type: string
        description: Client ID generated during application registration
      - name: Authorization
        in: header
        required: true
        type: string
        description: The Authorization Token received during login
      - name: Accept
        in: header
        required: true
        type: string
        description: Content-Types that are acceptable for the response
      - name: uuid
        in: header
        required: true
        type: string
        description: 128 bit UUID that you generate for every request
      - name: Accept-Language
        in: header
        required: false
        type: string
        description: List of acceptable human languages for response
      - name: Content-Type
        in: header
        required: true
        type: string
        description: Content-Types that are sent in the request
      - name: ChannelId
        in: header
        required: true
        type: string
        description: Channel where request originated
      - name: sid
        in: header
        required: true
        type: string
        description: SessionId sent by Consumer
      - name: validateCodiCustomerRequest
        in: body
        schema:
          $ref: '#/definitions/ValidateCodiCustomerRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/ValidateCodiCustomerResponse'
        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/codi-banxico/key-source/generate:
    post:
      tags:
      - generate-key-source
      operationId: generate-key-source
      summary: The API helps to generate key source for Codi feature
      description: The API helps to generate key source for Codi feature
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: client_id
        in: header
        required: true
        type: string
        description: Client ID generated during application registration
      - name: Authorization
        in: header
        required: true
        type: string
        description: The Authorization Token received during login
      - name: Accept
        in: header
        required: true
        type: string
        description: Content-Types that are acceptable for the response
      - name: uuid
        in: header
        required: true
        type: string
        description: 128 bit UUID that you generate for every request
      - name: Accept-Language
        in: header
        required: false
        type: string
        description: List of acceptable human languages for response
      - name: Content-Type
        in: header
        required: true
        type: string
        description: Content-Types that are sent in the request
      - name: ChannelId
        in: header
        required: true
        type: string
        description: Channel where request originated
      - name: sid
        in: header
        required: true
        type: string
        description: SessionId sent by Consumer
      - name: generateKeySourceRequest
        in: body
        schema:
          $ref: '#/definitions/GenerateKeySourceRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/GenerateKeySourceResponse'
        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/codi-banxico/default/application/set:
    post:
      tags:
      - set-default-application
      operationId: set-default-application
      summary: The API helps to set the default banking application for Codi
      description: The API helps to set the default banking application for Codi
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: client_id
        in: header
        required: true
        type: string
        description: Client ID generated during application registration
      - name: Authorization
        in: header
        required: true
        type: string
        description: The Authorization Token received during login
      - name: Accept
        in: header
        required: true
        type: string
        description: Content-Types that are acceptable for the response
      - name: uuid
        in: header
        required: true
        type: string
        description: 128 bit UUID that you generate for every request
      - name: Accept-Language
        in: header
        required: false
        type: string
        description: List of acceptable human languages for response
      - name: Content-Type
        in: header
        required: true
        type: string
        description: Content-Types that are sent in the request
      - name: ChannelId
        in: header
        required: true
        type: string
        description: Channel where request originated
      - name: sid
        in: header
        required: true
        type: string
        description: SessionId sent by Consumer
      - name: setDefaultApplicationRequest
        in: body
        schema:
          $ref: '#/definitions/SetDefaultApplicationRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/SetDefaultApplicationResponse'
        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:
  RegisterCodiDeviceRequest:
    type: object
    properties:
      deviceDetails:
        $ref: '#/definitions/Device'
  Device:
    type: object
    properties:
      deviceMake:
        description: Maker of the device which the client is using to enroll with
          Citibanamex CoDi
        type: string
        example: samsung
      deviceModel:
        description: Model of the device which the client is using to enroll with
          Citibanamex CoDi
        type: string
        example: SM-G935F
      deviceOsName:
        description: Operative system of the device with the client is using to enroll
          with Citibanamex CoDi
        type: string
        example: Android
      deviceOsVersion:
        description: Version of the operative system of the device which the user
          is using to enroll with Citibanamex CoDi
        type: string
        example: 8.0.0
      deviceSerialNumber:
        description: Serial number of the device which a new user is enrolling with
          Citibanamex CoDi
        type: string
        example: 12d58955dcd9e1f4-com.citibanamex.banamexmobile
      phoneNumber:
        description: CoDi client phone number
        type: string
        example: "5512345678"
    required:
    - deviceMake
    - deviceModel
    - deviceOsName
    - deviceOsVersion
    - deviceSerialNumber
    - phoneNumber
  RegisterCodiDeviceResponse:
    type: object
    properties:
      uniqueCodiCcsId:
        description: CoDi Citibanamex id composed of customer phonenumber and banxico
          check code
        type: string
        example: "5512345678000"
      encryptedGoogleId:
        description: Encrypted Id of the project enrolled with  Google in order to
          request a new FirebaseId releated to the project
        type: string
        example: ""
    required:
    - uniqueCodiCcsId
  ValidateCodiCustomerRequest:
    type: object
    properties:
      firebaseId:
        description: Firebase id of the customer registered with Banxico in order
          to receive PUSH notifications
        type: string
        example: dUww7Jl4b9o:APA91bGHVzEMF6xdD_ZV1L4CF5ZgrBqDQGl9QO4OIemuIf04sMzbFBl_duDoWZOO4rADGviq0Rf4UCz-cYS6zvijYesfRbUR1a4BQqKUQ4z56cgmTyEjtQdQQgIz_-8KLRxmJdI9571o
      uniqueCodiCcsId:
        description: CoDi Citibanamex id composed of customer phonenumber and banxico
          check code
        type: string
        example: "5512345678000"
      customerId:
        description: Unique identifier for customer holding a Citibanamex Account
        type: string
        example: "1098765423718"
      deviceInfo:
        $ref: '#/definitions/DeviceInfo'
    required:
    - firebaseId
    - uniqueCodiCcsId
    - customerId
  DeviceInfo:
    type: object
    properties:
      deviceMake:
        description: Maker of the device which the client is using to enroll with
          Citibanamex CoDi
        type: string
        example: samsung
      deviceModel:
        description: Model of the device which the client is using to enroll with
          Citibanamex CoDi
        type: string
        example: SM-G935F
      deviceOsName:
        description: Operative system of the device with the client is using to enroll
          with Citibanamex CoDi
        type: string
        example: Android
      deviceOsVersion:
        description: Version of the operative system of the device which the user
          is using to enroll with Citibanamex CoDi
        type: string
        example: 8.0.0
      deviceSerialNumber:
        description: Serial number of the device which a new user is enrolling with
          Citibanamex CoDi
        type: string
        example: 12d58955dcd9e1f4-com.citibanamex.banamexmobile
    required:
    - deviceMake
    - deviceModel
    - deviceOsName
    - deviceOsVersion
    - deviceSerialNumber
  ValidateCodiCustomerResponse:
    type: object
    properties:
      banamexDefaultCodiBankingAppFlag:
        description: Boolean value that determines if the Ctibanamex Mobile App is
          the default one to use CoDi
        type: boolean
        example: true
    required:
    - banamexDefaultCodiBankingAppFlag
  GenerateKeySourceRequest:
    type: object
    properties:
      deviceSerialNumber:
        description: Serial number of the device which a new user is enrolling with
          Citibanamex CoDi
        type: string
        example: 12d58955dcd9e1f4-com.citibanamex.banamexmobile
      encryptedGoogleId:
        description: Encrypted Id of the project enrolled with  Google in order to
          request a new FirebaseId releated to the project
        type: string
        example: ""
      oneTimePassword:
        description: OTP numerical value  of 6 digits sent by Banxico through SMS
          to validate that a customer is enrolling with CoDi Banxico
        type: string
        example: "123456"
      uniqueCodiCcsId:
        description: CoDi Citibanamex id composed of customer phone number and banxico
          check code
        type: string
        example: "5512345678000"
      customerId:
        description: Unique identifier for customer holding a Citibanamex Account
        type: string
        example: "1098765423718"
    required:
    - deviceSerialNumber
    - encryptedGoogleId
    - oneTimePassword
    - uniqueCodiCcsId
    - customerId
  GenerateKeySourceResponse:
    type: object
    properties:
      decryptedGoogleId:
        description: Decrypted Id of the project enrolled with  Google in order to
          request a new FirebaseId releated to the project
        type: string
        example: dUww7Jl4b9o:APA91bGHVzEMF6xdD_ZV1L4CF5ZgrBqDQGl9QO4OIemuIf04sMzbFBl_duDoWZOO4rADGviq0Rf4UCz-cYS6zvijYesfRbUR1a4BQqKUQ4z56cgmTyEjtQdQQgIz_-8KLRxmJdI9571o
    required:
    - decryptedGoogleId
  SetDefaultApplicationRequest:
    type: object
    properties:
      uniqueCodiCcsId:
        description: CoDi Citibanamex id composed of customer phonenumber and banxico
          check code
        type: string
        example: "5512345678000"
      customerId:
        description: Unique identifier for customer holding a Citibanamex Account
        type: string
        example: "1098765423718"
    required:
    - uniqueCodiCcsId
    - customerId
  SetDefaultApplicationResponse:
    type: object
    properties:
      banamexDefaultCodiBankingAppFlag:
        description: Boolean value that determines if the Citibanamex Mobile App has
          been setted as the default app for CoDi with Banxico
        type: boolean
        example: true
    required:
    - banamexDefaultCodiBankingAppFlag
  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://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
...