Represents an AdjustLoyaltyPoints request.
Adjust Loyalty Points Request
Name | Type | Tags | Description |
---|---|---|---|
idempotency_key |
str |
Required | A unique string that identifies this AdjustLoyaltyPoints request.Keys can be any valid string, but must be unique for every request. Constraints: Minimum Length: 1 , Maximum Length: 128 |
adjust_points |
Loyalty Event Adjust Points |
Required | Provides metadata when the event type is ADJUST_POINTS . |
allow_negative_balance |
bool |
Optional | Indicates whether to allow a negative adjustment to result in a negative balance. If true , a negativebalance is allowed when subtracting points. If false , Square returns a BAD_REQUEST error when subtractingthe specified number of points would result in a negative balance. The default value is false . |
{
"adjust_points": {
"points": 10,
"reason": "Complimentary points",
"loyalty_program_id": "loyalty_program_id2"
},
"idempotency_key": "bc29a517-3dc9-450e-aa76-fae39ee849d1",
"allow_negative_balance": false
}