> ## Documentation Index
> Fetch the complete documentation index at: https://docs.monei.cc/llms.txt
> Use this file to discover all available pages before exploring further.

# Subscribe Cable TV



## OpenAPI

````yaml /openapi.json post /api/v1/bills/pay/cable-tv
openapi: 3.0.0
info:
  title: Mr Monei API Gateway
  description: External API for partners using API Key authentication
  version: '1.0'
  contact: {}
servers:
  - url: https://api.dev.monei.cc
    description: Dev Server
  - url: https://api.monei.cc
    description: Live Server
security: []
tags: []
paths:
  /api/v1/bills/pay/cable-tv:
    post:
      tags:
        - Bill | Pay
      summary: Subscribe Cable TV
      operationId: BillPaymentController_subscribeCableTv
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CableTvPaymentDto'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillPaymentResponseDto'
      security:
        - bearer: []
        - api-key: []
components:
  schemas:
    CableTvPaymentDto:
      type: object
      properties:
        isSchedule:
          type: boolean
        scheduleData:
          $ref: '#/components/schemas/CreateBillScheduleDto'
        saveBeneficiary:
          type: boolean
          description: Whether to save this beneficiary
          default: false
        beneficiaryName:
          type: string
          description: Custom name for the beneficiary if saving
        smartcardNumber:
          type: string
        biller:
          type: string
        itemCode:
          type: string
      required:
        - smartcardNumber
        - biller
        - itemCode
    BillPaymentResponseDto:
      type: object
      properties:
        statusCode:
          type: number
        message:
          type: string
        data:
          description: Bill payment transaction details
          allOf:
            - $ref: '#/components/schemas/BillPaymentDto'
        errors:
          type: object
      required:
        - statusCode
        - message
        - data
        - errors
    CreateBillScheduleDto:
      type: object
      properties:
        executionDate:
          format: date-time
          type: string
        isRecurring:
          type: boolean
          default: false
        recurrencePattern:
          type: string
      required:
        - executionDate
    BillPaymentDto:
      type: object
      properties:
        id:
          type: string
          example: ee1c6018-ffce-49fa-a013-ada315e1e24d
          description: Unique identifier for the bill payment transaction
        createdAt:
          type: string
          example: '2025-10-03T20:07:17.157Z'
          description: Timestamp when the transaction was created
        userId:
          type: string
          example: 978e2b1c-edc7-4c67-bfcc-8438a0513f21
          description: User ID associated with this payment
        reference:
          type: string
          example: bill1759522037109-978e2b1c-edc7-4c67-bfcc-8438a0513f21
          description: Unique reference for the transaction
        billerCode:
          type: string
          example: BIL102
          description: Biller code for the payment
        itemCode:
          type: string
          example: AT133
          description: Item code for the biller service
        customer:
          type: string
          example: '09054860951'
          description: Customer input (e.g., phone number or account)
        amount:
          type: number
          example: 50
          description: Transaction amount
        type:
          type: string
          example: AIRTIME
          description: Type of bill payment (e.g., AIRTIME, DATA, ELECTRICITY)
        status:
          type: string
          example: SUCCESS
          description: Status of the payment
        txRef:
          type: string
          example: CF-FLYAPI-20251003080718355562583
          description: Transaction reference from provider
        billerName:
          type: string
          example: glo
          description: Name of the biller
        metadata:
          type: string
          example: null
          nullable: true
          description: Extra metadata provided with the payment
        token:
          type: string
          example: null
          nullable: true
          description: Token returned for some billers (e.g., electricity prepaid)
        units:
          type: string
          example: null
          nullable: true
          description: Units purchased (if applicable, e.g., kWh for electricity)
        validityPeriod:
          type: string
          example: null
          nullable: true
          description: Validity period for the service (if applicable)
      required:
        - id
        - createdAt
        - userId
        - reference
        - billerCode
        - itemCode
        - customer
        - amount
        - type
        - status
        - txRef
        - billerName
        - metadata
        - token
        - units
        - validityPeriod
  securitySchemes:
    api-key:
      type: apiKey
      in: header
      name: X-API-KEY

````