Skip to main content
POST
/
lbms-ingress
/
transaction-lm
/
API
/
Transaction
/
GetExpirySchedule
Get Expiry Schedule
curl --request POST \
  --url https://loyalife-api.xoxoday.in/lbms-ingress/transaction-lm/API/Transaction/GetExpirySchedule \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "RelationReference": "jane.doe@example.com",
  "RelationType": 4,
  "ProgramId": 19,
  "TransactionCurrency": "DEFAULT",
  "Year": 2026
}
'
{
  "results": {
    "IsSucessful": true,
    "ErrorCode": "000",
    "ExceptionMessage": "Success",
    "ReturnObject": {
      "Period": "Quarterly",
      "ExpiryPeriod": [
        {
          "ScheduleDate": "2026-03-31T00:00:00",
          "AccrualPoints": 500,
          "RedeemPoints": 100,
          "BlockedPoints": 0,
          "TotalAvailablePoints": 400
        },
        {
          "ScheduleDate": "2026-06-30T00:00:00",
          "AccrualPoints": 300,
          "RedeemPoints": 50,
          "BlockedPoints": 0,
          "TotalAvailablePoints": 250
        }
      ]
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://help-loyalife.xoxoday.com/llms.txt

Use this file to discover all available pages before exploring further.

Returns the points expiry schedule for a member broken down by period (e.g. quarterly), showing how many points will expire at each upcoming date. Use this to surface expiry warnings in your loyalty portal — “X points expire on Dec 31” — which is one of the most effective nudges for driving redemption activity. The Year parameter lets you fetch future schedules for proactive campaign planning.

​
Responses

PathTypeDescription
results.IsSucessfulbooleantrue
results.ErrorCodestring000
results.ReturnObject.PeriodstringExpiry period type (e.g. Quarterly)
results.ReturnObject.ExpiryPeriod[].ScheduleDatestringDate when this batch of points expires
results.ReturnObject.ExpiryPeriod[].AccrualPointsintegerPoints accrued in this period
results.ReturnObject.ExpiryPeriod[].RedeemPointsintegerPoints redeemed in this period
results.ReturnObject.ExpiryPeriod[].BlockedPointsintegerPoints currently on hold/blocked
results.ReturnObject.ExpiryPeriod[].TotalExpiredPointsintegerPoints that have already expired in this period
results.ReturnObject.ExpiryPeriod[].TotalAvailablePointsintegerPoints still available (accrual minus redeemed, blocked, and expired)

Authorizations

​
Authorization
string
header
required

JWT obtained from Generate Auth Token. Pass as Authorization: bearer {token}.

Body

application/json
​
RelationReference
string
required
Example:

"jane.doe@example.com"

​
RelationType
integer
required
Example:

4

​
ProgramId
integer
required
Example:

19

​
TransactionCurrency
string
required
Example:

"DEFAULT"

​
Year
integer
required

Year for the expiry schedule

Example:

2026

Response

200 - application/json

Expiry schedule

​
results
object