Adjust Points

Allows points adjustment by adding or deducting points from the member’s loyalty account.
Note:
1) Daily cap for adjustment is configurable as per the role requirements.
2) Point adjustments are recorded as a transaction, where a pre-defined reason code must be selected.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Details needed to adjust points

points

number

required

Number of points to adjust. Can be positive or negative.

billingEntity

string | null

Billing entity for the adjustment transaction

Minimum length: 1

pointType

string | null

Points type. <br /> They are categorized as: <br /> 1) Base points: Earned in any purchase transaction, based on the core rule. <br /> 2) Bonus points: Earned as a bonus for example on a large purchase. <br /> 3) Promotional Points: Earned as part of promotional events. <br /> 4) Restricted Points: Points to be used only on specified stores.

Minimum length: 1

profileId

string

Profile ID of the member. In an ecosystem, it acts as a primary ID to keep the various systems (apps, websites, etc.) in sync.

reasonCode

string | null

Reason code for the point adjustment

Minimum length: 1

setToPending

boolean

default:

false

true: Points in Pending status. <br /> false: Points in Active status. <br />Note:The time period for Pending state is configurable.

Response

200 - application/json

Details of adjusted points

data

object

Adjustment details.

Show child attributes

data.ExceptionString

string

Details of exception, if applicable

data.futureDate

boolean

default:

false

true: Adjustment will happen on a future date <br />false: Adjustment will happen instantly.

data.Message

string

Message corresponding to call. Indicates the points adjusted.

data.transactionCode

string

Transaction ID for points adjustment

errors

object

Error details, if any.

message

string

Message corresponding to the call

status

integer

Status code of call