Get profile account transactions

Description

Returns the transaction history for a loyalty program member’s points account. Supports pagination and filtering by points currency.

Request URL

Method: POST

https://example.com/api/v1.1/loyalty/account/transactions

Request parameters

Parameter	Type	Example	Required	Description
token	string	"abc123def456"	Yes	API token
loyalty_program_id	int	123	Yes	Loyalty program ID
points_currency_eid	string	"bonus_points"	Yes, if points_currency_iid is not provided	External points currency ID
points_currency_iid	int	1	Yes, if points_currency_eid is not provided	Internal points currency ID
from_id	string	"a1b2c3d4-e5f6-7890-g1h2-i3j4k5l6m7n8"	No	UUID of the last transaction for pagination (records with ID > from_id)
limit	int	20	No	Number of records per page (1–100, default 20)
matching	string	"email"	Yes	Profile lookup method. Possible values: "email", "phone", "profile_id", "custom"
field_name	string	"user_id"	Yes, if matching = custom	Custom field name
field_value	string / int	"12345"	Yes, if matching = custom	Custom field value
email	string	"user@example.com"	Yes, if matching = email	Member email
phone	string	"+1234567890"	Yes, if matching = phone	Member phone number in international format
profile_id	string	"profile_123"	Yes, if matching = profile_id	Profile ID

Request example

JSON

{
  "token": "abc123def456",
  "loyalty_program_id": 123,
  "points_currency_eid": "bonus_points",
  "matching": "email",
  "email": "user@example.com",
  "limit": 20
}

XML

<xml>
  <token>abc123def456</token>
  <loyalty_program_id>123</loyalty_program_id>
  <points_currency_eid>bonus_points</points_currency_eid>
  <matching>email</matching>
  <email>user@example.com</email>
  <limit>20</limit>
</xml>

Response example

JSON

{
  "data": [
    {
      "transaction_id": "a1b2c3d4-e5f6-7890-g1h2-i3j4k5l6m7n8",
      "transaction_eid": "trans_12345",
      "created_at": "2023-09-01T12:34:56Z",
      "transaction_type": "accrual",
      "amount": "100.1",
      "balance_before": "500.5",
      "balance_after": "600.6",
      "promo_iid": 42,
      "promo_eid": "promo_2023",
      "description": "Points accrual for a purchase",
      "activation_date": "2023-09-01T12:34:56Z",
      "expiration_date": "2023-12-31T23:59:59Z",
      "source_type": "order",
      "source_iid": 789,
      "source_sid": "order_123",
      "source_subiid": 1,
      "is_temp": false,
      "custom_json": {"key": "value"},
      "product_eid": "prod_123",
      "sku_eid": "sku_456",
      "canceled": false
    }
  ],
  "next_from_id": "b2c3d4e5-f6g7-8901-h2i3-j4k5l6m7n8o9",
  "total_count": 150,
  "error": 0,
  "error_text": "Successful operation"
}

XML

<xml>
  <data>
    <transaction_id>a1b2c3d4-e5f6-7890-g1h2-i3j4k5l6m7n8</transaction_id>
    <transaction_eid>trans_12345</transaction_eid>
    <created_at>2023-09-01T12:34:56Z</created_at>
    <transaction_type>accrual</transaction_type>
    <amount>100.1</amount>
    <balance_before>500.5</balance_before>
    <balance_after>600.6</balance_after>
    <promo_iid>42</promo_iid>
    <promo_eid>promo_2023</promo_eid>
    <description>Points accrual for a purchase</description>
    <activation_date>2023-09-01T12:34:56Z</activation_date>
    <expiration_date>2023-12-31T23:59:59Z</expiration_date>
    <source_type>order</source_type>
    <source_iid>789</source_iid>
    <source_sid>order_123</source_sid>
    <source_subiid>1</source_subiid>
    <is_temp>false</is_temp>
    <custom_json>{"key": "value"}</custom_json>
    <product_eid>prod_123</product_eid>
    <sku_eid>sku_456</sku_eid>
    <canceled>false</canceled>
  </data>
  <next_from_id>b2c3d4e5-f6g7-8901-h2i3-j4k5l6m7n8o9</next_from_id>
  <total_count>150</total_count>
  <error>0</error>
  <error_text>Successful operation</error_text>
</xml>

Response parameters

Parameter	Type	Description
error	int	Error code
error_text	string	Error text
transaction_id	string (UUID)	Unique transaction ID
transaction_eid	string	External transaction ID
created_at	string (RFC3339)	Transaction creation date and time
transaction_type	string	Transaction type (accrual, redeem, expire, etc.)
amount	string	Number of accrued or redeemed points
balance_before	string	Balance before the operation
balance_after	string	Balance after the operation
promo_iid	int	Internal promotion ID
promo_eid	string	External promotion ID
description	string	Transaction description
activation_date	string (RFC3339)	Points activation date
expiration_date	string (RFC3339)	Points expiration date
source_type	string	Transaction source (api, manual, system, order, workflow, tier_group)
product_eid	string	External product ID
sku_eid	string	External SKU ID
canceled	boolean	Transaction canceled flag
next_from_id	string (UUID)	UUID for the next page
total_count	int	Total number of transactions