GET Gift Card Configuration

​

Returns how the brand wants gift cards presented — the barcode format to render when the customer shows a card in store, and the brand's own pages for buying a card or topping one up.

Read it once when you build your gift card screens. A brand that has never configured gift cards returns null, which is your signal not to show the section at all.

Path Parameters

  • Brand UUID

Headers

  • Type of content accepted by the API (application/json in most cases)

  • Application key for specific client app

  • Version of the API to be used

  • Authorization header

  • Unique request identifier

Responses

  • application/json
  • The application may not read this brand.

  • Unknown brand.

Request Example for get/brands/{brand_id}/gift-card-configurations
curl 'https://api-public-demo.menu.app/api/brands/{brand_id}/gift-card-configurations' \
  --header 'Accept: application/json' \
  --header 'Application: application-key' \
  --header 'API-VERSION: ' \
  --header 'X-Request-ID: c10b4a70-6274-490d-80a0-03e7bb826937'
{
  "status": "OK",
  "code": 200,
  "data": {
    "gift_card_configuration": {
      "id": 12,
      "brand_id": 450,
      "scan_code_type": "qrcode",
      "gift_card_buy_url": "https://example.com/gift-cards/buy",
      "gift_card_add_funds_url": "https://example.com/gift-cards/reload",
      "image": null
    }
  }
}