openapi: 3.0.1
info:
  title: platform_sms API
  description: Merged OpenAPI spec for platform_sms domain
  version: 1.0.0
servers:
- url: https://api.btx.fr.banqup.com/platform/sms
paths: {}
components:
  schemas:
    SmsNotification:
      required:
      - message
      - reference
      - sender
      type: object
      properties:
        reference:
          minLength: 1
          type: string
          description: A unique reference for this notification request.
          example: tx_12345_abc
        sender:
          minLength: 1
          type: string
          description: The sender ID (e.g., a short code or brand name).
          example: Banqup
        phoneNumber:
          pattern: \+\d{1,3}\d{4,14}
          type: string
          description: The recipient's mobile phone number, preferably in E.164 format.
          example: '+447123456789'
        message:
          minLength: 1
          type: string
          description: The text content of the SMS message.
          example: Your verification code is 54321.
      description: Request body to send an SMS notification.
      example:
        reference: tx_12345_abc
        sender: Banqup
        phoneNumber: '+447123456789'
        message: Your verification code is 54321.
    SmsNotificationResponse:
      required:
      - notificationId
      type: object
      properties:
        notificationId:
          minLength: 1
          type: string
          description: The unique identifier assigned to the notification.
          format: uuid
          example: a1b2c3d4-e5f6-7890-1234-567890abcdef
      description: Response containing the unique identifier of the SMS notification.
      example:
        notificationId: a1b2c3d4-e5f6-7890-1234-567890abcdef
    ApiErrorProblemDetail:
      required:
      - error
      - requestId
      - timestamp
      type: object
      properties:
        status:
          type: integer
          format: int32
        error:
          type: string
        requestId:
          type: string
        timestamp:
          type: string
          format: date-time
        type:
          type: string
          format: uri
        title:
          type: string
        detail:
          type: string
        instance:
          type: string
          format: uri
        problems:
          type: array
          items:
            $ref: '#/components/schemas/NestedProblem'
        properties:
          type: object
          additionalProperties:
            type: object
    NestedProblem:
      required:
      - detail
      - error
      - title
      type: object
      properties:
        error:
          type: string
        title:
          type: string
        detail:
          type: string
        type:
          type: string
          format: uri
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://api.btx.fr.banqup.com/oauth2/client_credential/gettoken
          scopes:
            info: Scopes are endpoint-specific, see each endpoint for required scope.
        authorizationCode:
          authorizationUrl: https://api.btx.fr.banqup.com/oauth2/auth
          tokenUrl: https://api.btx.fr.banqup.com/oauth2/token
          scopes:
            info: Scopes are endpoint-specific, see each endpoint for required scope.
tags: []
