Brand Information ​

As well as performing transactions, our API can be used to retrieve information to help you automate as much as possible.

• Brands - Gives you access to the product catalog - use this to stay up to date with brands available on your account, T&Cs and more.
• Templates - As you'll read later, using up to date brand templates to display the digital gift cards is important. If you're receiving the raw gift code from us, use these API calls to check & update your copy of the templates.

Brands API response ​

When fetching brand information from our Brands endpoint, you will receive the following information:

If you provide the detail query parameter with a boolean value of true, you'll also get the following information about the brand(s) in the API response under the detail key:

Product Type ​

A string value for the type of product is returned for each brand in the response.

For example:

"type": "gift-card"

"type": "gift-card"

The possible values are:

• "gift-card" — the product is a gift card
• "choice-link" — the product is a Choice Link. See Choice Links for more information.

Status ​

The status represents the current state of the brand on our platform. If the brand status is not ENABLED, a reason will be supplied.

For example:

"status": {
    "code": "DISABLED",
    "reason": "Relationship disabled by brand"
}

"status": {
    "code": "DISABLED",
    "reason": "Relationship disabled by brand"
}

The possible values for status.code are:

• "ENABLED" - The brand is available to purchase.
• "DISABLED" - The brand is not available to purchase.
• "PAUSED" - You have switched off the brand on your account, so it is not available to purchase.

Transaction Types ​

Transaction Types define the different actions you can take using the specified brand.

For example:

"transaction_types": [
    "digital_issuance",
    "cancelled_digital_issuance",
    "balance_check"
]

"transaction_types": [
    "digital_issuance",
    "cancelled_digital_issuance",
    "balance_check"
]

Each transaction type is associated with an endpoint in our API:

Delivery Methods ​

A delivery method defines the way in which a gift card can be provided to you.

For example:

"delivery_methods": [
    "code",
    "url",
    "wrapped"
]

"delivery_methods": [
    "code",
    "url",
    "wrapped"
]

Here are the possible values:

Countries Served ​

The countries a brand serves are returned as an array of ISO-3166 Alpha-2 codes:

"countries_served": [
    "GB"
]

"countries_served": [
    "GB"
]

Categories new ​

Each brand will have one or more categories associated with it. A brand's assigned categories will be returned in the response from the Brands API endpoint.

"categories": [
    "food-and-drink",
    "tv-and-movies"
]

"categories": [
    "food-and-drink",
    "tv-and-movies"
]

List of all categories ​

Here is a list of all the categories we currently support:

VAT ​

For those who require it, VAT information is returned about each brand.

"vat": {
    "exempt": false,
    "type": "MPV",
    "rate": 8.00
}

"vat": {
    "exempt": false,
    "type": "MPV",
    "rate": 8.00
}

Face Value ​

The possible face value that can be requested for a brand is returned in the API response. It can be defined in two different ways:

Open value ​

An 'Open value' brand will have an upper and lower maximum value along with a 'minor unit' which the requested value must be divisible by.

For digital gift cards, the digital_face_value_limits values apply.

For physical gift cards, the physical_face_value_limits values apply.

For example:

"digital_face_value_limits": {
    "lower": 10.00,
    "upper": 200.00,
    "minor_unit": 0.01
}

"digital_face_value_limits": {
    "lower": 10.00,
    "upper": 200.00,
    "minor_unit": 0.01
}

This means you can request any value between 10.00 and 200.00, so long as it is divisible by 0.01. So valid values would be 65.43, 23.09, 150.00, etc. And invalid values would be 9.99, 200.01, 50000.00, etc.

Fixed denominations ​

Some brands do not support 'open value' requests and instead offer a list of available values we call 'denominations'.

These values apply to both digital and physical gift cards.

"denominations": [
    10.00,
    20.00,
    25.00,
    50.00,
    100.00
]

"denominations": [
    10.00,
    20.00,
    25.00,
    50.00,
    100.00
]

Shipping Methods ​

Shipping methods are only relevant to certain brands and only possible with physical gift cards.

More information on this can be found here

Shipping method information is returned as an array of shipping method objects:

"shipping_methods": [
    {
        "standard": {
            "identifier": "standard",
            "description": "First Class",
            "cost": {
                "currency": "GBP",
                "amount": 1.3
            }
        }
    },
    {
        "standard-signed": {
            "identifier": "standard-signed",
            "description": "First Class Signed For",
            "cost": {
                "currency": "GBP",
                "amount": 2.42
            }
        }
    }
]

"shipping_methods": [
    {
        "standard": {
            "identifier": "standard",
            "description": "First Class",
            "cost": {
                "currency": "GBP",
                "amount": 1.3
            }
        }
    },
    {
        "standard-signed": {
            "identifier": "standard-signed",
            "description": "First Class Signed For",
            "cost": {
                "currency": "GBP",
                "amount": 2.42
            }
        }
    }
]

Brand Assets detail ​

Urls to the brand's logo and gift card image:

"assets": {
    "logo_url": "https://example.com",
    "gift_card_url": "https://example.com"
}

"assets": {
    "logo_url": "https://example.com",
    "gift_card_url": "https://example.com"
}

Barcodes detail ​

The barcode type used by the brand. If the brand does not support barcodes, "NONE" is returned instead.

"barcode": "C128"

"barcode": "C128"

2D barcode types:

• "C128"
• "C128A"
• "C39"
• "I25"

3D barcode types:

• "QRCODE"
• "PDF417"

More information on handling barcodes can be found here

Redemption Methods detail ​

Redemption methods describe how the end user is able to use/spend/redeem the gift card.

"redemption_methods": [
    "online",
    "instore"
]

"redemption_methods": [
    "online",
    "instore"
]

Terms and Conditions detail ​

If the brand has supplied terms and conditions for their gift card, it will be returnd as either a string of text or as a url:

"terms_and_conditions_url": "https://example.com",
"terms_and_conditions_copy": "Lorem ipsum dolor sit amet, consectetur adipiscing el..."

"terms_and_conditions_url": "https://example.com",
"terms_and_conditions_copy": "Lorem ipsum dolor sit amet, consectetur adipiscing el..."