Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Issue single reward

post/api_gateway/rewards/core/v1/user/reward/{reward Id}/issue?username={store}&skip_validation=true

Path parameters

rewardIdstring required

Unique identifier of the reward.

Query parameters

skip_validationstring
usernamestring required

Username here represents name of the store.

Request body

mobile/ email/externalIdstring required

Mobile number/ email Id/ External Id of the customer

brandstring required

name of the brand

transactionNumberstring required

transaction number for issuing the reward

notesstring

custom metadata for the reward

Response

200

{"stackTrail":"paths:/api_gateway/rewards/core/v1/user/reward/{reward Id}/issue?username={store}&skip_validation=true:post:responses:200:content:application/json:schema:properties:intouch","oasType":"schema","type":"unknown"}
transactionIdinteger
{"stackTrail":"paths:/api_gateway/rewards/core/v1/user/reward/{reward Id}/issue?username={store}&skip_validation=true:post:responses:200:content:application/json:schema:properties:promotion","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/api_gateway/rewards/core/v1/user/reward/{reward Id}/issue?username={store}&skip_validation=true:post:responses:200:content:application/json:schema:properties:paymentConfig","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/api_gateway/rewards/core/v1/user/reward/{reward Id}/issue?username={store}&skip_validation=true:post:responses:200:content:application/json:schema:properties:redemptionDetails","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/api_gateway/rewards/core/v1/user/reward/{reward Id}/issue?username={store}&skip_validation=true:post:responses:200:content:application/json:schema:properties:fulfillmentDetails","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/api_gateway/rewards/core/v1/user/reward/{reward Id}/issue?username={store}&skip_validation=true:post:responses:200:content:application/json:schema:properties:customFields","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/api_gateway/rewards/core/v1/user/reward/{reward Id}/issue?username={store}&skip_validation=true:post:responses:200:content:application/json:schema:properties:eventLogId","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/api_gateway/rewards/core/v1/user/reward/{reward Id}/issue?username={store}&skip_validation=true:post:responses:200:content:application/json:schema:properties:requestId","oasType":"schema","type":"unknown"}
eventDateTimestring

Example response

{
  "status": {
    "success": true,
    "code": 200,
    "message": "Reward issued successfully"
  },
  "transactionId": 397137,
  "vendor": {
    "pointsRedeemed": "500"
  },
  "eventDateTime": "2025-03-27T13:38:11Z"
}