Skip to content

get

List vendor-only plans

The business's active vendor-only plans, to sell by code

GET /api/v1/vendor-only-plans

A vendor-only plan is one your business made from its own vendor links, sold only through your vendors and never a line. Send its code as product_code on Vend data, Vend airtime or the bill routes, and the sale comes back sold_as vendor_only. Only active plans are listed. See vendor links.

Authenticate with a bearer API key: rg_test_ in test mode, rg_live_ in live.

Request

 curl -X GET https://api.useroutegate.com/api/v1/vendor-only-plans \
  -H "Authorization: Bearer $ROUTEGATE_API_KEY"

Response

200

 {
  "success": true,
  "code": "OK",
  "message": "OK",
  "data": {
    "items": [
      {
        "code": "vendor:mtn-500mb-weekly",
        "name": "MTN 500MB Weekly",
        "network": "mtn",
        "service": "data"
      }
    ]
  }
}

Error

401 AUTH_REQUIRED: The key is missing, unknown, revoked or expired. Every code is in errors.

 {
  "success": false,
  "data": null,
  "message": "Invalid API key",
  "code": "AUTH_REQUIRED"
}

Give this to your coding agent

Read https://useroutegate.com/docs/api/public/listVendorOnlyCatalogue.md and implement this call. Amounts are naira: a number with two decimals, like 1500.50.