Loyalty actions

Cashier and card operations: scan codes, register purchases, check in memberships, top up gift cards and share cards.

Every action is a

POST
to the same endpoint with an action name and the organization ID. These are the operations a point of sale, kiosk or app performs on a card.

Endpoints

MethodPathDescription
POST/loyalty-actionsscan: resolve a card or reward code
POST/loyalty-actionsregister_purchase: register a purchase or visit
POST/loyalty-actionsuse_membership: check in a membership
POST/loyalty-actionsload_balance: top up a gift card
POST/loyalty-actionswallet_links: card page and wallet links
POST/loyalty-actionssend_card: email the card link
POST/loyalty-actionsrefresh_pass and recompute_tiers (see Actions)

organization_id is required in every body and must be the API key's organization. There is no list, get, update or delete.

Actions

ActionParametersDoes
scancodeFinds a card (card code or referral code) or a reward code
register_purchasemember_id, amount, note, referenceRegisters a purchase or visit and awards points, stamps or cashback
use_membershipmember_id, noteUses one check-in of a membership
load_balancemember_id, amount, descriptionTops up a gift card
wallet_linksmember_idReturns the card page and the Apple Wallet / Google Wallet links
send_cardmember_idEmails the card link to the customer
refresh_passmember_idPushes the latest card data to the installed wallet passes. Returns { "refreshed": true }
recompute_tiersprogram_idRe-evaluates the tier of every member of a program. Returns { "updated": <number of members changed> }

Common body parameters

NameTypeRequiredDescription
organization_idNumberYesID of your organization
actionStringYesOne of the actions above
member_idNumberDepends on the actionID of the card (Loyalty Members). It must belong to your organization.

An unknown action returns 400 with "Unknown action. Use one of: scan, register_purchase, use_membership, load_balance, wallet_links, send_card, refresh_pass, recompute_tiers". A member_id of another organization returns 404 "Member not found in this organization".

Response values

The member returned by these actions is the full Loyalty Member object (numbers as numbers). Amounts in transaction and rewards are numbers.

Every balance movement also refreshes the card in Apple Wallet and Google Wallet and fires the Loyalty balance changed automation trigger (and Reward unlocked / Tier changed when that happens).

Report an issue with this documentation

Please log in to report issues with our documentation.