Excel Add-In for Square

Build 26.0.9770

AdjustLoyaltyPoints

Adds points to or subtracts points from a loyalty account.

Stored Procedure Specific Information

Execute

You need to provide the loyalty account ID, an idempotency key, and the adjustment details containing points and reason.

EXECUTE AdjustLoyaltyPoints AccountId = '5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd', AdjustPoints = '{"points":50,"reason":"Customer complaint credit"}', IdempotencyKey = 'b010d167-d440-46e5-8ef5-6b704c9e3a38'

You can adjust points in either direction. For example, to remove points:

EXECUTE AdjustLoyaltyPoints AccountId = '5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd', AdjustPoints = '{"points":-25,"reason":"Duplicate points correction"}', IdempotencyKey = 'b010d167-d440-46e5-8ef5-6b704c9e3a38'

You can optionally allow negative balances when adjusting:

EXECUTE AdjustLoyaltyPoints AccountId = '5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd', AdjustPoints = '{"points":-100,"reason":"Refund"}', IdempotencyKey = 'b010d167-d440-46e5-8ef5-6b704c9e3a38', AllowNegativeBalance = true

Input

Name Type Required Description
AccountId String True The ID of the loyalty account to adjust points for.
AdjustPoints String True The adjustment details containing points and reason.
IdempotencyKey String True A unique string that identifies this AdjustLoyaltyPoints request.
AllowNegativeBalance Boolean False Permits negative account balances when subtracting points (default: false).

Result Set Columns

Name Type Description
Success Boolean Whether the operation was successful.
EventId String The ID of the loyalty event.
LoyaltyProgramId String The ID of the loyalty program.
Points Integer The number of points adjusted.
Reason String The reason for the points adjustment.

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 26.0.9770