Squad API Documentation
Search
⌃K

VALUE ADDED SERVICES (VAS)

These are suites of API that allows you vend airtime and data. Please note that the equivalent value of all data and airtime vended will be charged from your SQUAD WALLET.

API KEYS (Test Environment)

  1. 1.
    Create an account on our sandbox environment: sandbox.squadco.com
  2. 2.
    Retrieve keys from the bottom of the Get Started Page
Authorization Any request made without the authorization key (secret key) will fail with a 401 (Unauthorized) response code.
The authorization key is sent via the request header as Bearer Token Authorization
Example: Authorization: Bearer sandbox_sk_94f2b798466408ef4d19e848ee1a4d1a3e93f104046f

VEND AIRTIME

This API allows you vend airtime. Minimum amount that can be vended is 50 naira.
post
https://sandbox-api-d.squadco.com
/vending/purchase/airtime
This API vends Airtime

Sample Request

{
"phone_number": "08139011943",
"amount": 5000
}

VEND DATA BUNDLES

This API allows you vend data bundles.
post
https://sandbox-api-d.squadco.com
/vending/purchase/data

Sample Request

{
"phone_number": "07062918558",
"amount": 100,
"plan_code": "1001"
}
​

GET DATA BUNDLES

This API returns all available data bundle plans for all telcos
get
https://sandbox-api-d.squadco.com
/vending/data-bundles?network=MTN
This API returns all available data bundle plans for all telcos

GET ALL TRANSACTIONS

This API returns all transactions done by a merchant.
​
get
https://api-d.squadco.com
/vending/transactions?page=1&perPage=4&action=debit
This API returns all transactions done by a merchant.

GO LIVE

To go live, simply: 1. Change the base URL for your endpoints from sandbox-api-d.squadco.com to api-d.squadco.com
3. Complete your KYC
4. Use the secret keys provided on the dashboard to authenticate your live transactions
Squad POS - Previous
API Documentation
Next - VALUE ADDED SERVICES
Page 1
Last modified 1mo ago