Enrollment Claim Attempt Detail

Enrollment claim attempt details show how an enrollment handled a retro claim request, including earned points and why the claim/points might have been rejected (e.g., already claimed, limits reached, inactive enrollment).

  • claimed
    Type: boolean
    required

    Indicates whether this enrollment newly claimed in this specific request. Note that an enrollment may claim without earning points depending on program configuration.

    • true: The enrollment successfully claimed the transaction in this request.
    • false: The enrollment did not claim in this request. See the message field for the reason.

    Note: An enrollment can have claimed: false even if it claimed the transaction in a previous request. The claimed field specifically indicates whether points were earned in this request.

  • enrollment_id
    Type: integer
    required

    The ID of the loyalty enrollment that attempted to claim the transaction.

  • message
    Type: string

    A message explaining the outcome of this enrollment's claim attempt.

    Note: The specific wording of messages may vary. The examples below show common scenarios but should not be considered an exhaustive list.

    Example messages when claimed: false:

    • "enrollment already claimed" - This enrollment claimed the transaction in a previous request
    • "enrollment is not active" - The enrollment is not in an active state
    • "program is not active" - The loyalty program is not active
    • "past the retro claim window for this transaction" - The transaction is too old to be retro claimed
    • "retro claims are disabled because retro claim limitation time period is 0" - The program has retro claiming disabled
    • "retro claim limit exceeded: X of Y claims used" - The enrollment has reached its maximum number of retro claims
    • "retro claim limit for transaction date YYYY-MM-DD reached - X of Y claims used" - The enrollment has reached its daily retro claim limit for this transaction date

    Example messages when claimed: true with limited points:

    • "retro claim points are disabled because retro claim limitation time period is 0" - Points set to 0 due to program configuration
    • "retro claim point limit of X already reached from previous retro claims" - No points earned because limit reached
    • "X points earned from previous retro claims plus Y points from this transaction reached retro claim point limit of Z" - Partial points earned due to approaching limit

    May be omitted when the claim was successful with no limitations applied.

  • points_earned
    Type: integer

    The number of points earned by this enrollment in this claim attempt.

    Only present when claimed: true.

    The value may be:

    • A positive integer indicating points earned
    • 0 if retro claim limitations prevented point earning (see message for details)
Examples 
{
  "enrollment_id": 42,
  "claimed": true,
  "points_earned": 75
}