Record and manage user activities (e.g., purchases, transfers, visits..) for reward automation. Endpoints are rate-limited to 10 requests/sec. See method docs for details.
Record an activity and trigger reward processing.
Use this endpoint to record a customer activity. The operation triggers reward logic and returns a task ID for tracking asynchronous processing.
Record an activity and trigger reward processing. › Request Body
personalCodeThe unique personal code identifying the consumer.
typeamountThe monetary amount associated with the activity. Required and must be greater than 0 for Purchase and Transfer. Must be 0 for Visit and Review.
referenceA unique reference string used to associate this activity with an external system or third-party identifier. Used for deduplication — the same reference is never processed twice.
occurredAtThe UTC date and time when the activity occurred. Format: ISO 8601. Cannot be more than 5 minutes in the future.
descriptionOptional. Provides additional context or details about the activity.
Optional. Structured details specific to the activity type. The expected object shape depends on the type field: use PurchaseDetails when type is Purchase, TransferDetails when type is Transfer, VisitDetails when type is Visit, and ReviewDetails when type is Review. Omit this field if no additional detail is available.
redemptionCodeOptional. The redemption code associated with the activity, if applicable.
redemptionAmountOptional. The portion of the amount to be redeemed using a reward or voucher, if applicable.
Record an activity and trigger reward processing. › Responses
Activity recorded and reward processing enqueued.
taskIdstatus