Skip to navigation

Add Reward Points

This API endpoint lets a partner (such as Konkrd) add reward points to a member. It is called server to server: it is restricted to the partner’s IP addresses and does not use a user API token.

Sending the same transaction_reference again returns the original transaction and does not add the points twice, so retries are safe.

Request Body

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

  • transaction_reference (string): The partner’s unique reference for this award (max 100 characters).

  • points (integer): The number of points to add (minimum 1).

  • description (string, optional): Shown in the member’s points history, for example “Bupa boost” (max 255 characters).

Response

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

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

  • transaction_type (string): 10 (Partner points).

  • description (string): The description sent in the request.

  • points (integer): The number of points added.

  • transaction_reference (string): The reference sent in the request.

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

If the request is invalid or the user_id does not exist, status is error and message explains why.

Request

This endpoint expects an object.
apistringOptional
dataobjectOptional

Response

Add Reward Points
messagestringOptional
apistringOptional
statusstringOptional
dataobjectOptional