Issue Ad Hoc Reward

POST 
/client/users/:correlation_id/adhoc-reward/

This request allows a partner to issue bonus points to a loyalty program member account in real-time.

Request

Body

Attribute	Definition	Format	Notes
channel	The channel for the transaction.	String	For example, "APP" or "POS"
businessUnit	The business unit for the transaction, if applicable.	String	Name of business unit
issuerId	The unique identifier for the issuer of the ad hoc rewards points.	String
rewardId	The unique identifier for the ad hoc reward.	String
rewardAmount	The amount of the reward.	Number	Can be positive or negative integer.
externalReferenceId	Reference ID used by the client to identify the reward.	String

Response

Attribute	Definition	Format	Notes
transactionId	Unique identifier for the ad hoc reward transaction.	String
message	Message describing the purpose of the ad hoc reward.	String

Error Responses

statusCode	errorMessage	errorCode	Definition
400 Bad Request	issuerId is mandatory and required to be non-empty	INVALID_REQUEST	There must be a value included to show the partner or business unit that is issuing the ad hoc rewards.
400 Bad Request	rewardId is mandatory and required to be non-empty	INVALID_REQUEST	A unique reward ID must be included to identify the ad hoc reward transaction.
400 Bad Request	rewardAmount is mandatory and required to be non-empty	INVALID_REQUEST	A reward amount value must be included to show the amount involved in the ad hoc reward transaction.
400 Bad Request	Business Unit is mandatory and required to be non-empty	INVALID_REQUEST	The Business Unit relevant to the ad hoc reward transaction must be included.
400 Bad Request	Business Unit [BUname] is not a valid business unit	INVALID_REQUEST	The Business Unit must be in the list of valid business units supplied by the client and must be literally the same (no changed or additional characters).
400 Bad Request	Reward identifier is invalid	INVALID_REQUEST	The unique reward identifier does not match a valid identifier in the system.
400 Bad Request	Adhoc Reward feature is not enabled	INVALID_REQUEST	The ad hoc reward transaction cannot be processed because the feature is not enabled.
400 Bad Request	Maximum allowed limit for reward amount that can be issued per transaction	INVALID_REQUEST	The reward amount exceeds the maximum allowed limit for an ad hoc rewards transaction.
400 Bad Request	Could not find the account	INVALID_REQUEST	The account identified for this ad hoc reward transaction could not be found.
400 Bad Request	Account is not active	INVALID_REQUEST	The account identified for this ad hoc reward transaction is not active.

Request

Responses

200

200 - Award Ad Hoc Reward Points

400

400 - Issuer Id is Required