Public API for partners to manage and retrieve business application reward and redemption settings. Endpoints include retrieval of cashback and point settings, enabling businesses to integrate loyalty program rules. All operations are rate-limited and provide detailed error responses for robust integration.
Retrieves the cashback redemption settings for the current business application.
Use this endpoint to obtain the cashback redemption configuration, including expiration, minimum redemption amount, and earning caps, for the authenticated business application context.
Retrieves the cashback redemption settings for the current business application. › Responses
Returns the cashback settings for the application.
expirationminimumRedemptionAmountThe minimum amount of cashback (in the applicable currency) that a user must accumulate before redemption is allowed. Requests below this threshold are rejected.
earningCapsThe maximum total cashback (in the applicable currency) that a user can earn within the defined period. Any earnings above this cap are not credited.
Retrieves the point redemption settings for the current business application.
Use this endpoint to obtain the point redemption configuration, including expiration, minimum points required for redemption, and the cash value of points, for the authenticated business application context.
Retrieves the point redemption settings for the current business application. › Responses
Returns the point settings for the application.
expirationminimumPointRequiredForRedemptionThe minimum number of points a user must accumulate before being eligible to redeem rewards.
minimumPointRequiredCashValueThe cash value (in the relevant currency) that corresponds to the minimum points required for redemption.