Creategiftcard

curl --request POST \
  --url https://api.loyalty.dog/v2/giftcards/programs/{programId}/cards \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "initialValue": 5000.005,
  "merchantId": "5eb7cf5a86d9755df3a6c593",
  "customerEmail": "[email protected]",
  "customerPhone": "<string>",
  "customerName": "<string>",
  "senderName": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "isPhysical": false,
  "designTemplate": "<string>",
  "customMessage": "<string>",
  "deliverAt": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://api.loyalty.dog/v2/giftcards/programs/{programId}/cards"

payload = {
    "initialValue": 5000.005,
    "merchantId": "5eb7cf5a86d9755df3a6c593",
    "customerEmail": "[email protected]",
    "customerPhone": "<string>",
    "customerName": "<string>",
    "senderName": "<string>",
    "expiresAt": "2023-11-07T05:31:56Z",
    "isPhysical": False,
    "designTemplate": "<string>",
    "customMessage": "<string>",
    "deliverAt": "2023-11-07T05:31:56Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    initialValue: 5000.005,
    merchantId: '5eb7cf5a86d9755df3a6c593',
    customerEmail: '[email protected]',
    customerPhone: '<string>',
    customerName: '<string>',
    senderName: '<string>',
    expiresAt: '2023-11-07T05:31:56Z',
    isPhysical: false,
    designTemplate: '<string>',
    customMessage: '<string>',
    deliverAt: '2023-11-07T05:31:56Z'
  })
};

fetch('https://api.loyalty.dog/v2/giftcards/programs/{programId}/cards', 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://api.loyalty.dog/v2/giftcards/programs/{programId}/cards",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'initialValue' => 5000.005,
    'merchantId' => '5eb7cf5a86d9755df3a6c593',
    'customerEmail' => '[email protected]',
    'customerPhone' => '<string>',
    'customerName' => '<string>',
    'senderName' => '<string>',
    'expiresAt' => '2023-11-07T05:31:56Z',
    'isPhysical' => false,
    'designTemplate' => '<string>',
    'customMessage' => '<string>',
    'deliverAt' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.loyalty.dog/v2/giftcards/programs/{programId}/cards"

	payload := strings.NewReader("{\n  \"initialValue\": 5000.005,\n  \"merchantId\": \"5eb7cf5a86d9755df3a6c593\",\n  \"customerEmail\": \"[email protected]\",\n  \"customerPhone\": \"<string>\",\n  \"customerName\": \"<string>\",\n  \"senderName\": \"<string>\",\n  \"expiresAt\": \"2023-11-07T05:31:56Z\",\n  \"isPhysical\": false,\n  \"designTemplate\": \"<string>\",\n  \"customMessage\": \"<string>\",\n  \"deliverAt\": \"2023-11-07T05:31:56Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.loyalty.dog/v2/giftcards/programs/{programId}/cards")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"initialValue\": 5000.005,\n  \"merchantId\": \"5eb7cf5a86d9755df3a6c593\",\n  \"customerEmail\": \"[email protected]\",\n  \"customerPhone\": \"<string>\",\n  \"customerName\": \"<string>\",\n  \"senderName\": \"<string>\",\n  \"expiresAt\": \"2023-11-07T05:31:56Z\",\n  \"isPhysical\": false,\n  \"designTemplate\": \"<string>\",\n  \"customMessage\": \"<string>\",\n  \"deliverAt\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.loyalty.dog/v2/giftcards/programs/{programId}/cards")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"initialValue\": 5000.005,\n  \"merchantId\": \"5eb7cf5a86d9755df3a6c593\",\n  \"customerEmail\": \"[email protected]\",\n  \"customerPhone\": \"<string>\",\n  \"customerName\": \"<string>\",\n  \"senderName\": \"<string>\",\n  \"expiresAt\": \"2023-11-07T05:31:56Z\",\n  \"isPhysical\": false,\n  \"designTemplate\": \"<string>\",\n  \"customMessage\": \"<string>\",\n  \"deliverAt\": \"2023-11-07T05:31:56Z\"\n}"

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

