Skip to main content

Get vouchers for contact

As an Engage user, you decide how a contact's points are converted to vouchers. Depending on how your model is set up, you can either convert all earned points into the corresponding monetary value and then clear the points, or use a step model to send out vouchers with fixed amounts.

Your points model also determines what the minimum points are for vouchers to be paid out.

Getting a contact's vouchers

Once a contact has been identified, and you have their contactId, you can fetch their available vouchers with the following request:

GET /api/v3/reward-vouchers/available

You can also fetch all of their vouchers (expired and redeemed as well as available) like this:

GET /api/v3/reward-vouchers

Or you can fetch only those vouchers with the status redeemed:

GET /api/v3/reward-vouchers/redeemed

In all these cases, the GUID of the contact is appended to the URL as the parameter contactId as in this example:

GET /api/v3/reward-vouchers?contactId=a3835e0b-4acd-480f-9a24-ceac75337237

Response

Below is an example of a successful response with a HTTP 200 OK status and one voucher returned (in the items array).

{
  "count": 1,
  "offset": 0,
  "items": [
    {
      "id": "af61c5c8-7ff8-1234-9b67-c75300738cd3",
      "voucherNumber": "2511233093766",
      "name": "Bonus payment 2017-04-12 07:00",
      "redeemedOn": "2023-02-08T12:15:59.212Z",
      "redeemed": true,
      "expiresOn": "2023-02-08T12:15:59.212Z",
      "value": {
        "currency": "SEK",
        "amount": 195
      },
      "localValues": [
        {
          "currency": "NOK",
          "amount": 195
        },
        {
          "currency": "EUR",
          "amount": 19.5
        }],
      "points": 4869
    }
  ],
  "totalCount": 1
}
In this section: