Adjust a balance
Add or remove balance on a card manually, for example to fix a mistake or grant a goodwill bonus. To register a purchase with the program earning rules, use Register a Purchase instead.
Endpoint
POST/loyalty-transactions
Request
Response
json
Returns the created adjust transaction.
Body parameters
| Name | Type | Required | Description |
|---|---|---|---|
organization_id | Number | Yes | ID of your organization |
member_id | Number | Yes | ID of the card |
amount | Number | Yes | Signed amount: positive adds, negative removes. Cannot be zero. |
description | String | No | Reason shown in the history (up to 500 characters). Defaults to Manual credit or Manual debit |
idempotency_key | String | No | Your unique key for this adjustment (up to 120 characters). Sending the same key again returns the first transaction and does not move the balance twice. |
Behavior
- Points and stamps are whole numbers (decimals are rounded down); cashback and gift card balances keep two decimals.
- A positive adjustment on a points, stamps or membership program with
expiration_daysexpires after that many days, like earned balance. Cashback and gift card balances do not expire. - A debit cannot leave the balance below zero.
Errors
| Message | Cause |
|---|---|
Member not found in this organization | member_id does not belong to organization_id |
Amount must be a non-zero number | amount is 0 or not a number |
Insufficient balance | The debit is larger than the balance |
Nothing to adjust | The amount rounds to zero (e.g. 0.4 points) |
Report an issue with this documentation
Please log in to report issues with our documentation.