{
  "id": "5eb7cf5a86d9755df3a6c593",
  "cardNumber": "<string>",
  "balance": "<string>",
  "initialValue": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "activatedAt": "2023-11-07T05:31:56Z",
  "expiresAt": "2023-11-07T05:31:56Z",
  "suspendedReason": "<string>",
  "suspendedUntil": "2023-11-07T05:31:56Z",
  "suspendedAt": "2023-11-07T05:31:56Z",
  "customerId": "5eb7cf5a86d9755df3a6c593",
  "customerEmail": "<string>",
  "customerPhone": "<string>",
  "customerName": "<string>",
  "merchantId": "5eb7cf5a86d9755df3a6c593",
  "isPhysical": true,
  "designTemplate": "<string>",
  "customMessage": "<string>",
  "lastFourDigits": "<string>",
  "programId": "5eb7cf5a86d9755df3a6c593",
  "card": {
    "serialNumber": "<string>",
    "passTypeIdentifier": "<string>",
    "url": "<string>"
  },
  "senderName": "<string>",
  "merchantName": "<string>",
  "deliverAt": "2023-11-07T05:31:56Z",
  "delivered": false
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Gift Cards

Creategiftcard

Create a new gift card in pending status with a generated card number and security code.

Validates and sets the expiration (defaults to 1 year, must not exceed 5 years), sanitizes the provided custom message to prevent XSS, generates a unique 16-digit card number and a 6-digit security code, persists the card with a zero balance and the requested initialValue, and returns the persisted card representation.

Parameters: data (CreateGiftCardRequest): Request payload containing initialValue, merchantId, optional customer fields, expiration, isPhysical, designTemplate, and customMessage.

Returns: GiftCardResponse: The newly created gift card data (status will be “pending”); the security code is stored but not returned.

POST

giftcards

programs

{programId}

cards

Creategiftcard

curl --request POST \
  --url https://api.loyalty.dog/v2/giftcards/programs/{programId}/cards \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "initialValue": 5000.005,
  "merchantId": "5eb7cf5a86d9755df3a6c593",
  "customerEmail": "[email protected]",
  "customerPhone": "<string>",
  "customerName": "<string>",
  "senderName": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "isPhysical": false,
  "designTemplate": "<string>",
  "customMessage": "<string>",
  "deliverAt": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://api.loyalty.dog/v2/giftcards/programs/{programId}/cards"

payload = {
    "initialValue": 5000.005,
    "merchantId": "5eb7cf5a86d9755df3a6c593",
    "customerEmail": "[email protected]",
    "customerPhone": "<string>",
    "customerName": "<string>",
    "senderName": "<string>",
    "expiresAt": "2023-11-07T05:31:56Z",
    "isPhysical": False,
    "designTemplate": "<string>",
    "customMessage": "<string>",
    "deliverAt": "2023-11-07T05:31:56Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    initialValue: 5000.005,
    merchantId: '5eb7cf5a86d9755df3a6c593',
    customerEmail: '[email protected]',
    customerPhone: '<string>',
    customerName: '<string>',
    senderName: '<string>',
    expiresAt: '2023-11-07T05:31:56Z',
    isPhysical: false,
    designTemplate: '<string>',
    customMessage: '<string>',
    deliverAt: '2023-11-07T05:31:56Z'
  })
};

fetch('https://api.loyalty.dog/v2/giftcards/programs/{programId}/cards', 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://api.loyalty.dog/v2/giftcards/programs/{programId}/cards",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'initialValue' => 5000.005,
    'merchantId' => '5eb7cf5a86d9755df3a6c593',
    'customerEmail' => '[email protected]',
    'customerPhone' => '<string>',
    'customerName' => '<string>',
    'senderName' => '<string>',
    'expiresAt' => '2023-11-07T05:31:56Z',
    'isPhysical' => false,
    'designTemplate' => '<string>',
    'customMessage' => '<string>',
    'deliverAt' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.loyalty.dog/v2/giftcards/programs/{programId}/cards"

	payload := strings.NewReader("{\n  \"initialValue\": 5000.005,\n  \"merchantId\": \"5eb7cf5a86d9755df3a6c593\",\n  \"customerEmail\": \"[email protected]\",\n  \"customerPhone\": \"<string>\",\n  \"customerName\": \"<string>\",\n  \"senderName\": \"<string>\",\n  \"expiresAt\": \"2023-11-07T05:31:56Z\",\n  \"isPhysical\": false,\n  \"designTemplate\": \"<string>\",\n  \"customMessage\": \"<string>\",\n  \"deliverAt\": \"2023-11-07T05:31:56Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.loyalty.dog/v2/giftcards/programs/{programId}/cards")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"initialValue\": 5000.005,\n  \"merchantId\": \"5eb7cf5a86d9755df3a6c593\",\n  \"customerEmail\": \"[email protected]\",\n  \"customerPhone\": \"<string>\",\n  \"customerName\": \"<string>\",\n  \"senderName\": \"<string>\",\n  \"expiresAt\": \"2023-11-07T05:31:56Z\",\n  \"isPhysical\": false,\n  \"designTemplate\": \"<string>\",\n  \"customMessage\": \"<string>\",\n  \"deliverAt\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.loyalty.dog/v2/giftcards/programs/{programId}/cards")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"initialValue\": 5000.005,\n  \"merchantId\": \"5eb7cf5a86d9755df3a6c593\",\n  \"customerEmail\": \"[email protected]\",\n  \"customerPhone\": \"<string>\",\n  \"customerName\": \"<string>\",\n  \"senderName\": \"<string>\",\n  \"expiresAt\": \"2023-11-07T05:31:56Z\",\n  \"isPhysical\": false,\n  \"designTemplate\": \"<string>\",\n  \"customMessage\": \"<string>\",\n  \"deliverAt\": \"2023-11-07T05:31:56Z\"\n}"

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

