---
swagger: "2.0"
info:
  version: 1.0.0
  title: XLG-SEC-P-SendOtpSms
  x-ibm-name: xlg-sec-p-sendotpsms
  description: ""
basePath: /api
schemes:
- https
produces:
- application/json
paths:
  /v1/x-global/sms/otp/send:
    post:
      operationId: sms-otp-send
      tags:
      - sms-otp-send
      summary: Sends OTP to SMS service
      description: This API is to send OTP to SMS client through movilé
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: uuid
        in: header
        description: Random 128 bit UUID generated uniquely for every request from
          the Customer, which will represent transaction unique identifier and it
          is recommended to send.
        required: true
        type: string
      - name: countryCode
        in: header
        description: Two character ISO country code.
        required: true
        type: string
        default: MX
      - name: businessCode
        in: header
        description: Three character business code.
        required: true
        type: string
        default: GCB
      - name: channelId
        in: header
        description: Channel ID used by the user.
        required: false
        type: string
      - name: client_id
        in: header
        description: The client ID  you received during application registration in
          the developer portal
        required: true
        type: string
      - name: Authorization
        in: header
        description: Bearer token aquired from APIM token endpoint
        required: true
        type: string
      - name: Accept-Language
        in: header
        default: es
        description: Language to be send to the backend systems
        required: false
        type: string
      - name: Content-Type
        in: header
        description: Content-Types that are sent in the request
        required: true
        type: string
        default: application/json
      - name: Accept
        in: header
        description: Content-Types that are acceptable for the response.
        required: true
        type: string
      - in: body
        name: smsRequest
        description: This request is to provide data for sending SMS.
        required: true
        schema:
          $ref: '#/definitions/smsRequest'
      responses:
        200:
          description: Send SMS Successful
        400:
          description: Bad Request <br><br><table><tr><td>Type</td><td>Code</td><td>Details</td></tr>
            <tr><td>error</td><td>invalidRequest</td><td>Missing or invalidParameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        403:
          description: Forbidden <br><br><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>The
            request operation is not configured to access this resource.</td></tr></table>
        500:
          description: Internal Server Error <br><br><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><tr><td>error</td><td>deliveryResult</td><td>Error
            message</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
definitions:
  smsRequest:
    required:
    - 'oneTimePassword '
    - phoneNumber
    properties:
      'oneTimePassword ':
        type: string
        example: "1234567890"
        description: OTP for customer to login
      phoneNumber:
        type: string
        example: "551234567890"
        description: Registered valid number for customer
  ErrorResponse:
    required:
    - code
    - details
    - location
    - moreInfo
    - timestamp
    - type
    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:
        type: string
        description: Error code which qualifies the error
      details:
        type: string
        description: Human readable explanation specific to the occurrence of the
          problem
      location:
        type: string
        description: The name of the field that resulted in the error
      moreInfo:
        type: string
        description: URI to human readable documentation of the error
      timestamp:
        type: string
        description: Timestamp of the error
x-ibm-configuration:
  enforced: true
  testable: true
  phase: realized
securityDefinitions:
  OAuth2 Application Flow:
    type: oauth2
    description: ""
    flow: application
    scopes:
      /api/v1: ""
    tokenUrl: https://api.banamex.com/mx-gcgapi/api/v1/oauth/token
  ClientID:
    type: apiKey
    description: ""
    in: header
    name: X-IBM-Client-Id
security:
- OAuth2 Application Flow:
  - /api/v1
  ClientID: []
x-ibm-endpoints:
- endpointUrl: https://api.banamex.com/mx-gcgapi
  type:
  - production
  - development
...