Points Transactions
Create, retrieve, and list credits and debits to a loyalty account's points balance.
A points transaction records a credit or debit to a loyalty account's balance. Credits increase the balance (e.g. from a qualifying purchase); debits decrease it (e.g. when redeeming a reward).
Illustrative content. Hand-authored to demonstrate the Standard/Advanced pattern; the production page will be generated from the VINR OpenAPI spec (roadmap item #1). Field names are representative.
The points transaction objectAsk
idstringUnique identifier for the transaction, e.g. pt_7Rm1cW.
loyalty_accountobjectExpandableThe loyalty account whose balance was affected. Expand to retrieve the full object.
amountintegerNumber of points credited or debited. Always positive; direction is indicated by type.
typeenumEither credit (points added) or debit (points removed).
points_afterintegerThe loyalty account's points balance immediately after this transaction.
reasonstringHuman-readable description of why the transaction occurred, e.g. Purchase earn or Reward redemption.
createdintegerUnix timestamp of when the transaction was created.
Create a points transactionAsk
Manually credit or debit a loyalty account. Most credits are created automatically by the engine when an earning rule fires; use this endpoint for manual adjustments or custom integrations.
Retrieve a points transactionAsk
Fetch a single points transaction by its ID.
List points transactionsAsk
Returns a paginated list of points transactions, newest first. Filter by loyalty_account and/or
type to narrow results.
| Parameter | Type | Description |
|---|---|---|
loyalty_account | string | Filter to transactions on a specific loyalty account. |
type | enum | credit or debit. Omit to return both. |
limit | integer | Number of results to return. Default 10, max 100. |
Related eventsAsk
points_transaction.created. See Events.
