Hold

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Places a hold on a coupon for redemption within a merchant's loyalty program. It requires parameters such as a tracking ID, coupon code, cart details, and optionally, whether OTP verification is required. The function builds and updates the redemption cart based on the provided cart items and total amount. It then attempts to place a hold on the coupon redemption, considering whether OTP verification is required. If successful, it returns information about the held coupon, including its title, description, invoice discount amount and type, OTP verification requirement status, and external reference ID. If an error occurs during the hold process, it catches and handles the exception, returning an error message with details of the exception.

Body Params
string
required

Phone Number

string

Store Code

string

Enter Coupon To be Redeemed

int32

Tracking Id

boolean
Defaults to false
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json