Skip to navigation

Redeem Reward Points

This API endpoint converts a user’s reward points into wallet balance. The amount is the number of points multiplied by the reward point conversion rate (see reward_point_conversion_rate in Get Wallet Balance).

Request Body

  • points (integer): The number of points to convert. Minimum 500.

Response

  • reward_point_transaction_id (string): The ID of the points transaction.

  • user_id (string): The user’s ID.

  • transaction_type (string): 1 (Points redemption).

  • description (string): The amount added to the wallet balance, for example “A$20 to wallet balance”.

  • points (integer): The negative number of points converted, for example -1000.

  • created_at (string): When the points were converted.

  • balance (object): The user’s balances after the conversion: wallet_balance, currecy_symbol, reward_point_balance and gold_coin_balance.

status is error, with a message explaining why, when fewer than 500 points are requested, when the user does not have enough points, or when the conversion would take the wallet balance over $1,000.

Query parameters

api_tokenstringOptional

Response

Redeem Reward Points
messagestringOptional
apistringOptional
statusstringOptional
dataobjectOptional