List templates

curl --request GET \
  --url https://tapcoupon.at/api/v1/templates \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Device-ID: <x-device-id>'

import requests

url = "https://tapcoupon.at/api/v1/templates"

headers = {
    "X-Device-ID": "<x-device-id>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Device-ID': '<x-device-id>', Authorization: 'Bearer <token>'}
};

fetch('https://tapcoupon.at/api/v1/templates', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://tapcoupon.at/api/v1/templates",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "X-Device-ID: <x-device-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://tapcoupon.at/api/v1/templates"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Device-ID", "<x-device-id>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://tapcoupon.at/api/v1/templates")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Device-ID"] = '<x-device-id>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "templates": [
    {
      "id": "<string>",
      "pocketId": "<string>",
      "name": "<string>",
      "description": "<string>",
      "templateType": "couponTemplate",
      "isActive": true,
      "isLocationBound": true,
      "isAmountSpecified": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "cardData": {
        "cardType": "blankCard",
        "id": "<string>",
        "cardId": "<string>",
        "serialNumber": 123,
        "pocketId": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "activatedAt": "2023-11-07T05:31:56Z",
        "canceledAt": "2023-11-07T05:31:56Z",
        "activated": true,
        "lifetime": 1,
        "description": "<string>",
        "amount": 123,
        "location": {
          "id": "<string>",
          "name": "<string>",
          "pocketId": "<string>",
          "archived": true
        },
        "createdByEmployeeId": "<string>",
        "archived": true,
        "testCard": true,
        "isLocationBound": true,
        "customerEmail": "<string>",
        "templateId": "<string>",
        "logs": [
          {
            "createdAt": "2023-11-07T05:31:56Z",
            "cardId": "<string>",
            "path": "<string>",
            "method": "<string>",
            "statusCode": 123,
            "employeeUsername": "<string>"
          }
        ]
      }
    }
  ]
}

{
  "error": "<string>",
  "errorCode": "<string>"
}

{
  "error": "<string>",
  "errorCode": "<string>"
}

{
  "error": "<string>",
  "errorCode": "<string>"
}

{
  "error": "<string>",
  "errorCode": "<string>"
}

GET

templates

List templates

curl --request GET \
  --url https://tapcoupon.at/api/v1/templates \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Device-ID: <x-device-id>'

import requests

url = "https://tapcoupon.at/api/v1/templates"

headers = {
    "X-Device-ID": "<x-device-id>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Device-ID': '<x-device-id>', Authorization: 'Bearer <token>'}
};

fetch('https://tapcoupon.at/api/v1/templates', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://tapcoupon.at/api/v1/templates",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "X-Device-ID: <x-device-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://tapcoupon.at/api/v1/templates"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Device-ID", "<x-device-id>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://tapcoupon.at/api/v1/templates")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Device-ID"] = '<x-device-id>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "templates": [
    {
      "id": "<string>",
      "pocketId": "<string>",
      "name": "<string>",
      "description": "<string>",
      "templateType": "couponTemplate",
      "isActive": true,
      "isLocationBound": true,
      "isAmountSpecified": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "cardData": {
        "cardType": "blankCard",
        "id": "<string>",
        "cardId": "<string>",
        "serialNumber": 123,
        "pocketId": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "activatedAt": "2023-11-07T05:31:56Z",
        "canceledAt": "2023-11-07T05:31:56Z",
        "activated": true,
        "lifetime": 1,
        "description": "<string>",
        "amount": 123,
        "location": {
          "id": "<string>",
          "name": "<string>",
          "pocketId": "<string>",
          "archived": true
        },
        "createdByEmployeeId": "<string>",
        "archived": true,
        "testCard": true,
        "isLocationBound": true,
        "customerEmail": "<string>",
        "templateId": "<string>",
        "logs": [
          {
            "createdAt": "2023-11-07T05:31:56Z",
            "cardId": "<string>",
            "path": "<string>",
            "method": "<string>",
            "statusCode": 123,
            "employeeUsername": "<string>"
          }
        ]
      }
    }
  ]
}

{
  "error": "<string>",
  "errorCode": "<string>"
}

{
  "error": "<string>",
  "errorCode": "<string>"
}

{
  "error": "<string>",
  "errorCode": "<string>"
}

{
  "error": "<string>",
  "errorCode": "<string>"
}

GET `/templates`

Retrieve templates for your API key’s account. Send Authorization: Bearer YOUR_API_KEY and X-Device-ID: YOUR_DEVICE_ID. See authentication. The response wraps the list in templates. Check isActive before offering a template for issuance.

Template type	Card type	Configuration
`couponTemplate`	`couponCard`	Fixed or variable coupon amount
`loyaltyTemplate`	`loyaltyCard`	Stamps, reward message, renewals
`pointsTemplate`	`pointsCard`	Points program and reward ids
`statusTemplate`	`statusCard`	Tier program and rolling duration

isLocationBound controls whether issued cards are restricted to their issuing location. cardData.lifetime is in hours. Points and status cardData include a populated program. Coupon templates expose isAmountSpecified. When true, issuance uses cardData.amount; when false, your apply/create request must supply a positive amount in cents.

Example request

curl "https://tapcoupon.at/api/v1/templates" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Device-ID: YOUR_DEVICE_ID"

Authorizations

Authorization

string

header

required

Location API key. Also requires X-Device-ID.

Headers

X-Device-ID

string

required

Stable device identifier. API key binds to this value on first use.

Response

Success

success

boolean

templates

object[]

Show child attributes

Overview

Cards

Templates

Employees

Account and rewards

Partner integration

List templates

GET `/templates`

Example request

Authorizations

Headers

Response

​GET /templates

​Example request

Authorizations

Headers

Response

GET `/templates`

Example request