{
  "id": "5eb7cf5a86d9755df3a6c593",
  "cardNumber": "<string>",
  "balance": "<string>",
  "initialValue": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "activatedAt": "2023-11-07T05:31:56Z",
  "expiresAt": "2023-11-07T05:31:56Z",
  "suspendedReason": "<string>",
  "suspendedUntil": "2023-11-07T05:31:56Z",
  "suspendedAt": "2023-11-07T05:31:56Z",
  "customerId": "5eb7cf5a86d9755df3a6c593",
  "customerEmail": "<string>",
  "customerPhone": "<string>",
  "customerName": "<string>",
  "merchantId": "5eb7cf5a86d9755df3a6c593",
  "isPhysical": true,
  "designTemplate": "<string>",
  "customMessage": "<string>",
  "lastFourDigits": "<string>",
  "programId": "5eb7cf5a86d9755df3a6c593",
  "card": {
    "serialNumber": "<string>",
    "passTypeIdentifier": "<string>",
    "url": "<string>"
  },
  "senderName": "<string>",
  "merchantName": "<string>",
  "deliverAt": "2023-11-07T05:31:56Z",
  "delivered": false
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

JWT access token obtained from POST /v2/token.

Headers

X-Eposn-Customer-Token

string | null

X-Eposn-Merchant-Token

string | null

Path Parameters

programId

string | null

required

Required string length: 24

Pattern: ^[0-9a-f]{24}$

Example:

"5eb7cf5a86d9755df3a6c593"

Query Parameters

cardId

string | null

Required string length: 24

Pattern: ^[0-9a-f]{24}$

Example:

"5eb7cf5a86d9755df3a6c593"

Body

application/json

initialValue

required

Required range: 0.01 <= x <= 10000

merchantId

string

required

Required string length: 24

Pattern: ^[0-9a-f]{24}$

Example:

"5eb7cf5a86d9755df3a6c593"

customerEmail

string<email> | null

customerPhone

string<phone> | null

customerName

string | null

Maximum string length: 255

senderName

string | null

Maximum string length: 255

expiresAt

string<date-time> | null

isPhysical

boolean

default:false

designTemplate

string | null

Maximum string length: 100

customMessage

string | null

Maximum string length: 500

deliverAt

string<date-time> | null

Response

Successful Response

string

required

Required string length: 24

Pattern: ^[0-9a-f]{24}$

Example:

"5eb7cf5a86d9755df3a6c593"

cardNumber

string

required

balance

string

required

initialValue

string

required

status

enum<string>

required

Gift card status enumeration.

Available options:

pending,

active,

suspended,

expired,

voided,

depleted

createdAt

string<date-time>

required

updatedAt

string<date-time> | null

required

activatedAt

string<date-time> | null

required

expiresAt

string<date-time>

required

suspendedReason

string | null

required

suspendedUntil

string<date-time> | null

required

suspendedAt

string<date-time> | null

required

customerId

string | null

required

Required string length: 24

Pattern: ^[0-9a-f]{24}$

Example:

"5eb7cf5a86d9755df3a6c593"

customerEmail

string | null

required

customerPhone

string | null

required

customerName

string | null

required

merchantId

string

required

Required string length: 24

Pattern: ^[0-9a-f]{24}$

Example:

"5eb7cf5a86d9755df3a6c593"

isPhysical

boolean

required

designTemplate

string | null

required

customMessage

string | null

required

lastFourDigits

string

required

programId

string

required

Required string length: 24

Pattern: ^[0-9a-f]{24}$

Example:

"5eb7cf5a86d9755df3a6c593"

card

PassCard · object | null

required

The customer card object

Attributes: serialNumber (str): The serial number of the customer pass passTypeIdentifier (str): The pass type identifier of the customer pass url (str): The shareable URL of the customer pass

Show child attributes

senderName

string | null

merchantName

string | null

deliverAt

string<date-time> | null

delivered

boolean

default:false