Skip to main content

Voyado Engage

Get all available vouchers for contact

Example use case

1. GET the contact for whom the vouchers should be retrieved

Please use one of the recommended contact lookup methods available.

2. GET reward vouchers

To get all reward vouchers (expired, redeemed and available) for the member use the following requests:

Endpoint/api/v2/contacts/{contactId}/bonuschecks

{
  "contactId": "string",
  "offset": int
  "count": int
}

To get available vouchers for the member

Endpoint/api/v2/contacts/{contactId}/bonuschecks/available

{
  "contactId": "string",
  "offset": int
  "count": int
}

3. Process response

The API then returns the vouchers for the specific member:

Successful response (200) with one voucher returned

{
  "count": 1,
  "offset": 0,
  "items": [
    {
      "id": "af62c5c8-7ff8-4733-9b67-a75300738cd3",
      "checkNumber": "2510003093766",
      "name": "Bonusutbetalning 2017-04-12 07:00",
      "value": {
        "currency": "SEK",
        "amount": 195
      },
      "localValues": [
        {
          "currency": "NOK",
          "amount": 195
        },
        {
          "currency": "EUR",
          "amount": 19.5
        }],
      "bonusPoints": 4869
    }
  ],
  "totalCount": 1
}