This API is used to issue a reward to the user based on mobile number/ email ID/ external ID
👍
Note
For detailed information about our APIs and for hands-on testing, refer documentation in API overview and step-by-step guide on making your first API call in Make your first API call .
A validation code is used to redeem points for the transaction. skip_validation is set to true as brands configured in Marvel bypass validation code.
Request body parameters
Parameter
Data Type
Description
mobile
String
The mobile phone number associated with the transaction.
Email*
String
The email ID of the customer.
External ID*
String
The external ID of the customer.
brand
String
Brand identifier, possibly indicating the company or product line.
transactionNumber
String
Unique identifier for the transaction.
notes
String
Additional notes or comments related to the transaction.
rewardOwnershipRO
Object
Owner validation for issuance of rewards only when the owner's details are provided.
ownerType
Enum
Module for which the reward was created. Supported values: Loyalty program, Milestones, Campaigns, Journeys, Goodwill.
ownerId
String
Unique identifier of the owner to claim the reward. Ex:12345678
rewards
Array
A list of rewards associated with the transaction.
-rewardId
Integer
The unique identifier of a specific reward.
-quantity
Integer
The quantity of the specific reward issued.
-paymentConfig
Object
Payment configuration details for the reward.
--id
Integer
Unique identifier for the payment configuration.
tender
Object
The tender details contain the customer transaction details. For example, if the customer has opted for a CASH+POINTS payment mode and uses the card to pay for the reward, then the card information is captured here.
totalAmount
Integer
The total amount the customer is required to pay to purchase the reward.
methodOfPayment
Enum
The method the customer uses to pay for the reward.
methodOfPaymentId
String
You can enter the identifier for the payment method.