Squad API Documentation
  • Home
  • Payments
    • Initiate Payment
    • Direct API Integration
    • Squad Payment Modal
    • Verify Transaction
    • Aggregator and Sub-merchants
  • Verify Transaction
  • Webhook & Redirect URL
    • Signature validation
  • Virtual Accounts
  • Test Cards
  • Payment Link
  • Refund API
  • Squad Woo Commerce Plugin
  • Disputes & Chargebacks
  • Wallet Balance
  • Transfer API
  • Squad POS
    • Getting Started
    • API Documentation
  • VALUE ADDED SERVICES
    • AIRTIME AND DATA
    • SMS
      • BUCKET
      • TEMPLATES
      • MESSAGES
    • Utilities
      • Cable Subscription
      • Electricity Subscription
Powered by GitBook
On this page
  • BOUQUET LIST
  • Request Body
  • Sample Request
  • Sample Response
  • ACCOUNT LOOKUP
  • REQUEST BODY
  • Sample Request
  • Sample Response
  • CABLE SUBSCRIPTION (VEND)
  • Request Body
  • Sample Request
  • Sample Response

Was this helpful?

  1. VALUE ADDED SERVICES
  2. Utilities

Cable Subscription

These Suit of APIs allow you vend cable subscriptions

BOUQUET LIST

This API allows you to retrieve the bouquet list of a cable provider

POST https:{{base_url}}/v1/service/cable/bouquet-list

Request Body

Name
Type
Description

provider*

String

Name of Cable Provider (e.g, GoTV, DSTV)

Sample Request

{ 
    "provider": "GOTV"
} 

Sample Response

{
    "status": 200,
    "success": true,
    "message": "Success",
    "data": {
        "bouquets": [
            {
                "name": "Smallie",
                "platform": "GOTV",
                "code": "GOLITE",
                "kobo_amount": 157500,
                "currency": "NGN",
                "provider": "GOTV"
            },
            {
                "name": "Jinja Bouquet",
                "platform": "GOTV",
                "code": "GOtvNJ1",
                "kobo_amount": 330000,
                "currency": "NGN",
                "provider": "GOTV"
            }
        ]
    }
}

ACCOUNT LOOKUP

This API allows you to look up the smartcard number of a provider before vending.

POST https:{{base_url}}/v1/service/cable/lookup

REQUEST BODY

Name
Type
Description

provider*

String

Name of Cable Provider (e.g, GoTV, DSTV)

smartcard_number*

String

The smartcard number of the decoder

Sample Request

{
    "provider": "GOTV",
    "smartcard_number": "4135391280"
}

Sample Response

{
    "status": 200,
    "success": true,
    "message": "Success",
    "data": {
        "reference": "MLTCHC-250228dd3bccb250f3ed1b",
        "customer_name": "ONYENULOYA"
    }
}

CABLE SUBSCRIPTION (VEND)

This API allows you to subscribe to a bouquet.

POST https:{{base_url}}/v1/service/cable/vend

Before vending, you must have first called the Account lookup endpoint, and pass the reference generated as your reference in order to vend

Request Body

Name
Type
Description

provider*

String

Name of Cable Provider (e.g, GoTV, DSTV)

reference*

String

Reference retrived from account lookup

boquet_code*

String

Provider's boquet package

phone_number*

String

Phone number of the user

email*

String

Email address of the user

Sample Request

{
    "provider": "GOTV",
    "reference": "MLTCHC-250228dd3bccb250f3ed1b",
    "bouquet_code": "GOTVMAX",
    "phone_number": "08061234567",
    "email": "cable@squadco.com"
}

Sample Response

{
    "status": 200,
    "success": true,
    "message": "Transaction in process, client will be notified",
    "data": {
        "reference": "MLTCHC-250228dd3bccb250f3ed1b",
        "bouquet": {
            "platform": "GOTV",
            "name": "Max Bouquet",
            "code": "GOTVMAX",
            "kobo_amount": 720000,
            "currency": "NGN",
            "provider": "GOTV"
        }
    }
}

{
    "status": 404,
    "success": false,
    "message": "No transaction found with specified parameters",
    "data": {}
}

{
    "status": 401,
    "success": false,
    "message": "Authorization failed",
    "data": {}
}
```

PreviousUtilitiesNextElectricity Subscription

Last updated 2 months ago

Was this helpful?