search

Codes

These endpoints are specifically built for handling voucher codes and common actions against them such as redeeming or topups.

All voucher codes have 3 key attributes: Status, expiry date and balance. You can view the list of status values you may encounter here.

hashtag
Endpoints

circle-info

Avoid costly redemption logic

If the lookup is happening at a fixed location such as a point-of-sale terminal then we recommend passing the locationID with the lookup to ensure the code both exists and can be redeemed at the location based on it's current settings.

If it can't then an error is returned with code location_not_allowed

hashtag
Lookup voucher

GET https://api.giftpro.co.uk/codes/{code}/

The code must already have been sold or activatedarrow-up-right as part of an existing order before it will be returned.

If the lookup is happening at a fixed location such as a point-of-sale terminal then we recommend passing the locationID with the lookup to ensure the code both exists and can be redeemed at the location based on it's current settings.

hashtag
Query Parameters

Name
Type
Description

locationID

String

If the code isn't redeemable at the locationID provided an error is returned and feedback can be offered to the end user.

{
  "rowID": 987654,
  "orderID": 1234567,
  "productID": 701,
  "departmentID": 646
  "externalReference": "Lorum ipsum..."
  "expiryDate": "2024-09-12 11:32:41",
  "validFromDate": "2022-08-13 11:32:41",
  "balances": {
    "starting": {
      "GBP": {
        "amount": 60,
        "exchangeRate": 1
      },
      {...}
    },
    "current": {
      "GBP": 60,
      {...}
    }
  },
  "name": "Monetary Voucher",
  "description": "Lorem ipsum dolor sit amet...",
  "termsAndConditions": "Lorem ipsum dolor sit amet...",
  "redeemInstructions": "Lorem ipsum dolor sit amet...",
  "redeemCode": "1245441ASDBQ",
  "subtotal": 100.00,
  "total": 100.00,
  "status": "Valid",
  "currencyCode": "GBP",
  "partiallyRedeemable": false,
  "redeemableDomains": {
    "479": {
      "locations": [
        {
          "locationID": "71",
          "name": "Lymington Hotel Montagne"
        },
        {
          "locationID": "102",
          "name": "Ampress Park Hotel"
        },
        {...}
       ]
     },
     {...}
  },
  "redeemHistory": [
    {
      "eventID": 4759602,
      "userID": null,
      "created": "2022-08-13 11:32:41",
      "rowID": 2939141,
      "locationID": null,
      "location": null,
      "type": "Activation",
      "amount": 100,
      "currencyCode": "GBP",
      "startingBalance": 100
      "balance": 100,
      "currencies": {
        "GBP": {
          "baseCurrencyCode": "GBP",
          "exchangeRate": "1.00",
          "redeemedCurrencyCode": "GBP",
          "amount": 100.00,
          "balance": 100
        }
      },
      "links": {
        "self": "/balance_events/4759602/"
      },
      "row": {
        "code": "1245441ASDBQ",
        "type": "Voucher",
        "links": {
          "self": "/codes/1245441ASDBQ/"
        }
      },
      "order": {
        "orderID": 1234567,
        "links": {
          "self": "/orders/1234567/"
        }
      }
    }
  },            
  {...}
}

hashtag
Topup voucher

POST https://api.giftpro.co.uk/codes/{code}/topup/

Add value to a voucher code. If the voucher hasn't been seen before the first topup will return a balance event "Activation".

A successful topup will return a balance event, which also contains a row representing the voucher and the order the row is in.

hashtag
Request Body

Name
Type
Description

amount*

String

locationID*

int

hashtag
Redeem voucher

POST https://api.giftpro.co.uk/codes/{code}/redeem/

This endpoint accepts two parameters that should be used when redeeming a voucher, which parameter you use depends on if you want to redeem the entire amount or not.

The response is a balance eventarrow-up-right specific to this redemption which you may need if you want to later reversearrow-up-right.

hashtag
Request Body

Name
Type
Description

locationID*

int

amount

String

If an amount is not provided, the default is to use all remaining balance.

PreviousAddress propertiesNextStatuses

Last updated