Loyalty cards
Add points
Adds or subtracts points on a points card pass, counted from its current balance.
POST
TapAce adds
add to the pass’s current balance, so two requests at the same time both count. The balance never goes past the template’s limits: below the minimum, or above the goal (or the maximum when there’s no goal). Adding to a balance already at its limit leaves it there. To set an exact balance instead, send points to Update a pass. See Points cards.
string
required
The pass ID. The pass must be an active points card.
string
required
A unique value for this change, so a retry never adds the points twice. See Idempotency.
number
required
How many points to add, with up to 2 decimal places, such as
50 or 12.5. A negative number subtracts points. Between -9999999.99 and 9999999.99, and not 0.string
default:"silent"
silent updates the pass quietly. notify also shows the template’s points message on the holder’s lock screen, or its goal message when this takes the balance to the goal. See When the goal is reached.Response
object | null
A record of the change, as in Update a pass, with
changes.points holding the from and to balances, the change you asked for and the template’s goal. change stays what you sent even when a limit stopped the balance short. It’s null when the balance didn’t move, for example when adding to a balance already at the goal.