> ## Documentation Index
> Fetch the complete documentation index at: https://voucherify-rc-lv2-guides.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# List member benefit transactions
>
BETA endpoint
This is a work-in-progress documentation of a BETA endpoint. The parameters, fields, request and response bodies, and other data may be subject to change. If you want to share feedback or improvements, contact [Voucherify support](https://www.voucherify.io/contact-support) or your Technical Account Manager.
Lists benefit transactions (benefit fulfillments) for the given program member,
with cursor-based pagination. Supports filtering by benefit id and creation date.
## OpenAPI
````yaml /openapi/loyalties-v2.json get /v2/loyalties/programs/{programId}/members/{memberId}/benefits/transactions
openapi: 3.1.0
info:
title: Voucherify Loyalty v2 API
version: 2.0.0
description: >-
Complete OpenAPI specification for the Voucherify Loyalty v2 API.
All endpoints require the LOYALTY_V2 feature flag.
Combined from per-domain specs: programs.yaml, members.yaml,
program-operations.yaml, card-definitions.yaml, earning-rules.yaml,
tier-structures.yaml, benefits.yaml, rewards.yaml, examine.yaml
servers:
- url: '{protocol}://{host}'
variables:
protocol:
default: https
enum:
- https
- http
host:
default: api.voucherify.io
security:
- X-App-Id: []
X-App-Token: []
- bearerAuth: []
tags:
- name: Programs
description: >-
Loyalty program CRUD, lifecycle management, program-scoped resource
assignments (card definitions, earning rules, rewards, tier structures),
member management (create, list, get, activate, deactivate, delete),
membership retrieval (member + program + cards with tier progress, by
customer ID, customer source ID, or member ID), card operations (points
adjustment, pending points, expiring points, transactions), reward
purchases, and activity history.
- name: Card Definitions
description: >-
CRUD operations, lifecycle management, and activity history for card
definitions. Card definitions describe the configuration for loyalty
cards, including code generation, points expiration, earning/spending
limits, pending points, refunds, and balance settings.
- name: Earning Rules
description: >-
Manage earning rules that define how customers earn points or receive
incentives based on triggers (events, segments, custom events). Includes
CRUD, lifecycle, and activity history.
- name: Tier Structures
description: >-
CRUD operations, lifecycle management, and activity history for tier
structures. Includes nested tier definitions (create, list, update,
delete) within tier structures. Tier structures define the tiering model
for loyalty programs — how members qualify for and move between tiers.
- name: Benefits
description: >-
Manage benefit definitions (fixed points, proportional points, material,
digital). Includes CRUD, lifecycle transitions, and activity history.
- name: Rewards
description: >-
CRUD, lifecycle operations, and activity history for reward definitions.
Rewards can be material (product/SKU) or digital (discount coupons, gift
vouchers).
- name: Examine
description: >-
Evaluation endpoints that estimate earning opportunities and reward
availability for a customer across their loyalty program memberships,
without side effects.
paths:
/v2/loyalties/programs/{programId}/members/{memberId}/benefits/transactions:
get:
tags:
- Programs
summary: List member benefit transactions
description: >-
BETA endpoint
This is a work-in-progress documentation of a BETA endpoint. The
parameters, fields, request and response bodies, and other data may be
subject to change. If you want to share feedback or improvements,
contact [Voucherify support](https://www.voucherify.io/contact-support)
or your Technical Account Manager.
Lists benefit transactions (benefit fulfillments) for the given program
member,
with cursor-based pagination. Supports filtering by benefit id and
creation date.
operationId: listMemberBenefitTransactions
parameters:
- name: programId
in: path
required: true
description: >-
Unique loyalty program identifier (format: `lprg_` followed by
hexadecimal characters).
schema:
type: string
- name: memberId
in: path
required: true
description: Program member ID (format `lmbr_[a-f0-9]+`).
schema:
type: string
pattern: ^lmbr_[a-f0-9]+$
- name: limit
in: query
required: false
description: >-
Maximum number of items to return. An integer between 1 and 100;
numeric strings are also accepted. Defaults to 10.
schema:
type:
- integer
- 'null'
minimum: 1
maximum: 100
default: 10
- name: order
in: query
required: false
description: >-
Sort order. A field name, optionally prefixed with `-` for
descending order. May be provided multiple times (array). The same
field cannot be used in both ascending and descending order at once.
Default: `-created_at`.
schema:
oneOf:
- type: array
items:
type: string
enum:
- '-created_at'
- created_at
- type: string
enum:
- '-created_at'
- created_at
- type: 'null'
- name: cursor
in: query
required: false
description: >-
Pagination cursor returned in the `cursor.next` field of a previous
response (format: `lcrsbtx_` followed by hexadecimal characters).
schema:
type:
- string
- 'null'
pattern: ^lcrsbtx_[a-f0-9]+$
- name: filters
in: query
required: false
style: deepObject
explode: true
description: >-
Field filters, e.g. `filters[benefit_id][conditions][$is]=lben_...`.
Each field accepts a `conditions` object with condition operators.
schema:
$ref: '#/components/schemas/BenefitTransactionListFilters'
responses:
'200':
description: Paginated list of benefit transactions.
content:
application/json:
schema:
$ref: '#/components/schemas/BenefitTransactionListResponse'
'400':
description: >-
Validation error - request body or query parameters failed
validation, or the operation is not allowed in the current resource
state.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Resource not found.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'409':
description: Conflict - e.g. duplicate resource or invalid state transition.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
components:
schemas:
BenefitTransactionListFilters:
type: object
description: Filters for listing benefit transactions.
properties:
junction:
description: >-
Logical junction between the field filters. Defaults to AND
behavior.
oneOf:
- type: string
enum:
- AND
- OR
- type: 'null'
benefit_id:
description: Filter by benefit id.
oneOf:
- $ref: '#/components/schemas/BenefitTransactionFilterBenefitIdConditions'
- type: 'null'
created_at:
description: Filter by creation date.
oneOf:
- $ref: '#/components/schemas/OrderPaymentFilterDateConditions'
- type: 'null'
additionalProperties: false
BenefitTransactionListResponse:
type: object
description: Paginated list of benefit transactions.
properties:
data:
type: array
description: Benefit transactions.
items:
$ref: '#/components/schemas/BenefitTransaction'
cursor:
description: Pagination cursor. `null` when there are no more results.
oneOf:
- type: object
properties:
next:
type: string
description: >-
Cursor to pass as the `cursor` query parameter to fetch the
next page (format `lcrsbtx_...`).
expires_at:
type: string
format: date-time
description: Timestamp when the cursor expires.
- type: 'null'
object:
type: string
const: list
description: Object type marker. Always `list`.
ErrorResponse:
type: object
description: Standard error response returned by all Loyalty v2 endpoints.
properties:
code:
type: integer
description: HTTP status code of the error.
key:
type: string
description: Machine-readable error key.
message:
type: string
description: Human-readable error message.
details:
type: string
description: Additional details about the error.
request_id:
type: string
description: Unique identifier of the request that produced the error.
resource_id:
type: string
description: Unique identifier of the resource that produced the error.
resource_type:
type: string
description: Type of the resource that produced the error.
BenefitTransactionFilterBenefitIdConditions:
type: object
description: >-
ID filter conditions for benefit ids. Values must match pattern
`^lben_[a-f0-9]+$`. `$is`/`$is_not` accept a single value (string or
1-element array); `$in`/`$not_in` accept a string or an array of 1-100
values.
properties:
conditions:
type: object
minProperties: 1
additionalProperties: false
properties:
$is:
description: Matches transactions whose benefit id equals the given value.
oneOf:
- type: string
pattern: ^lben_[a-f0-9]+$
- type: array
items:
type: string
pattern: ^lben_[a-f0-9]+$
minItems: 1
maxItems: 1
- type: 'null'
$is_not:
description: >-
Matches transactions whose benefit id does not equal the given
value.
oneOf:
- type: string
pattern: ^lben_[a-f0-9]+$
- type: array
items:
type: string
pattern: ^lben_[a-f0-9]+$
minItems: 1
maxItems: 1
- type: 'null'
$in:
description: >-
Matches transactions whose benefit id is one of the given
values.
oneOf:
- type: string
pattern: ^lben_[a-f0-9]+$
- type: array
items:
type: string
pattern: ^lben_[a-f0-9]+$
minItems: 1
maxItems: 100
- type: 'null'
$not_in:
description: >-
Matches transactions whose benefit id is not one of the given
values.
oneOf:
- type: string
pattern: ^lben_[a-f0-9]+$
- type: array
items:
type: string
pattern: ^lben_[a-f0-9]+$
minItems: 1
maxItems: 100
- type: 'null'
required:
- conditions
additionalProperties: false
OrderPaymentFilterDateConditions:
type: object
description: >-
Date filter conditions. `$before`/`$after` accept an ISO date-time
string. `$is`/`$more_than`/`$less_than` accept a non-negative integer
number of days ago. `$has_value`/`$is_unknown` accept any single value
and match rows where the field is set / not set. Single values may also
be passed as 1-element arrays.
properties:
conditions:
type: object
minProperties: 1
additionalProperties: false
properties:
$before:
description: Matches rows with the date before the given date-time.
oneOf:
- type: string
- type: array
items:
type: string
minItems: 1
maxItems: 1
- type: 'null'
$after:
description: Matches rows with the date after the given date-time.
oneOf:
- type: string
- type: array
items:
type: string
minItems: 1
maxItems: 1
- type: 'null'
$is:
description: Matches rows with the date exactly the given number of days ago.
oneOf:
- type: string
- type: array
items:
type: string
minItems: 1
maxItems: 1
- type: 'null'
$more_than:
description: >-
Matches rows with the date more than the given number of days
ago.
oneOf:
- type: string
- type: array
items:
type: string
minItems: 1
maxItems: 1
- type: 'null'
$less_than:
description: >-
Matches rows with the date less than the given number of days
ago.
oneOf:
- type: string
- type: array
items:
type: string
minItems: 1
maxItems: 1
- type: 'null'
$has_value:
description: Matches rows where the date field is set.
oneOf:
- type: string
- type: array
maxItems: 1
- type: 'null'
$is_unknown:
description: Matches rows where the date field is not set.
oneOf:
- type: string
- type: array
maxItems: 1
- type: 'null'
required:
- conditions
additionalProperties: false
BenefitTransaction:
type: object
description: A benefit transaction. Represents a benefit fulfillment.
properties:
id:
type: string
description: Unique benefit transaction identifier (format `lbtx_...`).
benefit_id:
type: string
description: Unique identifier of the fulfilled benefit (format `lben_...`).
program_id:
type: string
description: Unique identifier of the loyalty program (format `lprg_...`).
member_id:
type: string
description: Unique identifier of the program member (format `lmbr_...`).
earning_rule_id:
type: string
description: >-
Unique identifier of the earning rule that triggered the fulfillment
(format `lern_...`).
type:
type: string
enum:
- FULFILLMENT
description: Transaction type.
details:
description: Transaction details for the `FULFILLMENT` type.
oneOf:
- $ref: '#/components/schemas/BenefitTransactionDetails'
- type: 'null'
status:
type: string
enum:
- PENDING
- APPROVED
- REJECTED
description: >-
Transaction status. `PENDING` — created, awaiting processing;
`APPROVED` — completed successfully; `REJECTED` — rejected (see
`details.rejection`).
created_at:
type: string
format: date-time
description: Timestamp when the transaction was created (ISO 8601).
updated_at:
type:
- string
- 'null'
format: date-time
description: >-
Timestamp when the transaction was last updated (ISO 8601), or
`null`.
object:
type: string
const: benefit_transaction
description: Object type marker. Always `benefit_transaction`.
BenefitTransactionDetails:
type: object
description: Details of a FULFILLMENT benefit transaction.
properties:
reason:
type: string
description: Human-readable reason for the fulfillment.
rejection:
description: Rejection details, present when the transaction was rejected.
oneOf:
- $ref: '#/components/schemas/BenefitTransactionRejection'
- type: 'null'
metadata:
type: object
description: Transaction metadata. Empty object when not set.
additionalProperties: true
result:
description: Fulfillment result payload, or `null` when not yet available.
oneOf:
- type: object
additionalProperties: true
- type: 'null'
BenefitTransactionRejection:
type: object
description: Rejection details.
properties:
reason:
type: string
description: Machine-readable rejection reason.
details:
type: string
description: Additional human-readable details about the rejection.
securitySchemes:
X-App-Id:
type: apiKey
name: X-App-Id
in: header
X-App-Token:
type: apiKey
name: X-App-Token
in: header
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
````