Getgiftcardtransactions

curl --request GET \
  --url https://api.loyalty.dog/v2/giftcards/programs/{programId}/cards/{cardId}/transactions \
  --header 'Authorization: Bearer <token>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.loyalty.dog/v2/giftcards/programs/{programId}/cards/{cardId}/transactions', 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/{cardId}/transactions",
  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>"
  ],
]);

$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://api.loyalty.dog/v2/giftcards/programs/{programId}/cards/{cardId}/transactions"

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

	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://api.loyalty.dog/v2/giftcards/programs/{programId}/cards/{cardId}/transactions")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

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

Gift Cards

Getgiftcardtransactions

Get Gift Card Transaction History

Retrieves paginated transaction history for a gift card with complete audit trail. Transactions include all card activities: activation, reloads, redemptions, and consolidations.

Transaction Types:

ACTIVATION: Initial card activation and balance loading
RELOAD: Balance addition transactions
REDEMPTION: Balance deduction for purchases (negative amount)
CONSOLIDATION: Card consolidation (negative for voided cards, positive for new card)
VOID: Card voiding transactions
PURCHASE: Gift card purchase transactions
REFUND: Refund credit transactions

Business Rules:

Returns transactions in reverse chronological order (newest first)
Includes before/after balance for each transaction
Contains optional POS reference data (transactionId, cashierId, terminalId)
Supports pagination for large transaction histories
All transactions immutable for audit compliance

Path Parameters:

programId: MongoDB ObjectId of the loyalty program
cardId: MongoDB ObjectId of the gift card

Query Parameters:

limit: Maximum number of transactions to return (1-100, default: 50)
offset: Number of transactions to skip for pagination (default: 0)

Returns:

List of transaction objects ordered by createdAt (newest first)
Each transaction includes full details: type, amount, balances, timestamps, references

Transaction Response Fields:

{
    "id": "507f1f77bcf86cd799439011",
    "transactionType": "REDEMPTION",
    "amount": -25.50,
    "balanceBefore": 100.00,
    "balanceAfter": 74.50,
    "referenceId": "ORDER_12345",
    "description": "Purchase at Store #42",
    "createdAt": "2025-01-15T10:30:00Z",
    "processedAt": "2025-01-15T10:30:00Z",
    "merchantId": "merchant_123",
    "posTransactionId": "POS_TXN_789",
    "cashierId": "cashier_001",
    "terminalId": "terminal_A"
}

Status Codes:

200: Transactions retrieved successfully (empty list if no transactions)
404: Gift card not found or doesn’t belong to program
401: Unauthorized

Pagination Example:

First page: /giftcards/programs/{programId}/cards/{id}/transactions?limit=20&offset=0
Second page: /giftcards/programs/{programId}/cards/{id}/transactions?limit=20&offset=20
Third page: /giftcards/programs/{programId}/cards/{id}/transactions?limit=20&offset=40

GET

giftcards

programs

{programId}

cards

{cardId}

transactions

Getgiftcardtransactions

curl --request GET \
  --url https://api.loyalty.dog/v2/giftcards/programs/{programId}/cards/{cardId}/transactions \
  --header 'Authorization: Bearer <token>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.loyalty.dog/v2/giftcards/programs/{programId}/cards/{cardId}/transactions', 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/{cardId}/transactions",
  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>"
  ],
]);

$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://api.loyalty.dog/v2/giftcards/programs/{programId}/cards/{cardId}/transactions"

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

	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://api.loyalty.dog/v2/giftcards/programs/{programId}/cards/{cardId}/transactions")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "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"

cardId

string | null

required

Required string length: 24

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

Example:

"5eb7cf5a86d9755df3a6c593"

Query Parameters

string | null

page

integer

default:1

limit

integer

default:250

offset

integer | null

Response

Successful Response