Schemas

The minimum amount of cashback (in the applicable currency) that a user must accumulate before redemption is allowed. Requests below this threshold are rejected.

The maximum total cashback (in the applicable currency) that a user can earn within the defined period. Any earnings above this cap are not credited.

The member's contact information. This is either an email address or a phone number, based on the member's preferred contact method.

The unique alphanumeric personal code assigned to the member for identification and verification purposes.

The customer's current loyalty points balance. This value reflects the total points available for redemption.

The cash equivalent of the customer's current loyalty points balance, expressed in the program's base currency.

The type of loyalty program the customer is enrolled in. Typical values: 'points', 'cashback', etc.

A unique identifier for the customer, such as a membership or personal code.

The total number of loyalty points or value the customer has earned since joining the program.

The total number of loyalty points or value the customer has redeemed for rewards or benefits.

The total number of loyalty points or value currently reserved for pending transactions and not available for redemption.

The customer's first name.

The customer's last name.

The customer's preferred language (e.g., 'en', 'fr').

The member's date of birth in ISO 8601 format (e.g., 1990-01-01T00:00:00Z).

The member's email address. Must be a valid email format.

The customer's phone number in international format.

Custom referral code to assign. Auto-generated when omitted. Must be unique within the application.

The unique key or identifier for the order item.

The name or description of the order item.

The quantity of the item ordered.

The unit price of the item.

The minimum number of points a user must accumulate before being eligible to redeem rewards.

The cash value (in the relevant currency) that corresponds to the minimum points required for redemption.

The unique personal code identifying the consumer.

The monetary amount associated with the activity. Required and must be greater than 0 for Purchase and Transfer. Must be 0 for Visit and Review.

A 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.

The UTC date and time when the activity occurred. Format: ISO 8601. Cannot be more than 5 minutes in the future.

Optional. 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.

Optional. The redemption code associated with the activity, if applicable.

Optional. The portion of the amount to be redeemed using a reward or voucher, if applicable.

Optional list of purchased items for product-level insights. Maximum 500 items.

Identifier of the cash register or terminal where the purchase was processed.

The unique key or identifier for the item.

The name or description of the item.

The quantity of the item. Must be greater than 0.

The unit price of the item. Must be 0 or greater.

Unique identifier of the visited location, useful for multi-site scenarios.

Display name of the visited location.

Check-in source. Accepted values: QrCode, Nfc, Manual, App.

Rating given in the review, on a scale from 1 to 5.

Platform on which the review was submitted (e.g., 'Google', 'inapp', 'WhatsApp').

Indicates whether the review includes a textual comment. The comment text itself is not stored for GDPR compliance.

ISO 3166-1 alpha-2 code of the origin country (e.g., 'CI', 'SN', 'ML').

ISO 3166-1 alpha-2 code of the destination country.

Recipient's phone number. Must conform to international format (e.g., +2250700000000). Anonymized in public insights.

Mobile Money operator used for the transfer (e.g., 'Orange Money', 'Wave', 'MTN MoMo').

Transfer fees charged to the member. Must be 0 or greater.

ISO 4217 currency code for the transfer fees (e.g., XOF, GHS). Must be exactly 3 uppercase letters.