Scan a code
Resolve a scanned or typed code: a card code (member_code), a referral code or a reward code issued by a redemption.
Endpoint
POST/loyalty-actions with "action": "scan"
Request
Response
A card
json
member is the full Loyalty Member object (shortened above). rewards lists the active rewards of the card's program, cheapest first. To redeem one, see Redeem a Reward.
A reward code
json
Check redemption.status (issued can be handed over) and expires_at, then mark it used.
Body parameters
| Name | Type | Required | Description |
|---|---|---|---|
organization_id | Number | Yes | ID of your organization |
action | String | Yes | scan |
code | String | Yes | The code. Case, spaces and dashes are ignored. |
If no card or reward code matches, the API returns 404 "No card or reward code matches".
Report an issue with this documentation
Please log in to report issues with our documentation.