Product Catalog API

Get the list of the Bando Fulfiller Catalog.

Overview

This API fetches a paginated list of products available for payment with the bando fulfillment protocol.

Objectives

The most common use for this API would be to populate a UI that enlists the available services to spend for your wallet / Dapp / game / metaverse, etc.

API Specification

Get list of existing products grouped by product type

get

/products/grouped

Query parameters
pageNumberinteger · default: 1

Page number (starts from 1)

pageSizeinteger · default: 100

Page size (number of items per page)

brandstring

Brand to filter

countrystring

2 letter ISO code for the destination country to filter

typestring

Product type to filter

subTypestring

Offer subtype to filter

Responses
curl -L \
  --url 'https://api.bando.cool/v1/products/grouped'
{
  "products": [
    {
      "productType": "text",
      "brands": [
        {
          "brandName": "text",
          "brandSlug": "text",
          "imageUrl": "text",
          "order": 1,
          "variants": [
            {
              "id": "text",
              "fupId": "text",
              "brand": "text",
              "country": "text",
              "notes": "text",
              "sku": "text",
              "price": {
                "fiatCurrency": "text",
                "fiatValue": "text",
                "stableCoinCurrency": "text",
                "stableCoinValue": "text"
              },
              "productType": "text",
              "referenceType": {
                "name": "text",
                "valueType": "text",
                "regex": "text"
              },
              "requiredFields": [
                {
                  "name": "text",
                  "valueType": "text",
                  "regex": "text"
                }
              ],
              "shortNotes": "text",
              "subTypes": [
                "text"
              ],
              "imageUrl": "text",
              "evmServiceId": 1,
              "svmServiceId": 1,
              "dataGB": "text",
              "dataSpeeds": [
                "text"
              ],
              "dataUnlimited": true,
              "durationDays": "text",
              "smsNumber": "text",
              "smsUnlimited": true,
              "voiceMinutes": "text",
              "voiceUnlimited": true,
              "roamingCountryIso2": "text",
              "roamingDataSpeeds": [
                "text"
              ]
            }
          ]
        }
      ]
    }
  ]
}

Get list of existing products

get

/products

Query parameters
pageNumberinteger · default: 1

Page number (starts from 1)

pageSizeinteger · default: 100

Page size (number of items per page)

brandstring

Brand to filter

countrystring

2 letter ISO code for the destination country to filter

typestring

Product type to filter

subTypestring

Offer subtype to filter

Responses
curl -L \
  --url 'https://api.bando.cool/v1/products'
{
  "totalItems": 1,
  "totalPages": 1,
  "currentPage": 1,
  "products": [
    {
      "id": "text",
      "fupId": "text",
      "brand": "text",
      "country": "text",
      "notes": "text",
      "sku": "text",
      "price": {
        "fiatCurrency": "text",
        "fiatValue": "text",
        "stableCoinCurrency": "text",
        "stableCoinValue": "text"
      },
      "productType": "text",
      "referenceType": {
        "name": "text",
        "valueType": "text",
        "regex": "text"
      },
      "requiredFields": [
        {
          "name": "text",
          "valueType": "text",
          "regex": "text"
        }
      ],
      "shortNotes": "text",
      "subTypes": [
        "text"
      ],
      "imageUrl": "text",
      "evmServiceId": 1,
      "svmServiceId": 1,
      "dataGB": "text",
      "dataSpeeds": [
        "text"
      ],
      "dataUnlimited": true,
      "durationDays": "text",
      "smsNumber": "text",
      "smsUnlimited": true,
      "voiceMinutes": "text",
      "voiceUnlimited": true,
      "roamingCountryIso2": "text",
      "roamingDataSpeeds": [
        "text"
      ]
    }
  ]
}

Last updated

Was this helpful?