Get card inventory brands

View as markdown
GET /v1/client/redeem-rewards/inventory/brands
Header bearer token

Get Card Inventory Brands returns the available gift card brands with their items and tiers. Each tier includes calculated currency values and secure price tokens for redemption.

Responses

  • 200 application/json

    OK

    Hide response attribute Show response attribute object
    • data object

      Response containing available gift card brands with items and tiers

      Hide data attribute Show data attribute object
      • brands array[object] Required

        List of available gift card brands

        A gift card brand with its items and tiers

        Hide brands attributes Show brands attributes object
        • key string Required

          Unique key for the brand

        • provider string Required

          Provider of the gift cards

        • name string Required

          Display name of the brand

        • description string Required

          Description of the brand

        • image_urls object Required

          URLs for brand images

          Hide image_urls attribute Show image_urls attribute object
          • * string Additional properties
        • items array[object] Required

          List of items for this brand

          A gift card item with its tiers

          Hide items attributes Show items attributes object
          • key string Required

            Unique key for the item

          • reward_name string Required

            Display name of the reward

          • reward_type string Required

            Type of the reward

          • redemption_instructions string Required

            Instructions for redeeming the reward

          • credential_types array[string] Required

            Required credential types

          • countries array[string] Required

            Available countries

          • is_active boolean

            Whether the item is currently active

          • tiers array[object] Required

            List of tiers for this item

            A pricing tier for a gift card item

            Hide tiers attributes Show tiers attributes object
            • usd_value string

              USD value of the tier

            • currency_value string Required

              Calculated currency value (coins)

            • currency_factor string Required

              Currency conversion factor used

            • token string Required

              Secure token for price verification during redemption
  • 400

    Bad request - invalid parameters

  • 500

    Internal server error

GET /v1/client/redeem-rewards/inventory/brands 
curl \
 --request GET 'https://api.bitlabs.ai/v1/client/redeem-rewards/inventory/brands' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "data": {
    "brands": [
      {
        "key": "amazon",
        "provider": "tangocard",
        "name": "Amazon",
        "description": "Amazon gift cards",
        "image_urls": {
          "logo": "https://example.com/amazon-logo.png"
        },
        "items": [
          {
            "key": "amazon_usd_50",
            "reward_name": "Amazon $50 Gift Card",
            "reward_type": "gift_card",
            "redemption_instructions": "Digital delivery via email",
            "credential_types": [
              "email"
            ],
            "countries": [
              "US"
            ],
            "is_active": true,
            "tiers": [
              {
                "usd_value": "50.00",
                "currency_value": "50000",
                "currency_factor": "1000",
                "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
              }
            ]
          }
        ]
      }
    ]
  }
}