Redeem Offer

post

https://platform.nector.io/api/v2/merchant/offerredeems

Redeem an offer using wallet points, i.e. the coinamount of the offer rule is deducted from the wallet and a coupon is generated. Use the offer id from businessoffers of Fetch Aggreegated Offers. Only offers in published status can be redeemed, listed offers are display only. Read only api key is sufficient. Refer to this article for the authentication flow when calling this API from a storefront or client side environment.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

offer_id

string

required

(Required) (This needs to be offers id value) (Use the id from businessoffers items of Fetch Aggreegated Offers)

lead_id

string

(One of leadid, customer_id is required) (This needs to be leads id value)

customer_id

string

(One of lead_id, customer_id is required) (Minimum length is 8) (Maximum length is 128) (This needs to be leads customer_id value)

Headers

x-source

string

enum

required

(Required) (This can only be one of mobile,web) (web for browsers and servers, mobile for native apps)

Allowed:

x-apikey

string

required

(Required) (This needs to be your apikey)

x-workspaceid

string

required

(Required) (This needs to be your workspaceid)

x-leadtoken

string

(Required when using a storefront read only api key, not needed with a server api key) (This needs to be the lead_token of the customer, a 1 hour JWT returned by Get User via the x-leaddigest flow or generated on your server with your api signing secret) (When passed, the customer is taken from the token and any lead_id or customer_id in the request is ignored) (Learn more about authentication here)

Responses

200200

5XXUnexpected error on our side. Retry with backoff and share meta.request_id with [email protected] if it persists