<- Loyalty API

Loyalty API

Adjust loyalty points

POST

 /v2/loyalty/accounts/{account_id}/adjust

Adds points to or subtracts points from a buyer's account.

Use this endpoint only when you need to manually adjust points. Otherwise, in your application flow, you call AccumulateLoyaltyPoints to add points when a buyer pays for the purchase.

Permissions:LOYALTY_WRITE

Guide

Adjust loyalty points

Try in API Explorer
Link to section

Path parameters

Example code

Link to section

account_id

string

Required

The ID of the target loyalty account.

Link to section

Request body

Link to section

idempotency_key

string

Required

A unique string that identifies this AdjustLoyaltyPoints request. Keys can be any valid string, but must be unique for every request.

Min Length
1
Max Length
128
Link to section

adjust_points

Required

The points to add or subtract and the reason for the adjustment. To add points, specify a positive integer. To subtract points, specify a negative integer.

Show attributes
Link to section

allow_negative_balance

boolean

Indicates whether to allow a negative adjustment to result in a negative balance. If true, a negative balance is allowed when subtracting points. If false, Square returns a BAD_REQUEST error when subtracting the specified number of points would result in a negative balance. The default value is false.

Link to section

Response fields

Link to section

errors

Any errors that occurred during the request.

Show attributes
Link to section

event

The resulting event data for the adjustment.

Show attributes